使用泛型制作CopyUtil封装BeanUtils

>Java有很多的高级特性，泛型是其中之一，泛型即参数化类型。关于泛型的概念，有很多文章都有介绍，这里就不再过多的介绍了。本文将从实战的角度，来看看泛型在实际项目中的使用

1 泛型在框架中的使用

泛型在框架中及为常见，我们在使用各种框架的时候，都会使用到泛型，具体看下面的例子。

1.1 集合框架中使用泛型

这是最常见的泛型的使用场景，比如下面的代码

List list1 = new ArrayList<>();
List list2 = new ArrayList<>();

list1和list2虽然都是列表类型，但是列表里面存的数据可以是String，可以是Integer，也可以是自定义类型。集合中存放的数据，在定义的时候不能确定是什么类型，只有当使用集合时，才能确定放什么类型的数据。所以在集合的定义中，就用泛型来代表集合里面的数据。

1.2 fastjson框架中使用泛型

alibaba的fastjson很多人应该都用过，fastjson很多地方也用到了泛型，比如将json字符串转成对象，如下的例子

// 将userStr字符串映射成UserDto类
String userStr = "{id: '123', name: '张三'}";
UserDto userDto = JSON.parseObject(userStr, UserDto.class);

JSON类中，对parseObject方法的定义，如下

public static  T parseObject(String text, Class clazz) {
    return parseObject(text, clazz);
}

parseObject方法中的参数传递用到了泛型，要把json字符串转成什么类，在定义的时候并不知道，只有在用到的时候，才知道具体的类型。

1.3 泛型使用场景总结

综合集合框架和JSON框架的例子，我们可以大概总结出泛型的使用场景，便于理解：不管是数据存储还是参数传递，定义的时候，类型并不确定，只有到使用的时候，才知道具体的类型。所以我们的项目中，如果有用到这种不确定类型的时候，就可以考虑泛型。

当然，泛型还有更多的使用场景，比如泛型接口，这里就不一一举例了。

2 泛型的实战应用

2.1 数据的存储使用泛型类

在实际项目开发中，有一种场景：前后端分离时，为了方便前后端的对接，一般会统一定义参数的传递格式和结果的返回格式。
以结果返回为例，一般都会定义【返回码】，【返回描述】，【返回数据】等，所以可以定义一个ResponseDto类，如下：

public class ResponseDto {
    /**
     * 返回码
     */
    private String code;

    /**
     * 返回信息
     */
    private String message;

    /**
     * 返回数据，???，应该定义成什么类型呢？
     */
    private ??? content;
	
	// 省略set get
	...
}

【返回码】一般是前后端约好的字符串类型，【返回描述】一般就是字符串类型，【返回数据】就不一定了，如果是查询类的请求，返回的数据就是列表信息，可能还包含分页信息；如果是保存、删除之类的请求，返回的数据可能是一条数据，也可能只是ID，也可能不需要返回数据。所以【返回数据】这个字段就是个不确定的类型，可以定义成泛型。所以我们就可以把ResponseDto类改成下面这样：

public class ResponseDto {
    /**
     * 返回码
     */
    private String code;

    /**
     * 返回信息
     */
    private String message;

    /**
     * 返回数据
     */
    private T content;
}

使用的方法如下：

// 返回单个UserDto对象
ResponseDto responseDto = new ResponseDto<>();
responseDto.setContent(userDto); // userDto是已有的变量

// 返回UserDto列表
ResponseDto> responseDto = new ResponseDto<>();
responseDto.setContent(userDtoList); // userDtoList是已有的变量

// 返回ID
ResponseDto responseDto = new ResponseDto<>();
responseDto.setContent(id); // id是已有的变量

这个类就叫做泛型类。

2.2 参数的传递使用泛型方法

以BeanUtils.copyProperties为例，大家应该对这个方法不陌生，就是将一个实体类中的属性值，拷贝到另一个实体类中。一般我们的使用方法是这样的：

// 功能：将UserDto数据拷贝到User
User user = new User();
BeanUtils.copyProperties(userDto, user); // userDto是已有的变量

但是每次都要写两行代码有点麻烦，要先new一个新的实体类，再往里面拷数据。于是我封装了个通用的工具类

public class CopyUtil {
    /**
     * CopyUtil.copy的定义很类似JSON.parseObject的定义
     */
    public static  T copy(Object source, Class clazz) {
        if (source == null) {
            return null;
        }
        T obj = null;
        try {
            obj = clazz.newInstance(); // 生成一个实例
        } catch (Exception e) {
            e.printStackTrace();
        }
        BeanUtils.copyProperties(source, obj);
        return obj;
    }
}

同样是上面的例子，用工具类的写如下

User user = CopyUtil.copy(userDto, User.class); // userDto是已有的变量

CopyUtil.copy的定义很类似JSON.parseObject的定义。代码变成了一行，当然，减少一行也不足以将其封装成一个工具类。再来看一个场景，列表的拷贝，用BeanUtils.copyProperties的写法如下

// 功能：将List数据拷贝到List
List userList = new ArrayList<>();
// userDtoList是已有的变量
for (int i = 0, l = userDtoList.size(); i < l; i++) {
    UserDto userDto = userDtoList.get(i);
    User user = new User();
    BeanUtils.copyProperties(userDto, user);
    userList.add(user);
}

这样的代码量就比较多了，并且代码写法比较固定。如果项目中用到列表复制的功能比较多，那就有必要对其进行封装了，如下的copyList方法：

import org.springframework.beans.BeanUtils;
import org.springframework.util.CollectionUtils;
import java.util.ArrayList;
import java.util.List;

/**
 * @author 甲蛙
 */
public class CopyUtil {

    /**
     * 列表复制
     */
    public static  List copyList(List source, Class clazz) {
        List target = new ArrayList<>();
        if (!CollectionUtils.isEmpty(source)){
            if (!CollectionUtils.isEmpty(source)){
                for (Object c: source) {
                    T obj = copy(c, clazz);
                    target.add(obj);
                }
            }
        }
        return target;
    }

    /**
     * 单体复制
     */
    public static  T copy(Object source, Class clazz) {
        if (source == null) {
            return null;
        }
        T obj = null;
        try {
            obj = clazz.newInstance();
        } catch (Exception e) {
            e.printStackTrace();
        }
        BeanUtils.copyProperties(source, obj);
        return obj;
    }
}

用法很简单，还是以上面的列表复制为例，代码就变成这样：

// 功能：将List数据拷贝到List
List userList = CopyUtil.copyList(userDtoList, User.class);

封装成CopyUtil工具类后，不管是单体复制还是列表复制，都只需要一行代码，省去了大量的重复代码，从而提高开发效率，这里的copy方法和copyList方法，就是泛型方法，在方法的参数中使用了泛型。

当然这个工具类有个缺点，就是用到了反射，会牺牲一点性能，不过这点性能对于大部分的项目来说可以忽略不计。

除了CopyUtil外，我在《Spring Cloud + Vue 前后端分离
开发企业级在线视频课程系统》这门课中，也制作了很多通用的工具类，通用组件，期待您的加入。

2.3 总结

本文讨论了两种泛型的实战应用，一种是用来存储类型不确定的数据，用到泛型类；一种是用来传递类型不确定的参数，用到了泛型方法。当然，泛型还有更多的用法，比如泛型接口，比较典型的是比较器接口Comparable，这里就不再展开了。

---

配套干货：
《Spring Cloud + Vue 前后端分离 开发企业级在线视频课程系统》：实战项目，前后端分离架构，可用于正式项目。
《开发工具IDEA从入门到爱不释手》：免费课，从基本操作到高级进阶，有效提高开发效率。