Bean复制工具Orika

一. 背景

在开发过程中,经常涉及到对象之间的拷贝(尤其是微服务架构下,api 层,biz层,Dao层,视图层之间的对象拷贝)。 当前项目中,用的比较多的是Spring 提供的 BeanUtils。

BeanUtils.copyProperties(Object source, Object target)

实现原理比较简单,就是通过Java的Introspector获取到两个类的PropertyDescriptor,对比两个属性具有相同的名字和类型,如果是,则进行赋值(通过ReadMethod获取值,通过WriteMethod赋值),否则忽略。

为了提高性能Spring对BeanInfo和PropertyDescriptor进行了缓存(首次复制比较慢)。
高性能的代价是简洁,同时失去了灵活性和扩展性,功能简单。

二. Orika 简洁

Orika是一个简单、快速的JavaBean拷贝框架,它能够递归地将数据从一个JavaBean复制到另一个JavaBean,这在多层应用开发中非常有用。

<dependency>
   <groupId>ma.glasnost.orika</groupId>
   <artifactId>orika-core</artifactId>
   <version>1.5.4</version>
</dependency>

2.1 效率高

    底层使用Javassist生成字节码,运行效率很高

2.2 功能强大

  不同属性名复制,嵌套对象复制,属性忽略,集合复制等等,也支持自定convert,实现自身复杂转换逻辑。

三. 使用案例

3.1 简单对象-相同属性名拷贝

//构建一个映射工厂
MapperFactory mapperFactory = new DefaultMapperFactory.Builder().build();
//注册映射关系,避免首次复制效率低
mapperFactory.classMap(UserDTO.class,UserInfo.class)
        //byDefault 就是按相同属性名称复制
        .byDefault()

        .register();
// 从映射工厂获取一个工具对象
MapperFacade mapperFacade = mapperFactory.getMapperFacade();    
//使用
UserDTO userDTO=new UserDTO();
userDTO.setName("jack");
UserInfo userInfo=new UserInfo();
//
mapperFacade.map(userDTO,userInfo);

//直接帮我们创建对象
UserInfo userInfo2 = mapperFacade.map(userDTO, UserInfo.class);

3.2 简单对象-不同属性名拷贝

//假设我们需要将userDTO的属性name,复制给UserInfo的属性userName
mapperFactory.classMap(UserDTO.class,UserInfo.class)
        .field("name","userName")
        .byDefault()
        .register();

3.3 内嵌对象拷贝

@Data
public class UserDTO {

    private Long userId;

    private String name;

    private AddressDTO address;
}
@Data
public class UserInfo {

    private Long userId;

    private String name;

    private AddressInfo address;
}
// UserDTO属性address复制,只需要注册AddressDTO和AddressInfo的映射关系即可

mapperFactory.classMap(AddressDTO.class,AddressInfo.class)
        .byDefault()
        .register();

3.4 排除属性复制

mapperFactory.classMap(AddressDTO.class,AddressInfo.class)
        .exclude("userId")
        .byDefault()
        .register();

3.5 集合对象拷贝

// 集合对象的拷贝不需要额外定义映射关系

List<UserInfo> userInfos=mapperFacade.mapAsList(userDTos, UserInfo.class);

3.6 自定义转换关系

@Data
public class UserDTO {

    private Long userId;

    private String name;

    private Integer age;

    private UserProfessionEnum profession;

    private AddressDTO address;

    private Date createTime;
}
@Data
public class UserInfo {

    private Long userId;

    private String name;

    private Integer age;

    private Date createTime;

    private String profession;

    private AddressInfo address;
}

mapperFactory.classMap(UserDTO.class,UserInfo.class)
        .customize(new CustomMapper<UserDTO, UserInfo>() {
            @Override
            public void mapAtoB(UserDTO userDTO, UserInfo userInfo, MappingContext context) {
                super.mapAtoB(userDTO, userInfo, context);
                userInfo.setProfession(userDTO.getProfession().getName());
            }

            @Override
            public void mapBtoA(UserInfo userInfo, UserDTO userDTO, MappingContext context) {
                super.mapBtoA(userInfo, userDTO, context);
                userDTO.setProfession(Arrays.stream(UserProfessionEnum.values()).filter(p->Objects.equals(p.getName(),userInfo.getProfession())).findFirst().orElseGet(null));
            }
        })
        .byDefault()
        .register();

3.7 自定义转换关系-全局

mapperFactory.getConverterFactory().registerConverter(new BidirectionalConverter<UserProfessionEnum,String>() {

    @Override
    public String convertTo(UserProfessionEnum userProfessionEnum, Type<String> type, MappingContext mappingContext) {

        return userProfessionEnum.getName();
    }

    @Override
    public UserProfessionEnum convertFrom(String s, Type<UserProfessionEnum> type, MappingContext mappingContext) {

       return Arrays.stream(UserProfessionEnum.values()).filter(p->Objects.equals(p.getName(),s)).findFirst().orElseGet(null);
    }
});

四. 使用姿势推荐

4.1 定义全局抽象convert

public abstract class AbstractOrikaConvert {

    protected MapperFactory mapperFactory = new DefaultMapperFactory.Builder().build();

    private MapperFacade mapperFacade = null;

    public AbstractOrikaConvert() {

        //注册一些项目级别的转换器,比如和业务无关的日期的转换
        mapperFacade=mapperFactory.getMapperFacade();
    }
    public <V, P> P convert(V base, Class<P> target) {

    if(base==null){
        return null;
    }
    return mapperFacade.map(base, target);
    }

    public <V, P> void convert(V base, P target) {
        mapperFacade.map(base, target);
    }

    public <V, P> List<P> convertList(List<V> baseList, Class<P> target) {
        return baseList == null ? new LinkedList<>() : mapperFacade.mapAsList(baseList, target);
    } 
}

4.2 层与层之间定义convert

// 比如Biz层和视图层之间
@Component
public class BizConvert  extends AbstractOrikaConvert{

    public BizConvert() {
        // 定义一些只存在biz层和视图层对象映射关系的公共转换器
        
       // 定义一系列classMap
    }
}

4.3 转换对象较多的可单独定义convert

// 定义Customer业务域内的转换关系
@Component
public class CustomerBizConvert extends AbstractOrikaConvert{


    public CustomerBizConvert() {
        
        // mapperFactory.classMap()
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容