MapStruct处理Java中实体与模型间不匹配属性转换

超、凢脫俗 2022-06-09 03:52 210阅读 0赞

**摘要：** 前面介绍了[MapStrut简单用法][MapStrut]，MapStrut的最重要的特点就是处理Java中实体与模型间不匹配属性的转换。

## 实体模型 ##

有一个User对象：

public class User { 
        private Integer id;
        private String name;
        private double account;
        private boolean married;
    // setters, getters, toString()
    }

有一个Employee 对象：

public class Employee { 
        private int id;
        private String ename;
        private String position;
        private String married;
    // setters, getters, toString()
    }

## 业务场景 ##

1.  需要User 与Employee 对象之间转换。
2.  User 的name属性对应Employee 的ename属性，其取值相同，类型相同，名称不同
3.  User 的married属性(取值true和false)对应Employee 的married属性(取值Y和N)，其取值不同，类型不同，名称相同。

## 分析与实现 ##

最愚蠢的方式是自己写一堆的setter方法与getter方法，大量get/set代码堆积，增加了代码长度和阅读代码的难度。利用工具BeanUtils是可以处理第一个需求的，但第三种需求就无能为力了。这时MapStrut就派上用场了，最简单的配置可以像下面这样：

@Mapper
    public interface UserMapper { 
        UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);
        Employee userToEmployee(User user);
        User employeeToUser(Employee employee);
    }

对于第二个需求，可以通过下面方式实现，注解`@Mapping`可以指定需要把哪个字段`source`转换为哪个字段`target`。

@Mapper
    public interface UserMapper { 
        UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);
        @Mappings({
            @Mapping(source="name", target="ename")
        })
        Employee userToEmployee(User user);
    
        @Mappings({
            @Mapping(source="ename", target="name")
        })
        User employeeToUser(Employee employee);
    }

第三个需求有点变态，但是真实发生在我们的项目中，实现起来确实繁琐一些：  
首先，自定义转化逻辑，布尔值到字符串，布尔的true对应字符串的Y，布尔的false对应字符串的N：

public class UserTransform { 
    
        public String booleanToString(boolean value){
            if(value){
                return "Y";
            }
            return "N";
        }
    
        public boolean strToBoolean(String str){
            if ("Y".equals(str)) {
                return true;
            }
            return false;
        }
    }

使用很简单，在接口的注解Mapper添加`uses`参数，值就是需要刚才的转换逻辑类。

@Mapper(uses = UserTransform.class)
    public interface UserMapper { ...}

## 结果与分析 ##

用Junit Test写两个测试方法，分别测试User 对象转换Employee ，Employee 对象转换User。

public class MidTest { 
        @Test
        public void midTest(){
            User user = new User();
            user.setId(125);
            user.setName("Lee");
            user.setMarried(true);
    
            Employee e = UserMapper.INSTANCE.userToEmployee(user);
            System.out.println(e);
        }
    
        @Test
        public void midTest2(){
            Employee e = new Employee();
            e.setId(222);
            e.setEname("Chao");
            e.setMarried("N");
    
            User u = UserMapper.INSTANCE.employeeToUser(e);
            System.out.println(u);
        }
    }

结果如下：  
`User [id=222, name=Chao, account=0.0, married=false]`  
`Employee [id=125, ename=Lee, position=null, married=Y]`

> 转换结果符合预期，转化期间不存在的属性，有了默认值(account和position)，包装类也能识别(int和Integer)，从自动生成的`UserMapperImpl.java`中，可以看到，  
> `employee.setMarried( userTransform.booleanToString( user.isMarried() ) );`，用到了刚才自定义的转换逻辑。第三种需求是很少的，但是遇到了也是很难解决的，MapStruct的自定义函数确实方便不少，不过与其他的转换工具相比，上手难度确实大，配置也稍显繁琐。

[项目代码][Link 1]托管在码云。

[MapStrut]: http://blog.csdn.net/jiangchao858/article/details/77512240
[Link 1]: https://git.oschina.net/cj96248/mapstrut