欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

这四种对象属性拷贝方式,你都知道吗?

程序员文章站 2022-05-10 13:02:55
当`get/set`太繁琐时;当`BeanUtils`无法拷贝集合时;当。。。可能,你需要好好看看这篇文章,文末附完整示例代码。 ......

get/set太繁琐时;当beanutils无法拷贝集合时;当。。。可能,你需要好好看看这篇文章,文末附完整示例代码。

在做业务的时候,为了隔离变化,我们会将dao查询出来的do和对前端提供的dto隔离开来。大概90%的时候,它们的结构都是类似的;但是我们很不喜欢写很多冗长的b.setf1(a.getf1())这样的代码,于是我们需要简化对象拷贝方式。

一、背景

1.1 对象拷贝概念

java中,数据类型分为值类型(基本数据类型)和引用类型,值类型包括intdoublebytebooleanchar等简单数据类型,引用类型包括类、接口、数组等复杂类型。

对象拷贝分为浅拷贝(浅克隆)深拷贝(深克隆)

  • 浅拷贝与深拷贝差异
分类 浅拷贝 深拷贝
区别 创建一个新对象,然后将当前对象的非静态字段复制到该新对象,如果字段是值类型的,那么对该字段执行复制;如果该字段是引用类型的话,则复制引用但不复制引用的对象。因此,原始对象及其副本引用同一个对象。 创建一个新对象,然后将当前对象的非静态字段复制到该新对象,无论该字段是值类型的还是引用类型,都复制独立的一份。当你修改其中一个对象的任何内容时,都不会影响另一个对象的内容。

参考文章:java的深拷贝和浅拷贝

1.2 为什么需要拷贝对象

  1. entity对应的是持久层数据结构(一般是数据库表的映射模型);
  2. model 对应的是业务层的数据结构;
  3. vo 就是controller和客户端交互的数据结构。

例如:数据库查询出来的用户信息(表的映射模型)是userdo,但是我们需要传递给客户端的是uservo,这时候就需要把userdo实例的属性一个一个赋值到uservo实例中。

在这些数据结构之间很大一部分属性都可能会相同,也可能不同。

1.3 有哪些拷贝方式

  1. org.springframework.beans.beanutils
  2. org.springframework.cglib.beans.beancopier
  3. ma.glasnost.orika
  4. org.mapstruct强烈推荐)。

二、beanutils

spring中的beanutils,其中实现的方式很简单,就是对两个对象中相同名字的属性进行简单get/set,仅检查属性的可访问性。

beanutils 源码

可以看到, 成员变量赋值是基于目标对象的成员列表, 并且会跳过ignore的以及在源对象中不存在的, 所以这个方法是安全的, 不会因为两个对象之间的结构差异导致错误, 但是必须保证同名的两个成员变量类型相同。

2.1、单个对象拷贝

我们把数据库查询出来的userdo.java 拷贝到 uservo.java。直接使用beanutils.copyproperties()方法。

@test
public void commoncopy() {
    userdo userdo = new userdo(1l, "van", 18, 1);
    uservo uservo = new uservo();
    beanutils.copyproperties(userdo, uservo);
    log.info("uservo:{}",uservo);
}
  • 拷贝结果:
.... uservo:uservo(userid=1, username=van, age=18, sex=null)

2.2、集合拷贝

刚刚拷贝的是一个对象,但是有时候我们想拷贝一组uerdo.java,是一个集合的时候就不能这样直接赋值了。如果还按照这种逻辑,如下:

@test
public void listcopyfalse() {
    list<userdo> userdolist = new arraylist();
    userdolist.add(new userdo(1l, "van", 18, 1));
    userdolist.add(new userdo(2l, "vanvan", 18, 2));
    list<uservo> uservolist = new arraylist();
    beanutils.copyproperties(userdolist, uservolist);
    log.info("uservolist:{}",uservolist);
}
  • 拷贝结果:
.... uservolist:[]

通过日志可以发现,直接拷贝集合是无效的,那么怎么解决呢?

2.3 暴力拷贝(不推荐)

将需要拷贝的集合遍历,暴力拷贝。

@test
public void listcopycommon() {
    list<userdo> userdolist = new arraylist();
    userdolist.add(new userdo(1l, "van", 18, 1));
    userdolist.add(new userdo(2l, "vanvan", 20, 2));
    list<uservo> uservolist = new arraylist();
    userdolist.foreach(userdo ->{
        uservo uservo = new uservo();
        beanutils.copyproperties(userdo, uservo);
        uservolist.add(uservo);
    });
    log.info("uservolist:{}",uservolist);
}
  • 拷贝结果:
.... uservolist:[uservo(userid=1, username=van, age=18, sex=null), uservo(userid=2, username=vanvan, age=20, sex=null)]

虽然该方式可以解决,但是一点都不优雅,特别是写起来麻烦。

2.4 优雅拷贝(本文推荐

通过jdk 8 的函数式接口封装org.springframework.beans.beanutils

  • 定义一个函数式接口

函数式接口里是可以包含默认方法,这里我们定义默认回调方法。

@functionalinterface
public interface beanutilcopycallback <s, t> {

    /**
     * 定义默认回调方法
     * @param t
     * @param s
     */
    void callback(s t, t s);
}
  • 封装一个工具类 beanutilcopy.java
public class beanutilcopy extends beanutils {

    /**
     * 集合数据的拷贝
     * @param sources: 数据源类
     * @param target: 目标类::new(eg: uservo::new)
     * @return
     */
    public static <s, t> list<t> copylistproperties(list<s> sources, supplier<t> target) {
        return copylistproperties(sources, target, null);
    }


    /**
     * 带回调函数的集合数据的拷贝(可自定义字段拷贝规则)
     * @param sources: 数据源类
     * @param target: 目标类::new(eg: uservo::new)
     * @param callback: 回调函数
     * @return
     */
    public static <s, t> list<t> copylistproperties(list<s> sources, supplier<t> target, beanutilcopycallback<s, t> callback) {
        list<t> list = new arraylist<>(sources.size());
        for (s source : sources) {
            t t = target.get();
            copyproperties(source, t);
            list.add(t);
            if (callback != null) {
                // 回调
                callback.callback(source, t);
            }
        }
        return list;
    }

}
  • 简单拷贝测试
 @test
public void listcopyup() {
    list<userdo> userdolist = new arraylist();
    userdolist.add(new userdo(1l, "van", 18, 1));
    userdolist.add(new userdo(2l, "vanvan", 20, 2));
    list<uservo> uservolist = beanutilcopy.copylistproperties(userdolist, uservo::new);
    log.info("uservolist:{}",uservolist);
}
  • 拷贝结果:
.... uservolist:[uservo(userid=1, username=van, age=18, sex=null), uservo(userid=2, username=vanvan, age=20, sex=null)]

通过如上方法,我们基本实现了集合的拷贝,但是从返回结果我们可以发现:属性不同的字段无法拷贝

注意:
userdo.javauservo.java 最后一个字段sex类型不一样,分别是:integer/string

优化一下

  • 新增性别枚举类
public enum sexenum {
    unknow("未设置",0),
    men("男生", 1),
    woman("女生",2),

    ;
    private string desc;
    private int code;

    sexenum(string desc, int code) {
        this.desc = desc;
        this.code = code;
    }

    public static sexenum getdescbycode(int code) {
        sexenum[] typeenums = values();
        for (sexenum value : typeenums) {
            if (code == value.getcode()) {
                return value;
            }
        }
        return null;
    }

    public string getdesc() {
        return desc;
    }

    public void setdesc(string desc) {
        this.desc = desc;
    }

    public int getcode() {
        return code;
    }

    public void setcode(int code) {
        this.code = code;
    }
}
  • 带特定转换的集合拷贝
@test
public void listcopyupwithcallback() {
    list<userdo> userdolist = new arraylist();
    userdolist.add(new userdo(1l, "van", 18, 1));
    userdolist.add(new userdo(2l, "vanvan", 20, 2));
    list<uservo> uservolist = beanutilcopy.copylistproperties(userdolist, uservo::new, (userdo, uservo) -> {
        // 这里可以定义特定的转换规则
        uservo.setsex(sexenum.getdescbycode(userdo.getsex()).getdesc());
    });
    log.info("uservolist:{}",uservolist);
}
  • 拷贝结果:
... uservolist:[uservo(userid=1, username=van, age=18, sex=男生), uservo(userid=2, username=vanvan, age=20, sex=女生)]

通过打印结果可以发现,userdo.javainteger类型的sex复制到uservo.java成了string类型的男生/女生。

2.5 小结

该方法是我们用的最多的方案,这里简单封装下,可以方便集合类型对象的拷贝,平常使用基本够用,仅供参考。

  1. 该部分测试代码
  2. 完整代码地址

三、beancopier

beancopier是用于在两个bean之间进行属性拷贝的。beancopier支持两种方式:

  1. 一种是不使用converter的方式,仅对两个bean间属性名和类型完全相同的变量进行拷贝;
  2. 另一种则引入converter,可以对某些特定属性值进行特殊操作。

3.1 常规使用

@test
public void normalcopy() {
    // 模拟查询出数据
    userdo userdo = datautil.createdata();
    log.info("拷贝前:userdo:{}", userdo);
    // 第一个参数:源对象, 第二个参数:目标对象,第三个参数:是否使用自定义转换器(下面会介绍),下同
    beancopier b = beancopier.create(userdo.class, userdto.class, false);
    userdto userdto = new userdto();
    b.copy(userdo, userdto, null);
    log.info("拷贝后:userdto:{}", userdto);
}
  • 拷贝结果:
...... 拷贝前:userdo:userdo(id=1, username=van, sex=0, gmtbroth=2019-11-02t18:24:24.077, balance=100)
...... 拷贝后:userdto:userdto(id=1, username=van, sex=null)

通过结果发现:userdoint类型的sex无法拷贝到userdtointegersex

即:beancopier只拷贝名称和类型都相同的属性。

即使源类型是原始类型(int, shortchar等),目标类型是其包装类型(integer, shortcharacter等),或反之:都不会被拷贝。

3.2 自定义转换器

通过3.1可知,当源和目标类的属性类型不同时,不能拷贝该属性,此时我们可以通过实现converter接口来自定义转换器

  • 目标对象属性类
@data
public class userdomain {
    private integer id;
    private string username;
    
    /**
     * 以下两个字段用户模拟自定义转换
     */
    private string gmtbroth;
    private string balance;
}
  • 实现converter接口来自定义属性转换
public  class userdomainconverter implements converter {

    /**
     * 时间转换的格式
     */
    datetimeformatter dtf = datetimeformatter.ofpattern("yyyy-mm-dd hh:mm:ss");

    /**
     * 自定义属性转换
     * @param value 源对象属性类
     * @param target 目标对象里属性对应set方法名,eg.setid
     * @param context 目标对象属性类
     * @return
     */
    @override
    public object convert(object value, class target, object context) {
        if (value instanceof integer) {
            return value;
        } else if (value instanceof localdatetime) {
            localdatetime date = (localdatetime) value;
            return dtf.format(date);
        } else if (value instanceof bigdecimal) {
            bigdecimal bd = (bigdecimal) value;
            return bd.toplainstring();
        }
        // 更多类型转换请自定义
        return value;
    }
}
  • 测试方法
/**
 * 类型不同,使用converter
 */
@test
public void convertertest() {
    // 模拟查询出数据
    userdo userdo = datautil.createdata();
    log.info("拷贝前:userdo:{}", userdo);
    beancopier copier = beancopier.create(userdo.class, userdomain.class, true);
    userdomainconverter converter = new userdomainconverter();
    userdomain userdomain = new userdomain();
    copier.copy(userdo, userdomain, converter);
    log.info("拷贝后:userdomain:{}", userdomain);
}
  • 拷贝结果:
...... 拷贝前:userdo:userdo(id=1, username=van, gmtbroth=2019-11-02t19:51:11.985, balance=100)
...... 拷贝后:userdomain:userdomain(id=1, username=van, gmtbroth=2019-11-02 19:51:11, balance=100)
  • 注意
  1. 一旦使用converterbeancopier只使用converter定义的规则去拷贝属性,所以在convert()方法中要考虑所有的属性;
  2. 毫无疑问,使用converter会使对象拷贝速度变慢。

3.3 缓存beancopier实例提升性能

beancopier拷贝速度快,性能瓶颈出现在创建beancopier实例的过程中。 所以,把创建过的beancopier实例放到缓存中,下次可以直接获取,提升性能。

  • 测试代码
@test
public void beancopierwithcache() {

    list<userdo> userdolist = datautil.createdatalist(10000);
    long start = system.currenttimemillis();
    list<userdto> userdtos = new arraylist<>();
    userdolist.foreach(userdo -> {
        userdto userdto = new userdto();
        copy(userdo, userdto);
        userdtos.add(userdto);
    });
}

/**
 * 缓存 beancopier
 */
private static final concurrenthashmap<string, beancopier> bean_copiers = new concurrenthashmap<>();

public void copy(object srcobj, object destobj) {
    string key = genkey(srcobj.getclass(), destobj.getclass());
    beancopier copier = null;
    if (!bean_copiers.containskey(key)) {
        copier = beancopier.create(srcobj.getclass(), destobj.getclass(), false);
        bean_copiers.put(key, copier);
    } else {
        copier = bean_copiers.get(key);
    }
    copier.copy(srcobj, destobj, null);

}
private string genkey(class<?> srcclazz, class<?> destclazz) {
    return srcclazz.getname() + destclazz.getname();
}

3.3 beancopier总结

  1. 当源类和目标类的属性名称、类型都相同,拷贝没问题。
  2. 当源对象和目标对象的属性名称相同、类型不同,那么名称相同而类型不同的属性不会被拷贝。注意,原始类型(intshortchar)和 他们的包装类型,在这里都被当成了不同类型,因此不会被拷贝。
  3. 源类或目标类的settergetter少,拷贝没问题,此时setter多余,但是不会报错。
  4. 源类和目标类有相同的属性(两者的getter都存在),但是目标类的setter不存在,此时会抛出nullpointerexception
  5. 加缓存可以提升拷贝速度。

3.4 示例代码

  1. 该部分测试代码
  2. 完整代码地址

四、orika

orikajava bean 映射框架,可以实现从一个对象递归拷贝数据至另一个对象。它的优点是:名字相同类型不同也能直接复制。

4.1 所需依赖

<dependency>
    <groupid>ma.glasnost.orika</groupid>
    <artifactid>orika-core</artifactid>
    <version>1.5.4</version>
</dependency>

4.2 映射工具类

使用枚举实现的单例模式创建一个映射工具类,便于测试。

public enum mapperutils {

    /**
     * 实例
     */
    instance;

    /**
     * 默认字段工厂
     */
    private static final mapperfactory mapper_factory = new defaultmapperfactory.builder().build();

    /**
     * 默认字段实例
     */
    private static final mapperfacade mapper_facade = mapper_factory.getmapperfacade();

    /**
     * 默认字段实例集合
     */
    private static map<string, mapperfacade> cache_mapper_facade_map = new concurrenthashmap<>();

    /**
     * 映射实体(默认字段)
     *
     * @param toclass 映射类对象
     * @param data    数据(对象)
     * @return 映射类对象
     */
    public <e, t> e map(class<e> toclass, t data) {
        return mapper_facade.map(data, toclass);
    }

    /**
     * 映射实体(自定义配置)
     *
     * @param toclass   映射类对象
     * @param data      数据(对象)
     * @param configmap 自定义配置
     * @return 映射类对象
     */
    public <e, t> e map(class<e> toclass, t data, map<string, string> configmap) {
        mapperfacade mapperfacade = this.getmapperfacade(toclass, data.getclass(), configmap);
        return mapperfacade.map(data, toclass);
    }

    /**
     * 映射集合(默认字段)
     *
     * @param toclass 映射类对象
     * @param data    数据(集合)
     * @return 映射类对象
     */
    public <e, t> list<e> mapaslist(class<e> toclass, collection<t> data) {
        return mapper_facade.mapaslist(data, toclass);
    }


    /**
     * 映射集合(自定义配置)
     *
     * @param toclass   映射类
     * @param data      数据(集合)
     * @param configmap 自定义配置
     * @return 映射类对象
     */
    public <e, t> list<e> mapaslist(class<e> toclass, collection<t> data, map<string, string> configmap) {
        t t = data.stream().findfirst().orelsethrow(() -> new exceptionininitializererror("映射集合,数据集合为空"));
        mapperfacade mapperfacade = this.getmapperfacade(toclass, t.getclass(), configmap);
        return mapperfacade.mapaslist(data, toclass);
    }

    /**
     * 获取自定义映射
     *
     * @param toclass   映射类
     * @param dataclass 数据映射类
     * @param configmap 自定义配置
     * @return 映射类对象
     */
    private <e, t> mapperfacade getmapperfacade(class<e> toclass, class<t> dataclass, map<string, string> configmap) {
        string mapkey = dataclass.getcanonicalname() + "_" + toclass.getcanonicalname();
        mapperfacade mapperfacade = cache_mapper_facade_map.get(mapkey);
        if (objects.isnull(mapperfacade)) {
            mapperfactory factory = new defaultmapperfactory.builder().build();
            classmapbuilder classmapbuilder = factory.classmap(dataclass, toclass);
            configmap.foreach(classmapbuilder::field);
            classmapbuilder.bydefault().register();
            mapperfacade = factory.getmapperfacade();
            cache_mapper_facade_map.put(mapkey, mapperfacade);
        }
        return mapperfacade;
    }
}
  • 这个工具类中主要有四个方法:
  1. map(class toclass, t data):普通的映射实体,主要映射名称相同(类型可以不同)的字段;

  2. map(class toclass, t data, map<string, string> configmap):自定义配置的映射,映射名称不同时,自定义映射对应名称;

  3. mapaslist(class toclass, collection data):普通的集合的映射;

  4. mapaslist(class toclass, collection data, map<string, string> configmap):自定义的集合映射,自定义映射对应名称。

4.3 简单测试

  • 拷贝名称相同类型可不同的属性
@test
public void normalcopy() {
    // 模拟查询出数据
    userdo userdo = datautil.createdata();
    log.info("拷贝前:userdo:{}", userdo);
    // 第一个参数:源对象, 第二个参数:目标对象,第三个参数:是否使用自定义转换器(下面会介绍),下同
    userdto userdto = mapperutils.instance.map(userdto.class, userdo);;
    log.info("拷贝后:userdto:{}", userdto);
}
  • 字段名称不同,带翻译
@test
public void convertertest() {
    // 模拟查询出数据
    userdo userdo = datautil.createdata();
    map<string, string> config = new hashmap<>();
    // 自定义配置(balance 转 balances)
    config.put("balance", "balances");
    log.info("拷贝前:userdo:{}", userdo);
    userdomain userdomain = mapperutils.instance.map(userdomain.class, userdo, config);
    log.info("拷贝后:userdomain:{}", userdomain);
}
  • 拷贝集合
@test
public void beancopierwithcache() {
    list<userdo> userdolist = datautil.createdatalist(3);
    log.info("拷贝前:userdolist:{}", userdolist);
    list<userdto> userdtos = mapperutils.instance.mapaslist(userdto.class,userdolist);
    log.info("拷贝后:userdtos:{}", userdtos);
}

五、mapstruct

mapstruct 是一个自动生成 bean 映射类的代码生成器mapstruct 还能够在不同的数据类型之间进行转换。

5.1 所需依赖

  • mapstruct-jdk8

包含所需的注释,例如@mapping

<dependency>
    <groupid>org.mapstruct</groupid>
    <artifactid>mapstruct-jdk8</artifactid>
    <version>1.3.0.final</version>
</dependency>
  • mapstruct-processor

在编译,生成映射器实现的注释处理器。

<dependency>
    <groupid>org.mapstruct</groupid>
    <artifactid>mapstruct-processor</artifactid>
    <version>1.3.0.final</version>
    <scope>provided</scope>
</dependency>

5.2 如何使用?

您所要做的就是定义一个mapper接口,该接口声明任何所需的映射方法。在编译期间,mapstruct将生成此接口的实现。此实现使用普通的java方法调用来在源对象和目标对象之间进行映射。

  • 创建mapper

利用@mapper注解标注该接口/抽象类是被mapstruct 自动映射的,只有存在该注解才会将内部的接口方法自动实现。

  • 获取mapper

mapstruct为我们提供了多种的获取mapper的方式,习惯用默认配置:采用mappers通过动态工厂内部反射机制完成mapper实现类的获取。

userconvertutils instance = mappers.getmapper(userconvertutils.class);

完整的一个转换器demo:

@mapper
public interface userconvertutils {

    userconvertutils instance = mappers.getmapper(userconvertutils.class);

    /**
     * 普通的映射
     *
     * @param userdo userdo数据持久层类
     * @return 数据传输类
     */
    userdto dotodto(userdo userdo);

    /**
     * 类型转换的映射
     *
     * @param userdo userdo数据持久层类
     * @return 数据传输类
     */
    @mappings({
            @mapping(target = "gmtbroth", source = "gmtbroth", dateformat = "yyyy-mm-dd hh:mm:ss"),
            @mapping(target = "balances", source = "balance"),
    })
    userdto dotodtowithconvert(userdo userdo);
}
  • 测试
/**
 * 一般拷贝
 */
@test
public void normalcopy() {
    // 模拟查询出数据
    userdo userdo = datautil.createdata();
    log.info("拷贝前:userdo:{}", userdo);
    userdto userdto = userconvertutils.instance.dotodto(userdo);
    log.info("拷贝后:userdto:{}", userdto);
}
/**
 * 包含类型转换的拷贝
 */
@test
public void dotodtowithconvert() {
    // 模拟查询出数据
    userdo userdo = datautil.createdata();
    log.info("拷贝前:userdo:{}", userdo);
    userdto userdto = userconvertutils.instance.dotodtowithconvert(userdo);
    log.info("拷贝后:userdto:{}", userdto);
}
  • 打印映射结果
一般拷贝:
...拷贝前:userdo:userdo(id=1, username=van, gmtbroth=2020-04-21t21:38:39.376, balance=100)
...拷贝后:userdto:userdto(id=1, username=van, gmtbroth=2020-04-21t21:38:39.376, balances=null)
包含类型转换的拷贝:
...拷贝前:userdo:userdo(id=1, username=van, gmtbroth=2020-04-21t21:05:19.282, balance=100)
...拷贝后:userdto:userdto(id=1, username=van, gmtbroth=2020-04-21 21:05:19, balances=100)

通过打印结果可以发现:相较于前者,包含类型转换的拷贝可以自定义转换属性和时间格式等。

5.3 mapstruct 注解的关键词

  1. @mapper:只有在接口加上这个注解, mapstruct 才会去实现该接口;
  2. @mappings:配置多个@mapping
  3. @mapping:属性映射,若源对象属性与目标对象名字一致,会自动映射对应属性:
  1. source:源属性;
  2. target:目标属性;
  3. dateformat:字符串与日期之间相互转换;
  4. ignore: 忽略这个,某个属性不想映射,可以加个 ignore=true

5.4 多对一

mapstruct 可以将几种类型的对象映射为另外一种类型,比如将多个 do 对象转换为 dto

详见:

userdto doandinfotodto(userdo userdo, userinfodo userinfodo);

5.5 为什么要用 mapstruct

与手工编写映射代码相比,mapstruct通过生成繁琐且易于编写的代码来节省时间。遵循约定优于配置方法,mapstruct使用合理的默认值,但在配置或实现特殊行为时会采取措施。

与动态映射框架相比,mapstruct具有以下优势:

  1. 通过使用普通方法调用而不是反射来快速执行
  2. 编译时类型安全:只能映射相互映射的对象和属性,不会将订单实体意外映射到客户dto等。
  3. 在构建时清除错误报告,如果映射不完整(并非所有目标属性都已映射)映射不正确(找不到合适的映射方法或类型转换)

5.6 示例代码

  1. 该部分测试代码
  2. 完整代码地址

六、更多

通过四种属性拷贝的方式,加上自己手动get/set,仅给出以下建议:

  1. 简单拷贝直接使用get/set
  2. 属性值过多的拷贝且已经使用spring的情况下,使用beanutils;
  3. 属性拷贝比较麻烦,存在转译且对拷贝速度有要求时使用mapstruct(性能几乎等同于直接get/set)。

具体性能,参考文章:java bean copy 性能大比拼

该模块完整 github 示例源码

技术交流

  1. github