还在使用BeanUtils.copyProperties()?来看看效率更高的MapStruct吧

最近在做性能优化,发现之前一个后台项目的接口有一些慢,仔细看看发现代码中有拷贝对象的逻辑,而且拷贝对象用到的还是BeanUtils.copyProperties()。在阿里巴巴编码规范插件中也是不支持使用这种方法进行拷贝的,如果有使用这种方法,用编码规约扫描会直接提示“避免用Apache Beanutils进行属性的copy”。同时会说明:“说明:Apache BeanUtils性能较差,可以使用其他方案比如Spring BeanUtils, Cglib BeanCopier”。除了建议的这几种方案外,还有一个更好的方案就是今天要介绍的MapsStruct。

1.定义

什么是MapStruct?

MapStruct 是一个代码生成器,它基于约定优于配置方法,极大地简化了Java bean类型之间映射的实现。生成的映射代码使用简单的方法调用,因此速度快、类型安全且易于理解。

2.实践

2.1工程引入Maven依赖
<dependency>
  <groupId>org.mapstruct</groupId>
  <!-- jdk8以下就使用mapstruct -->
  <artifactId>mapstruct-jdk8</artifactId>
  <version>1.3.0.Final</version>
</dependency>

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.6.2</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <annotationProcessorPaths>
            <path>
             <groupId>org.mapstruct</groupId>
             <artifactId>mapstruct-processor</artifactId>
             <version>1.3.0.Final</version>
            </path>
        </annotationProcessorPaths>
    </configuration>
</plugin>
2.2定义实体类

定义2个实体类,一个是User,一个是UserDTO,目标是把User的值拷贝到UserDTO

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
/**
 * 用户编号,主键
 */
private Long id;
/**
 * 用户名
 */
private String name;
/**
 * 电话
 */
private Long mobile;
/**
 * 年龄
 */
private Integer age;
/**
 * 性别
 */
private Integer sex;
/**
 * 家庭住址
 */
private String address;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserDTO {
/**
 * 用户编号,主键
 */
private Long id;
/**
 * 用户名
 */
private String userName;
/**
 * 电话
 */
private Long mobile;
/**
 * 年龄
 */
private Integer age;
/**
 * 性别
 */
private Integer sex;
/**
 * 家庭住址
 */
private String address;
}

可以看到两个实体的字段名称不完全相同,这种情况下,不能使用BeanUtil.copyProperties()。使用MapStruct就可以处理这种情况,定义一个接口如下:
@Mapper
public interface UserConvert {
UserConvert INSTANCE = Mappers.getMapper(UserConvert.class);

/**
 * 转换
 * @param user
 * @return
 */
@Mappings({
        @Mapping(source = "name", target = "userName"),
})
UserDTO convert(User user);

}
有拷贝对象的业务场景,直接使用如下代码:

   UserDTO userDTO1 = UserConvert.INSTANCE.convert(user);

原理就是通过JSR 269注解处理器在target自动生成接口定义的实现类,具体如下:


image.png

3.性能

对常用的几种方案做下性能上的对比,这样更能看出MapsStruts的效率,具体测试代码如下:

User user =  new User(1L,"小王",15800001111L,25,1,"中国北京朝阳");
long timeTaken;
long time1 = System.currentTimeMillis();
UserDTO userDTO;
for (int i = 0;i<500000;i++){
    userDTO = new UserDTO();
    org.apache.commons.beanutils.BeanUtils.copyProperties(userDTO,user);
}
long time2 = System.currentTimeMillis();
timeTaken =time2-time1;

System.out.println("Apache Commons BeanUtils:"+timeTaken+"(ms)");

long time3 = System.currentTimeMillis();

for (int i = 0;i<500000;i++){
    userDTO = new UserDTO();
    BeanUtils.copyProperties(user,userDTO);
}
long time4 = System.currentTimeMillis();

timeTaken =time4-time3;
System.out.println("Spring BeanUtils:"+timeTaken+"(ms)");

long time5 = System.currentTimeMillis();
for (int i = 0;i<500000;i++){
    UserDTO userDTO1 = UserConvert.INSTANCE.convert(user);
}
long time6 = System.currentTimeMillis();
timeTaken =time6-time5;

System.out.println("MapStruct:"+timeTaken+"(ms)");

long time7 = System.currentTimeMillis();
for (int i = 0;i<500000;i++){
    UserDTO userDTO1 =copyField(user);
}
long time8 = System.currentTimeMillis();
timeTaken =time8-time7;

System.out.println("Getter/Setter:"+timeTaken+"(ms)");

执行结果:

Apache Commons BeanUtils:5767(ms)
Spring BeanUtils:1102(ms)
MapStruct:14(ms)
Getter/Setter:14(ms)

看到上面的结果,可以得出结论Apache Commons BeanUtils确实耗时时间长,效率低,用Spring BeanUtils效率至少可以提高4倍,用MapStruct效率可以提高40倍,甚至可以和自己Getter/Setter的效率不相上下(注:效率倍数只是本次测试的数据,理论上转换的字段越多,循环次数越多,效果越明显)。

4.总结

本文主要讲了MapStruct的使用方法以及与其它拷贝对象方法的性能比较,着重突出MapStruct处理效率。除了上述实践中的简单使用,MapStruct还有许多其它的使用方法,具体内容可以看下它的官网(https://mapstruct.org)。
总的来说MapStruct是一个功能强大的创建映射器的工具库,可以减少开发人员编写一些基本模板代码的工作量,提高编码效率。

参考资料:
1.https://mapstruct.org/

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

推荐阅读更多精彩内容