实体映射最强工具类：MapStruct真香

目录

• 前言

• MapStruct 是用来做什么的

• 记使用 MapStruct 解决上述问题

• 添加默认方法

• 可以使用 abstract class 来代替接口

• 可以使用多个参数

• 直接使用参数作为属性值

• 更新对象属性

• 没有 getter/setter 也能赋值

• 使用 Spring 依赖注入

• 自定义类型转换

前言

首先来了解一下 DTO，DTO 简单的理解就是做数据传输对象的，类似于 VO，但是 VO 用于传输到前端。

MapStruct是用来做什么的

现在有这么个场景，从数据库查询出来了一个 user 对象（包含 id，用户名，密码，手机号，邮箱，角色这些字段）和一个对应的角色对象 role（包含 id，角色名，角色描述这些字段）。

现在在 controller 需要用到 user 对象的 id，用户名，和角色对象的角色名三个属性。

一种方式是直接把两个对象传递到 controller 层，但是这样会多出很多没用的属性。更通用的方式是需要用到的属性封装成一个类（DTO），通过传输这个类的实例来完成数据传输。

User.java：

@AllArgsConstructor
@Data
public class User {
    private Long id;
    private String username;
    private String password;
    private String phoneNum;
    private String email;
    private Role role;
}


Role.java：

@AllArgsConstructor
@Data
public class Role {
    private Long id;
    private String roleName;
    private String description;
}


UserRoleDto.java，这个类就是封装的类：

@Data
public class UserRoleDto {
    /**
     * 用户id
     */
    private Long userId;
    /**
     * 用户名
     */
    private String name;
    /**
     * 角色名
     */
    private String roleName;
}


测试类，模拟将 user 对象转换成 UserRoleDto 对象：

public class MainTest {
    User user = null;
    /**
     * 模拟从数据库中查出user对象
     */
    @Before
    public void before() {
       Role role  = new Role(2L, "administrator", "超级管理员");
       user  = new User(1L, "zhangsan", "12345", "17677778888", "123@qq.com", role);
    }
    /**
     * 模拟把user对象转换成UserRoleDto对象
     */
    @Test
    public void test1() {
        UserRoleDto userRoleDto = new UserRoleDto();
        userRoleDto.setUserId(user.getId());
        userRoleDto.setName(user.getUsername());
        userRoleDto.setRoleName(user.getRole().getRoleName());
        System.out.println(userRoleDto);
    }
}


从上面代码可以看出，通过 getter、setter 的方式把一个对象属性值复制到另一个对象中去还是很麻烦的，尤其是当属性过多的时候。而 MapStruct 就是用于解决这种问题的。

使用 MapStruct 解决上述问题

这里我们沿用 User.java、Role.java、UserRoleDto.java。

新建一个 UserRoleMapper.java，这个来用来定义 User.java、Role.java 和 UserRoleDto.java 之间属性对应规则。

UserRoleMapper.java：

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;
/**
 * @Mapper 定义这是一个MapStruct对象属性转换接口，在这个类里面规定转换规则
 *          在项目构建时，会自动生成改接口的实现类，这个实现类将实现对象属性值复制
 */
@Mapper
public interface UserRoleMapper {
    /**
     * 获取该类自动生成的实现类的实例
     * 接口中的属性都是 public static final 的 方法都是public abstract的
     */
    UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class);
    /**
     * 这个方法就是用于实现对象属性复制的方法
     *
     * @Mapping 用来定义属性复制规则 source 指定源对象属性 target指定目标对象属性
     *
     * @param user 这个参数就是源对象，也就是需要被复制的对象
     * @return 返回的是目标对象，就是最终的结果对象
     */
    @Mappings({
            @Mapping(source = "id", target = "userId"),
            @Mapping(source = "username", target = "name"),
            @Mapping(source = "role.roleName", target = "roleName")
    })
    UserRoleDto toUserRoleDto(User user);
}


在测试类中测试：

public class MainTest {
    User user = null;
    /**
     * 模拟从数据库中查出user对象
     */
    @Before
    public void before() {
       Role role  = new Role(2L, "administrator", "超级管理员");
       user  = new User(1L, "zhangsan", "12345", "17677778888", "123@qq.com", role);
    }
    /**
     * 模拟通过MapStruct把user对象转换成UserRoleDto对象
     */
    @Test
    public void test2() {
        UserRoleDto userRoleDto = UserRoleMapper.INSTANCES.toUserRoleDto(user);
        System.out.println(userRoleDto);
    }
}


通过上面的例子可以看出，使用 MapStruct 方便许多。

添加默认方法

添加默认方法是为了这个类（接口）不只是为了做数据转换用的，也可以做一些其他的事。

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;
/**
 * @Mapper 定义这是一个MapStruct对象属性转换接口，在这个类里面规定转换规则
 *          在项目构建时，会自动生成改接口的实现类，这个实现类将实现对象属性值复制
 */
@Mapper
public interface UserRoleMapper {
    /**
     * 获取该类自动生成的实现类的实例
     * 接口中的属性都是 public static final 的 方法都是public abstract的
     */
    UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class);
    /**
     * 这个方法就是用于实现对象属性复制的方法
     *
     * @Mapping 用来定义属性复制规则 source 指定源对象属性 target指定目标对象属性
     *
     * @param user 这个参数就是源对象，也就是需要被复制的对象
     * @return 返回的是目标对象，就是最终的结果对象
     */
    @Mappings({
            @Mapping(source = "id", target = "userId"),
            @Mapping(source = "username", target = "name"),
            @Mapping(source = "role.roleName", target = "roleName")
    })
    UserRoleDto toUserRoleDto(User user);
    /**
     * 提供默认方法，方法自己定义，这个方法是我随便写的，不是要按照这个格式来的
     * @return
     */
    default UserRoleDto defaultConvert() {
        UserRoleDto userRoleDto = new UserRoleDto();
        userRoleDto.setUserId(0L);
        userRoleDto.setName("None");
        userRoleDto.setRoleName("None");
        return userRoleDto;
    }
}


测试代码：

@Test
public void test3() {
    UserRoleMapper userRoleMapperInstances = UserRoleMapper.INSTANCES;
    UserRoleDto userRoleDto = userRoleMapperInstances.defaultConvert();
    System.out.println(userRoleDto);
}


可以使用 abstract class 来代替接口

mapper 可以用接口来实现，也可以完全由抽象来完全代替：

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;
/**
 * @Mapper 定义这是一个MapStruct对象属性转换接口，在这个类里面规定转换规则
 *          在项目构建时，会自动生成改接口的实现类，这个实现类将实现对象属性值复制
 */
@Mapper
public abstract class UserRoleMapper {
    /**
     * 获取该类自动生成的实现类的实例
     * 接口中的属性都是 public static final 的 方法都是public abstract的
     */
    public static final UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class);
    /**
     * 这个方法就是用于实现对象属性复制的方法
     *
     * @Mapping 用来定义属性复制规则 source 指定源对象属性 target指定目标对象属性
     *
     * @param user 这个参数就是源对象，也就是需要被复制的对象
     * @return 返回的是目标对象，就是最终的结果对象
     */
    @Mappings({
            @Mapping(source = "id", target = "userId"),
            @Mapping(source = "username", target = "name"),
            @Mapping(source = "role.roleName", target = "roleName")
    })
    public abstract UserRoleDto toUserRoleDto(User user);
    /**
     * 提供默认方法，方法自己定义，这个方法是我随便写的，不是要按照这个格式来的
     * @return
     */
    UserRoleDto defaultConvert() {
        UserRoleDto userRoleDto = new UserRoleDto();
        userRoleDto.setUserId(0L);
        userRoleDto.setName("None");
        userRoleDto.setRoleName("None");
        return userRoleDto;
    }
}


可以使用多个参数

可以绑定多个对象的属性值到目标对象中：

package com.mapstruct.demo;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;
/**
 * @Mapper 定义这是一个MapStruct对象属性转换接口，在这个类里面规定转换规则
 *          在项目构建时，会自动生成改接口的实现类，这个实现类将实现对象属性值复制
 */
@Mapper
public interface UserRoleMapper {
    /**
     * 获取该类自动生成的实现类的实例
     * 接口中的属性都是 public static final 的 方法都是public abstract的
     */
    UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class);
    /**
     * 这个方法就是用于实现对象属性复制的方法
     *
     * @Mapping 用来定义属性复制规则 source 指定源对象属性 target指定目标对象属性
     *
     * @param user 这个参数就是源对象，也就是需要被复制的对象
     * @return 返回的是目标对象，就是最终的结果对象
     */
    @Mappings({
            @Mapping(source = "id", target = "userId"),
            @Mapping(source = "username", target = "name"),
            @Mapping(source = "role.roleName", target = "roleName")
    })
    UserRoleDto toUserRoleDto(User user);
    /**
     * 多个参数中的值绑定 
     * @param user 源1
     * @param role 源2
     * @return 从源1、2中提取出的结果
     */
    @Mappings({
            @Mapping(source = "user.id", target = "userId"), // 把user中的id绑定到目标对象的userId属性中
            @Mapping(source = "user.username", target = "name"), // 把user中的username绑定到目标对象的name属性中
            @Mapping(source = "role.roleName", target = "roleName") // 把role对象的roleName属性值绑定到目标对象的roleName中
    })
    UserRoleDto toUserRoleDto(User user, Role role);


对比两个方法~

直接使用参数作为属性值

代码如下：

package com.mapstruct.demo;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;
/**
 * @Mapper 定义这是一个MapStruct对象属性转换接口，在这个类里面规定转换规则
 *          在项目构建时，会自动生成改接口的实现类，这个实现类将实现对象属性值复制
 */
@Mapper
public interface UserRoleMapper {
    /**
     * 获取该类自动生成的实现类的实例
     * 接口中的属性都是 public static final 的 方法都是public abstract的
     */
    UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class);
    /**
     * 直接使用参数作为值
     * @param user
     * @param myRoleName
     * @return
     */
    @Mappings({
            @Mapping(source = "user.id", target = "userId"), // 把user中的id绑定到目标对象的userId属性中
            @Mapping(source = "user.username", target = "name"), // 把user中的username绑定到目标对象的name属性中
            @Mapping(source = "myRoleName", target = "roleName") // 把role对象的roleName属性值绑定到目标对象的roleName中
    })
    UserRoleDto useParameter(User user, String myRoleName);
}


测试类：

public class Test1 {
    Role role = null;
    User user = null;
    @Before
    public void before() {
        role = new Role(2L, "administrator", "超级管理员");
        user = new User(1L, "zhangsan", "12345", "17677778888", "123@qq.com", role);
    }
    @Test
    public void test1() {
        UserRoleMapper instances = UserRoleMapper.INSTANCES;
        UserRoleDto userRoleDto = instances.useParameter(user, "myUserRole");
        System.out.println(userRoleDto);
    }
}


更新对象属性

在之前的例子中 UserRoleDto useParameter（User user，String myRoleName）；都是通过类似上面的方法来生成一个对象。而 MapStruct 提供了另外一种方式来更新一个对象中的属性。

@MappingTarget：

public interface UserRoleMapper1 {
    UserRoleMapper1 INSTANCES = Mappers.getMapper(UserRoleMapper1.class);
    @Mappings({
            @Mapping(source = "userId", target = "id"),
            @Mapping(source = "name", target = "username"),
            @Mapping(source = "roleName", target = "role.roleName")
    })
    void updateDto(UserRoleDto userRoleDto, @MappingTarget User user);
    @Mappings({
            @Mapping(source = "id", target = "userId"),
            @Mapping(source = "username", target = "name"),
            @Mapping(source = "role.roleName", target = "roleName")
    })
    void update(User user, @MappingTarget UserRoleDto userRoleDto);
}


通过 @MappingTarget 来指定目标类是谁（谁的属性需要被更新）。@Mapping 还是用来定义属性对应规则。

以此为例说明：

 @Mappings({
            @Mapping(source = "id", target = "userId"),
            @Mapping(source = "username", target = "name"),
            @Mapping(source = "role.roleName", target = "roleName")
    })
    void update(User user, @MappingTarget UserRoleDto userRoleDto);


@MappingTarget 标注的类 UserRoleDto 为目标类，user 类为源类，调用此方法，会把源类中的属性更新到目标类中。更新规则还是由 @Mapping 指定。

没有 getter/setter 也能赋值

对于没有 getter/setter 的属性也能实现赋值操作：

public class Customer {
    private Long id;
    private String name;
    //getters and setter omitted for brevity
}
public class CustomerDto {
    public Long id;
    public String customerName;
}
@Mapper
public interface CustomerMapper {
    CustomerMapper INSTANCE = Mappers.getMapper( CustomerMapper.class );
    @Mapping(source = "customerName", target = "name")
    Customer toCustomer(CustomerDto customerDto);
    @InheritInverseConfiguration
    CustomerDto fromCustomer(Customer customer);
}


@Mapping(source = “customerName”, target = “name”) 不是用来指定属性映射的，如果两个对象的属性名相同是可以省略 @Mapping 的。

MapStruct 生成的实现类：@InheritInverseConfiguration 在这里的作用就是实现 customerDto.customerName = customer.getName(); 功能的。

如果没有这个注解，toCustomerDto 这个方法则不会有 customerName 和 name 两个属性的对应关系的。

使用 Spring 依赖注入

代码如下：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Customer {
    private Long id;
    private String name;
}
@Data
public class CustomerDto {
    private Long id;
    private String customerName;
}
// 这里主要是这个componentModel 属性，它的值就是当前要使用的依赖注入的环境
@Mapper(componentModel = "spring")
public interface CustomerMapper {
    @Mapping(source = "name", target = "customerName")
    CustomerDto toCustomerDto(Customer customer);
}


@Mapper(compOnentModel= “spring”)，表示把当前 Mapper 类纳入 spring 容器。

可以在其他类中直接注入了：

@SpringBootApplication
@RestController
public class DemoMapstructApplication {
    // 注入Mapper
    @Autowired
    private CustomerMapper mapper;
    public static void main(String[] args) {
        SpringApplication.run(DemoMapstructApplication.class, args);
    }
    @GetMapping("/test")
    public String test() {
        Customer customer = new Customer(1L, "zhangsan");
        CustomerDto customerDto = mapper.toCustomerDto(customer);
        return customerDto.toString();
    }
}


看一下由 mapstruct 自动生成的类文件，会发现标记了 @Component 注解。

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2019-02-14T15:54:17+0800",
    comments = "version: 1.3.0.Final, compiler: javac, environment: Java 1.8.0_181 (Oracle Corporation)"
)
@Component
public class CustomerMapperImpl implements CustomerMapper {
    @Override
    public CustomerDto toCustomerDto(Customer customer) {
        if ( customer == null ) {
            return null;
        }
        CustomerDto customerDto = new CustomerDto();
        customerDto.setCustomerName( customer.getName() );
        customerDto.setId( customer.getId() );
        return customerDto;
    }
}


自定义类型转换

有时候，在对象转换的时候可能会出现这样一个问题，就是源对象中的类型是 Boolean 类型，而目标对象类型是 String 类型，这种情况可以通过 @Mapper 的 uses 属性来实现：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Customer {
    private Long id;
    private String name;
    private Boolean isDisable;
}
@Data
public class CustomerDto {
    private Long id;
    private String customerName;
    private String disable;
}


定义转换规则的类：

public class BooleanStrFormat {
    public String toStr(Boolean isDisable) {
        if (isDisable) {
            return "Y";
        } else {
            return "N";
        }
    }
    public Boolean toBoolean(String str) {
        if (str.equals("Y")) {
            return true;
        } else {
            return false;
        }
    }
}


定义 Mapper，@Mapper( uses = { BooleanStrFormat.class})，注意，这里的 users 属性用于引用之前定义的转换规则的类：

@Mapper( uses = { BooleanStrFormat.class})
public interface CustomerMapper {
    CustomerMapper INSTANCES = Mappers.getMapper(CustomerMapper.class);
    @Mappings({
            @Mapping(source = "name", target = "customerName"),
            @Mapping(source = "isDisable", target = "disable")
    })
    CustomerDto toCustomerDto(Customer customer);
}


这样子，Customer 类中的 isDisable 属性的 true 就会转变成 CustomerDto 中的 disable 属性的 yes。

MapStruct 自动生成的类中的代码：

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2019-02-14T16:49:18+0800",
    comments = "version: 1.3.0.Final, compiler: javac, environment: Java 1.8.0_181 (Oracle Corporation)"
)
public class CustomerMapperImpl implements CustomerMapper {
    // 引用 uses 中指定的类
    private final BooleanStrFormat booleanStrFormat = new BooleanStrFormat();
    @Override
    public CustomerDto toCustomerDto(Customer customer) {
        if ( customer == null ) {
            return null;
        }
        CustomerDto customerDto = new CustomerDto();
        // 转换方式的使用
        customerDto.setDisable( booleanStrFormat.toStr( customer.getIsDisable() ) );
        customerDto.setCustomerName( customer.getName() );
        customerDto.setId( customer.getId() );
        return customerDto;
    }
}


要注意的是，如果使用了例如像 Spring 这样的环境，Mapper 引入 uses 类实例的方式将是自动注入，那么这个类也应该纳入 Spring 容器。

CustomerMapper.java 指定使用 spring：

@Mapper(componentModel = "spring", uses = { BooleanStrFormat.class})
public interface CustomerMapper {
    CustomerMapper INSTANCES = Mappers.getMapper(CustomerMapper.class);
    @Mappings({
            @Mapping(source = "name", target = "customerName"),
            @Mapping(source = "isDisable", target = "disable")
    })
    CustomerDto toCustomerDto(Customer customer);
}


转换类要加入 Spring 容器：

@Component
public class BooleanStrFormat {
    public String toStr(Boolean isDisable) {
        if (isDisable) {
            return "Y";
        } else {
            return "N";
        }
    }
    public Boolean toBoolean(String str) {
        if (str.equals("Y")) {
            return true;
        } else {
            return false;
        }
    }
}


MapStruct 自动生成的类：

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2019-02-14T16:55:35+0800",
    comments = "version: 1.3.0.Final, compiler: javac, environment: Java 1.8.0_181 (Oracle Corporation)"
)
@Component
public class CustomerMapperImpl implements CustomerMapper {
    // 使用自动注入的方式引入
    @Autowired
    private BooleanStrFormat booleanStrFormat;
    @Override
    public CustomerDto toCustomerDto(Customer customer) {
        if ( customer == null ) {
            return null;
        }
        CustomerDto customerDto = new CustomerDto();
        customerDto.setDisable( booleanStrFormat.toStr( customer.getIsDisable() ) );
        customerDto.setCustomerName( customer.getName() );
        customerDto.setId( customer.getId() );
        return customerDto;
    }
}