ModelMapper

在项目中很多时候需要把Model和DTO两个模型类来回转换,保证Model对外是隐私的,同时类似密码之类的属性也能很好地避免暴露在外了.那么ModelMapper就是为了方便转换而实现的一个类库,下面根据使用场景不断增加案例.
1.ModelMapper入口类
ModelMapper这个工具的入口类就是ModelMapper,因此转换就需要从这个类入口.简单看下API
addConverter() :顾名思义,添加转换器
addMappings() :添加映射器
createTypeMap() :创建A-B的转换器关系
getConfiguration() :获取配置
map() ;映射处理
2.简单Model-DTO转换
Paste_Image.png
    /**     * 简单类-类转换     */    @Test    public void testModelToDTO() {        User user = new User();        user.setId(1L);        user.setNickname("张三");        user.setEmail("[e-mail]");        user.setHonor("测试荣誉");        ModelMapper modelMapper = new ModelMapper();        UserDTO userDTO = modelMapper.map(user, UserDTO.class);        System.out.println(userDTO);    }
这里转换替换是根据字段名匹配也就是当User和UserDTO中的字段名称一样就会自动转换.
3.自定义转换
自定义有很多转换,比如Provider,Converter,Condition,PropertyMap等,下面是个综合的例子.
 /**     * 简单类到类自定义字段     */    @Test    public void testModelToDTOByDe(){        User user = new User();        user.setId(1L);        user.setNickname("张三");        user.setEmail("[e-mail]");        user.setHonor("测试荣誉");        ModelMapper modelMapper = new ModelMapper();        //转换内容提供者        Provider<String> personProvider = new AbstractProvider<String>() {            public String get() {                return "自定义提供者";            }        };        //创建自定义转换规则        Converter<String, String> toUppercase = new AbstractConverter<String, String>() {            protected String convert(String source) {                System.out.println(source);                return source == null ? null : source.toUpperCase();            }        };        //创建自定义条件转换        Condition<Long,?> gt2 = context -> {            System.out.println(context.getSource());            return context.getSource() > 2;        };        //创建自定义映射规则        PropertyMap<User,UserDTO> propertyMap = new PropertyMap<User, UserDTO>() {            @Override            protected void configure() {                using(toUppercase).map(source.getNickname(),destination.getHonor());//使用自定义转换规则                with(personProvider).map(source.getHonor(),destination.getNickname());//使用自定义属性提供覆盖                map(source.getAvatar()).setAvatar(null);//主动替换属性                skip(destination.getEmail());                when(gt2).map().setId(1L);//过滤属性            }        };        //添加映射器        modelMapper.addMappings(propertyMap);        modelMapper.validate();        //转换        UserDTO userDTO = modelMapper.map(user,UserDTO.class);        System.out.println(userDTO);    }
对应的输出是:
UserDTO{id='null', email='null', avatar='null', nickname='自定义提供者', honor='张三'}
分析下:
Provider,Converter,Condition三个都算是转换前奏,所有的转换规则都是在PropertyMap里面配置.所以分析这个里面的配置即可.
1.using(toUppercase).map(source.getNickname(),destination.getHonor());//使用自定义转换规则
首先toUppercase是一个Converter,也就是sources的nickname会经过这个转换器,然后才设置到destination的honor中.
2.with(personProvider).map(source.getHonor(),destination.getNickname());//使用自定义属性提供覆盖
personProvider类似一个Bean工厂,当使用这个的时候,对于sources调用getHonor()的时候实际上是调用personProvider的get方法.所以结果nickname='自定义提供者'
3.map(source.getAvatar()).setAvatar(null);//主动替换属性
可以主动重设某些属性
4.skip(destination.getEmail());
过滤指定属性
5.when(gt2).map().setId(1L);//条件过滤属性
条件过滤属性,当满足gt2的时候才会调用setId方法.
4.对于集合的映射
对于集合的映射,因为泛型擦除的存在,所以需要告诉ModelMapper要转换的类型,所以就有了TypeToken这个类.
 @Test    public void testListToListDto() {        User user1 = new User();        user1.setId(1L);        user1.setNickname("张三");        user1.setEmail("[e-mail]");        user1.setHonor("测试荣誉");        User user2 = new User();        user2.setId(1L);        user2.setNickname("李四");        user2.setEmail("[e-mail]");        user2.setHonor("测试荣誉");        List<User> users = new ArrayList<>();        users.add(user1);        users.add(user2);        ModelMapper modelMapper = new ModelMapper();        List<UserDTO> userDTOS = modelMapper.map(users,new TypeToken<List<UserDTO>>() {}.getType());        System.out.println(userDTOS);    }
5.针对集合作为属性的映射
这个是最近做项目遇到的一个问题.
比如PageInfo里面包含了一些分页信息,和一个结果集,其中结果集是集合,我想把左边转换为右边.找了些资料,没发现特别好的办法,现在是额外定义转换器,专门对内部的List进行转换.

Paste_Image.png
ModelMapper modelMapper = new ModelMapper();        modelMapper.getConfiguration().setMatchingStrategy(MatchingStrategies.STANDARD);        //针对内部list的转换        Converter<ArrayList<ArticlePC>,ArrayList<ArticleListDTO>> converter = new AbstractConverter<ArrayList<ArticlePC>, ArrayList<ArticleListDTO>>() {            @Override            protected ArrayList<ArticleListDTO> convert(ArrayList<ArticlePC> source) {                return modelMapper.map(source,new TypeToken<ArrayList<ArticleListDTO>>(){}.getType());            }        };        PropertyMap<PageInfo<ArticlePC>,PageInfo<ArticleListDTO>> propertyMap = new PropertyMap<PageInfo<ArticlePC>, PageInfo<ArticleListDTO>>() {            @Override            protected void configure() {                using(converter).map(source.getList(),destination.getList());            }        };        modelMapper.addMappings(propertyMap);        modelMapper.createTypeMap(ArticlePC.class,ArticleListDTO.class);        return modelMapper.map(articlePCS, new TypeToken<PageInfo<ArticleListDTO>>() {        }.getType());
目前就使用到了这些,用到其他功能再去研究下,官网有不少地方写的不是很明确,导致看的稀里糊涂的,主要是例子太少了,等用的多了再更新.
        
                


作者：蜕变之路
链接：http://www.jianshu.com/p/454ab6abea3f
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。