Java高效映射工具MapStruct的使用示例

更新时间：2023年12月25日 10:38:30 作者：一只爱撸猫的程序猿

MapStruct 是一个 Java 注解处理器,用于在不同 Java Beans 或数据传输对象（DTOs）之间自动生成类型安全的映射代码,这是一个编译时映射框架,意味着它利用注解在编译时生成代码,本文将给大家介绍一下Java注解处理器MapStruct的使用示例,需要的朋友可以参考下

引言

MapStruct 是一个 Java 注解处理器，用于在不同 Java Beans 或数据传输对象（DTOs）之间自动生成类型安全的映射代码。这是一个编译时映射框架，意味着它利用注解在编译时生成代码，从而提高了性能和减少了运行时的开销。

它适用于 Java 8 和更高版本。以下是一些 MapStruct 的基本使用示例：

1. 基本映射

假设你有两个简单的类 Person 和 PersonDTO，需要将 Person 实体映射到 PersonDTO 数据传输对象。

Person.java

public class Person {
    private String name;
    private int age;
    // getters and setters
}

PersonDTO.java

public class PersonDTO {
    private String name;
    private int age;
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);
    PersonDTO personToPersonDTO(Person person);
}

2. 复杂类型映射

如果你的对象包含复杂类型或自定义类型，MapStruct 也可以处理这些。

Address.java

public class Address {
    private String street;
    private String city;
    // getters and setters
}

Person.java (现在包含 Address)

public class Person {
    private String name;
    private int age;
    private Address address;
    // getters and setters
}

PersonDTO.java (同样包含 Address)

public class PersonDTO {
    private String name;
    private int age;
    private String street;
    private String city;
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);
    
    @Mapping(source = "address.street", target = "street")
    @Mapping(source = "address.city", target = "city")
    PersonDTO personToPersonDTO(Person person);
}

3. 使用表达式

有时，你可能需要在映射过程中使用自定义逻辑。MapStruct 允许你使用 Java 表达式来实现这一点。

Person.java

public class Person {
    private String firstName;
    private String lastName;
    // getters and setters
}

PersonDTO.java

public class PersonDTO {
    private String fullName;
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);

    @Mapping(expression = "java(person.getFirstName() + ' ' + person.getLastName())", target = "fullName")
    PersonDTO personToPersonDTO(Person person);
}

4. 使用自定义方法

在某些情况下，你可能需要自定义映射逻辑。你可以在映射器接口中定义自己的方法来实现这一点。

Person.java

public class Person {
    private String birthdate; // 假设这是一个字符串
    // getters and setters
}

PersonDTO.java

public class PersonDTO {
    private LocalDate birthdate; // 在 DTO 中，我们使用 LocalDate
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);

    @Mapping(target = "birthdate", source = "birthdate", dateFormat = "yyyy-MM-dd")
    PersonDTO personToPersonDTO(Person person);

    default LocalDate stringToLocalDate(String date) {
        return LocalDate.parse(date, DateTimeFormatter.ofPattern("yyyy-MM-dd"));
    }
}

5. 映射集合

MapStruct 也能很好地处理集合映射。

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);

    List<PersonDTO> personsToPersonDTOs(List<Person> persons);
}

6. 使用依赖注入

如果你使用 Spring 或类似框架，可以将 MapStruct 与依赖注入框架结合使用。

PersonMapper.java

@Mapper(componentModel = "spring")
public interface PersonMapper {
    PersonDTO personToPersonDTO(Person person);
}

使用 componentModel = "spring"，MapStruct 将生成一个 Spring 组件，可以被注入到你的服务中。

7. 更新现有对象

MapStruct 也可以用于更新现有对象，而不是创建新的。

PersonMapper.java

@Mapper
public interface PersonMapper {
    void updatePersonFromDTO(PersonDTO personDto, @MappingTarget Person person);
}

这个方法将会根据 PersonDTO 中的数据更新一个已存在的 Person 对象，而不是创建一个新的。

8. 多源映射

你可以从多个源对象映射到一个目标对象。

Address.java

public class Address {
    private String city;
    // getters and setters
}

PersonDTO.java

public class PersonDTO {
    private String name;
    private String city;
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    @Mapping(source = "person.name", target = "name")
    @Mapping(source = "address.city", target = "city")
    PersonDTO personAndAddressToDTO(Person person, Address address);
}

总结

MapStruct 的主要优点是它提供了一种高效、类型安全且易于使用的方式来自动化对象间的数据映射。这使得它成为处理 Java 应用中数据转换的理想选择，尤其是在涉及复杂对象和多层架构的场景中。通过减少手写的样板代码和提供清晰的映射定义，MapStruct 可以帮助开发人员节省时间，减少错误，并提高代码的可维护性。

以上就是Java注解处理器MapStruct的使用示例的详细内容，更多关于Java MapStruct使用的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Maven如何构建可执行的jar包(包含依赖jar包)
这篇文章主要介绍了Maven如何构建可执行的jar包(包含依赖jar包) ，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-11-11
Java中的CopyOnWriteArrayList你了解吗
CopyOnWriteArrayList是Java集合框架中的一种线程安全的List实现，这篇文章主要来和大家聊聊CopyOnWriteArrayList的简单使用，需要的可以参考一下
2023-06-06
J2EE中的struts2表单细节处理
这篇文章主要介绍了J2EE中的struts2表单细节处理的相关资料,需要的朋友可以参考下
2017-06-06
Java Object类equals方法
这篇文章主要介绍了Java Object类equals方法，Object类位于java.lang包中，java.lang包包含着Java最基础和核心的类，在编译时会自动导入，下文更多相关介绍，需要的小伙伴可以参考一下
2022-04-04
为什么Java volatile++不是原子性的详解
这篇文章主要给大家介绍了关于为什么Java volatile++不是原子性的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-02-02
解析ConcurrentHashMap: put方法源码分析
ConcurrentHashMap是由Segment数组结构和HashEntry数组结构组成。Segment的结构和HashMap类似，是一种数组和链表结构，今天给大家普及java面试常见问题---ConcurrentHashMap知识，一起看看吧
2021-06-06
SpringBoot实现websocket服务端及客户端的详细过程
文章介绍了WebSocket通信过程、服务端和客户端的实现,以及可能遇到的问题及解决方案,感兴趣的朋友一起看看吧
2024-12-12
集成Spring Redis缓存的实现
今天小编就为大家分享一篇关于集成Spring Redis缓存的实现，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2018-12-12
MyBatis5中Spring集成MyBatis事物管理
这篇文章主要介绍了MyBatis5中MyBatis集成Spring事物管理的相关资料,需要的朋友可以参考下
2016-05-05
java定位死锁的三种方法（jstack、Arthas和Jvisualvm）
这篇文章主要给大家介绍了关于java定位死锁的三种方法,分别是通过jstack定位死锁信息、通过Arthas工具定位死锁以及通过 Jvisualvm 定位死锁,文中还介绍了死锁的预防方法,需要的朋友可以参考下
2021-09-09