【小工具】根據定義的白名單字段進行Bean的拷貝

背景

Bean的拷貝一直有一些類能夠使用，好比Apache的org.apache.commons.beanutils.BeanUtils或者Spring的org.springframework.beans.BeanUtils。

根據定義的白名單字段進行Bean的拷貝

我須要一個只拷貝我指定的字段的Bean拷貝，而Spring的org.springframework.beans.BeanUtils提供以下幾個方法：

其中第二、3個是能夠指定屬性的，第2個指定能夠經過Class指定，基本知足個人需求；第3個指定無須理會的字段。

我不想定義另外的類，或者另外的父類去指定部分屬性，我想經過本身配置的白名單隻拷貝白名單指定的屬性：

package com.nicchagil.exercise.springbootexercise.util;

import java.beans.PropertyDescriptor;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.springframework.beans.BeanUtils;

public class BeanCopyUtils {
    
    /**
     * 根據白名單字段拷貝Bean
     */
    public static <T> T copyProperties(Object source, Class<T> clazz, String[] whiteProperties) {
        List<String> ignorePropertiesList = BeanCopyUtils.getIgnoreProperties(clazz, whiteProperties);
        
        String[] ignoreProperties = new String[ignorePropertiesList.size()];
        ignorePropertiesList.toArray(ignoreProperties);
        
        T target;
        try {
            target = clazz.newInstance();
        } catch (InstantiationException | IllegalAccessException e) {
            throw new RuntimeException("經過Class實例化對象發生異常", e);
        }
        
        BeanUtils.copyProperties(source, target, ignoreProperties);
        return target;
    }
    
    /**
     * 根據白名單字段字段獲取無須理會的字段
     * @param clazz
     * @param whiteProperties
     * @return
     */
    public static List<String> getIgnoreProperties(Class<?> clazz, String[] whiteProperties) {
        List<String> allProperties = BeanCopyUtils.getAllProperties(clazz);
        
        if (allProperties == null || allProperties.size() == 0) {
            return null;
        }
        
        allProperties.removeAll(Arrays.asList(whiteProperties));
        return allProperties;
    }
    
    /**
     * 獲取所有屬性名稱
     */
    public static List<String> getAllProperties(Class<?> clazz) {
        PropertyDescriptor[] propertyDescriptors = BeanUtils.getPropertyDescriptors(clazz);
        
        if (propertyDescriptors == null || propertyDescriptors.length == 0) {
            return null;
        }
        
        List<String> properties = new ArrayList<String>();
        for (PropertyDescriptor propertyDescriptor : propertyDescriptors) {
            properties.add(propertyDescriptor.getName());
        }
        
        return properties;
    }

}

單元測試：

package com.nicchagil.exercise.springbootexercise;

import org.junit.Test;

import com.nicchagil.exercise.springbootexercise.util.BeanCopyUtils;

public class BeanCopyUtilsTest {
    
    @Test
    public void test() {
        User user = new User();
        user.setId(123);
        user.setName("Nick Huang");
        
        User userCopy = BeanCopyUtils.copyProperties(user, User.class, new String[] {"name"});
        System.out.println("user : " + user);
        System.out.println("userCopy : " + userCopy);
    }
    
    public static class User {
        private Integer id;
        private String name;
        public Integer getId() {
            return id;
        }
        public void setId(Integer id) {
            this.id = id;
        }
        public String getName() {
            return name;
        }
        public void setName(String name) {
            this.name = name;
        }
        @Override
        public String toString() {
            return "User [id=" + id + ", name=" + name + "]";
        }
    }

}