SpringBoot 项目中 Bean 拷贝及工具类封装

在我们SpringBoot 项目的开发中，经常需要做对象的拷贝和转化，例如我们需要把前端传给我们的DTO对象转化为POJO对象存到数据库，返回前端数据时需要把POJO对象转换为VO，这篇文章就讲讲SpringBoot中对象的拷贝及其工具类的封装。

一、使用Spring BeanUtils

在Spring或SpringBoot项目中有为我们提供一个BeanUtils工具类。

使用方法如下，第一个参数是源对象，第二个参数是目标对象：

BeanUtils.copyProperties(Object source, Object target);

还可以继续传入参数进行忽略参数拷贝：

BeanUtils.copyProperties(Object source, Object target, String... ignoreProperties);

使用示例：

这里我们创建一个UserDto，User实体类，来实现前端传入Dto对象转为实体类对象

domain.entity.User：

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String username;
    private Integer age;
    private Date createTime;
    private Date updateTime;
    private Integer deleted;
}

domain.dto.AddUserDto：

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class AddUserDto {
    private String username;
    private Integer age;
}

实现Bean拷贝：

public ResponseResult addUser(AddUserDto addUserDto) {
    // 先新建一个user对象
    User user = new User();
    // 实现把addUserDto拷贝到user对象
    BeanUtils.copyProperties(addUserDto, user);

    userMapper.insert(user);
    return ResponseResult.okResult();
}

二、Bean 拷贝工具类封装

因为基础的BeanUtils在使用时拷贝非常不方便，还需要我们自己去创建新的User拷贝，对List集合的拷贝还需要我们自己去遍历，这里我们封装工具类来实现这些功能

import org.springframework.beans.BeanUtils;

import java.util.List;
import java.util.stream.Collectors;

public class BeanCopyUtils {
    private BeanCopyUtils() {
    }

    public static  V copyBean(Object source, Class clazz) {
        // 创建目标对象
        V result = null;
        try {
            result = clazz.newInstance();
            // 实现属性拷贝
            BeanUtils.copyProperties(source, result);
        } catch (Exception e) {
            e.printStackTrace();
        }
        //返回
        return result;
    }

    public static  List copyBeanList(List list, Class clazz) {
        return list.stream()
                .map(o -> copyBean(o, clazz))
                .collect(Collectors.toList());
    }
}

使用示例

1. 普通Bean对象拷贝

public ResponseResult addUser(AddUserDto addUserDto) {
    User user = BeanCopyUtils.copyBean(addUserDto, User.class);

    userMapper.insert(user);
    return ResponseResult.okResult();
}

1. List拷贝

public ResponseResult getUser(Integer pageNum, Integer pageSize) {
    Page userPage = new Page<>(pageNum, pageSize);
    userMapper.selectPage(userPage, null);

    List userVos = BeanCopyUtils.copyBeanList(userPage.getRecords(), UserVo.class);
    PageVo pageVo = new PageVo(userVos, userPage.getTotal());
    return ResponseResult.okResult(pageVo);
}

项目中Bean拷贝一般就是直接使用我们的工具类，也有一些开源的工具类,hutool等，原理也一样。