java后端比较同类的两个对象的字段差异的项目内的三种实现的比较

---

前言

项目内有个需求，对导入的数据行，通过流程将数据下发到具体的业务人员端，由业务人员进行核对，然后由移动端APP，将核对后的前后差异的数据挂载到流程中去。需要提交的信息格式为“[{“fieldDesc”:“姓名”,“newValue”:“李四”,“fieldName”:“cnName”,“oldValue”:“张三”}]”，将每个不同的字段信息对比信息，包装到数组中统一挂载到流程中。本例介绍了项目内对象对比的三种实现方式，并对比了其中的实现差异，流程的相关操作不在本例介绍范围内。

---

一、示例1-OriginalUtils （不推荐）

本示例为初始状态的实现，在不引用第三方依赖的情况，基本实现了对象变更内容的比对，相比引用第三方工具包性能较好。在测试的过程中，暴露了一个日期数据未进行格式化的问题，可以针对日期类型，单独处理一下。本例中并未处理该问题，在项目中该示例已经被下面的第三方式直接替换了。

• 使用java本身的API实现字段的读取和值的比对
• 未对日期类型进行格式化处理

基于以上内容，第三方依赖的角度出发，在处理了日期类型格式化问题后，可以使用此示例中的实现。但是如果考虑更好的执行性能，不推荐该实现方式。代码如下（示例）：

package com.nbcio.modules.flowable.utils;

import com.baomidou.mybatisplus.annotation.TableField;
import io.swagger.annotations.ApiModelProperty;

import java.lang.reflect.Field;
import java.util.*;

public class OriginalUtils {
   

    /**
     * 获取对象的更新字段集合
     * @param oldObj 旧对象
     * @param newObj 新对象
     * @param excludeTableFieldExistFalse 是否要去除带有注解 @TableField(exist = false) 的属性。
     * @return
     * @param <T>
     */
     public static <T> List<Map<String, Object>> compareChangeFields(T oldObj, T newObj,Boolean excludeTableFieldExistFalse)throws Exception {
   
        List<Map<String, Object>> result = new ArrayList<>();
        Field[] fields = oldObj.getClass().getDeclaredFields();

        for (Field field : fields) {
   
            // 设置可以访问私有字段
            field.setAccessible(true);
            if(checkExcludeFields(field,excludeTableFieldExistFalse)){
   
                continue;
            }
            // 判断字段值是否被更新
            if (field.get(newObj) != null && !field.get(newObj).equals(field.get(oldObj))) {
   
                System.out.println("字段：[ " + field.getName() + "]的值已更新，旧值【"+field.get(oldObj)+"】，新值【"+field.get(newObj)+"】");
                ApiModelProperty anno = field.getAnnotation(ApiModelProperty.class);

                Map<String, Object> map = new HashMap<>();
                map.put("fieldName",field.getName());
                map.put("fieldDesc",anno.value());
                map.put("oldValue",field.get(oldObj));
                map.put("newValue",field.get(newObj));

                result.add(map);
            }
        }

        return result;
    }

    /**
     * 要排除的属性
     */
    private static List<String> excludeFields = Arrays.asList("id","createBy","createTime","updateBy","updateTime");

    /**
     * 检查需要排除的属性
     * @param field
     * @param excludeTableFieldExistFalse 是否要去除带有注解 @TableField(exist = false) 的属性。
     * @return
     * @param <T>
     */
    private static <T> Boolean checkExcludeFields(Field field,Boolean excludeTableFieldExistFalse){
   
         if (field != null){
   
             String fieldName = field.getName();
             if (excludeFields.contains(fieldName)){
   
                 return true;
             }
             if(excludeTableFieldExistFalse){
   
                 TableField tableField = field.getAnnotation(TableField.class);
                 if (tableField != null && !tableField.exist()){
   
                     return true;
                 }
             }
         }
         return false;
    }

//    static void main(String[] args) {
   
//        WorkKeyPersonEntryCheck w1 = new WorkKeyPersonEntryCheck();
//        w1.setCnName("张三");
//        WorkKeyPersonEntryCheck w2 = new WorkKeyPersonEntryCheck();
//        w2.setCnName("李四");
//        w2.setId("234");
//        w2.setExts(new ArrayList<>());
//        w2.setPhone("18888");
//        System.out.println(compareChangeFields(w1,w2,false));
//    }
}

---

二、示例2-ExtendBeanComparer（不推荐）

本示例中使用了hutool工具包中的BeanUtil的api，将对象转换为Map键值对，然后通过一定规则，将键值对转换为Set集合；使用guava的Sets工具的api，求取两个对比对象转换后的Set集合的差集；基于差集，循环构建对比对象新旧的不同值并作为结果集返回。

• 一下实现方式基于通用的工具类，利用集合的交、并、差等操作，可以方便的获取到不同的值。
• 通用工具包多次对对象进行解析，对象转Map，获取对象的字段信息，字段构建Set集合，Set内容的再拆分。

基于以上问题，从执行性能、第三方依赖的角度出发，不建议使用此示例中的实现。代码如下（示例）：

package com.nbcio.modules.flowable.jgpt.comparer;

import cn.hutool.core.bean.BeanUtil;
import com.alibaba.druid.support.json.JSONUtils;
import com.google.common.collect.Sets;
import com.nbcio.modules.flowable.jgpt.entity.WorkKeyPersonEntryCheck;
import com.nbcio.modules.flowable.utils.JgUtils;
import io.swagger.annotations.ApiModelProperty;
import lombok.extern.slf4j.Slf4j;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.StopWatch;

import java.lang.reflect.Field;
import java.text.SimpleDateFormat;
import java.util.*;
import java.util.stream.Collectors;

import static java.util.stream.Collectors.toSet;

/**
 * <h2>使用第三方工具实现的对象比较器</h2>
 *
 * @Description
 * @Author misterbig
 * @Date 2024/2/2
 */
@Slf4j
public class ExtendBeanComparer {
   

    /**
     * 对象字段和值之间的链接符号
     * {@value}
     */
    public static final String FIELD_LINK_VALUE = "#";

    /**
     * 排除基础字段
     * {@value}
     */
    private static final List<String> EXCLUDE_FIELDS = Arrays.asList("id", "createBy", "createTime", "updateBy",
            "updateTime");

    /**
     * <h3>两个对象信息是否相等</h3>
     * <b>所有字段和值参与完全比对</b>
     *
     * @param o1
     * @param o2
     * @param <T>
     * @return
     */
    public static