基於Springboot與注解比較兩個對象對應字段的屬性值

前言：比較兩個對象同一字段的不同值，並對字段進行釋義，對字典值進行轉義，輸出中文修改說明，可用於操作日志的輸出。

一、字典值緩存

1、應用上下文工具類

啟動類中設置應用上下文，從而可以在工具類中注入服務層

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        ApplicationContext applicationContext = SpringApplication.run(DemoApplication.class, args);
        SpringContextUtil.setApplicationContext(applicationContext);
    }

}

應用上下文工具類

public class SpringContextUtil {

    private static ApplicationContext applicationContext;

    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    public static void setApplicationContext(ApplicationContext applicationContext) {
        SpringContextUtil.applicationContext = applicationContext;
    }

    //返回指定bean的實例
    public static Object getBean(String beanId) {
        return applicationContext.getBean(beanId);
    }
}

2、字典值緩存

字典表結構，忽略字典表服務層代碼，緩存於HashMap中。

public class DictMap {

    @Autowired
    private static SysDictService dictService;

    private static HashMap<String, String> hashMap = new HashMap<>();
    //靜態方法在程序啟動的時候只加載一次，這樣為了讓查詢方法只去數據庫查詢一次
    static {
        //獲取應用上下文對象
        ApplicationContext ctx = SpringContextUtil.getApplicationContext();
        //獲取字典服務實例
        dictService = ctx.getBean(SysDictService.class);
        queryDict();
    }
    //從數據庫中取值放入到HashMap中
    public static void queryDict(){
        hashMap.clear();
        List<SysDict> dicts = dictService.findAll();
        for (SysDict dict : dicts) {
            hashMap.put(dict.getCode(),dict.getDictName());
        }
    }

    /**
     * 獲取單個字典值的說明(中文)
     * @param dictType
     * @param dictValue
     * @return
     */
    public static String getDictName(String dictType,String dictValue){
        StringBuilder sb = new StringBuilder();
        StringBuilder keySb = sb.append(dictType).append("_").append(dictValue);
        String key = keySb.toString();
        String value = hashMap.get(key);
        return value;
    }

    /**
     * 獲取多個字典值的說明(中文)
     * @param dictType
     * @param dictValue
     * @return
     */
    public static String getDictNames(String dictType,String dictValue){
        String dictStr = "";
        if (StringUtils.isNotBlank(dictValue)){
            //以"|"為分隔符
            String[] split = dictValue.split("\\|");
            for (int i = 0; i < split.length; i++) {
                if (i == split.length - 1) {
                    dictStr += DictMap.getDictName(dictType, split[i]);
                } else {
                    dictStr += DictMap.getDictName(dictType, split[i]) + "|";
                }
            }
        }
        return dictStr;
    }
    
}

二、注解

字段注解，字段中文名，作用於實體類需要比較的字段。

/**
 * @Description: 需要顯示的實體字段中文名
 */
@Retention(RetentionPolicy.RUNTIME) // 注解會在class字節碼文件中存在，在運行時可以通過反射獲取到
@Target({ElementType.FIELD,ElementType.METHOD})//定義注解的作用目標**作用范圍字段、枚舉的常量/方法
@Documented//說明該注解將被包含在javadoc中
public @interface FieldMeta {
    String name() default "";
    String description() default "";
}

三、實體類的寫法

使用注解標志對應字段中文名，重寫字典字段的get方法，進行字典值轉義。

@Data
public class ContrastClass {

    @FieldMeta(name = "年齡")
    private int age;
    @FieldMeta(name = "姓名")
    private String name;
    @FieldMeta(name = "生日")
    private Date date;

    private String status;

    @FieldMeta(name = "狀態")
    private String statusStr;

    public String getStatusStr() {
        return DictMap.getDictNames("STAFF_STATUS",status);
    }
}

四、對比工具類

通過反射對兩個對象的相關字段進行比較

/**
 * @Description: 比較兩個對象的變化
 */
public class ContrastUtils {

    /**記錄每個修改字段的分隔符*/
    public static final String separator = ";";

    /**
     * 比較兩個對象,並返回不一致的信息
     * @param  oldObj 舊對象
     * @param  newObj 新對象
     * @return
     * @throws ClassNotFoundException
     * @throws IllegalAccessException
     */
    public static String compareTwoObj(Object oldObj,Object newObj ) throws IllegalAccessException, IntrospectionException, InvocationTargetException {

        String str = "";
        //獲取對象的class
        Class<?> oldClass = oldObj.getClass();
        Class<?> newClass = newObj.getClass();
        //獲取對象的屬性列表
        Field[] oldFields = oldClass.getDeclaredFields();
        Field[] newFields = newClass.getDeclaredFields();
        for (int i = 0; i < oldFields.length; i++) {
            if ("serialVersionUID".equals(oldFields[i].getName())) {
                continue;
            }
            oldFields[i].setAccessible(true);
            newFields[i].setAccessible(true);

            // 這樣就獲取到這個注解屬性了
            FieldMeta fieldChinese = oldFields[i].getAnnotation(FieldMeta.class);
            //無對應注解則說明該字段無需比較
            if (fieldChinese == null || StringUtils.isBlank(fieldChinese.name())) {
                continue;
            }
            //獲取注解中字段名
            String fieldName = fieldChinese.name();

            PropertyDescriptor oldPd = new PropertyDescriptor(oldFields[i].getName(), oldClass);
            PropertyDescriptor newPd = new PropertyDescriptor(newFields[i].getName(), newClass);
            Method oldReadMethod = oldPd.getReadMethod();
            Method newReadMethod = newPd.getReadMethod();
            //獲取對應字段的值
            Object oldValue = oldReadMethod.invoke(oldObj);
            Object newValue = newReadMethod.invoke(newObj);

            /**獲取差異字段*/
            str = getDifferenceFieldStr(str, i, fieldName, oldValue, newValue);

        }
        return str;
    }

    /**
     * 獲取差異字段新舊值
     * @param str
     * @param i
     * @param fieldName
     * @param oldValue
     * @param newValue
     * @return
     */
    private static String getDifferenceFieldStr(String str, int i, String fieldName, Object oldValue, Object newValue) {

        if (null == oldValue || StringUtils.isBlank(oldValue.toString())){
            oldValue = "無";
        }
        if (null == newValue || StringUtils.isBlank(newValue.toString())){
            newValue = "無";
        }
        if (!oldValue.equals(newValue)) {
            if (i != 0) {
                str += separator;
            }
            str += "字段名稱:" + fieldName + ",舊值:" + oldValue + ",新值:" + newValue;
        }
        return str;
    }

}

五、測試類

@RestController
@RequestMapping("demo")
public class DictController {

    @GetMapping("/test")
    public ResultVo test() throws IllegalAccessException, InterruptedException, IntrospectionException, InvocationTargetException {

        ContrastClass test1 = new ContrastClass();
        test1.setAge(10);
        test1.setDate(new Date());
        test1.setStatus("1|2");
        Thread.sleep(100);

        ContrastClass test2 = new ContrastClass();
        test2.setAge(20);
        test2.setName("李四");
        test2.setStatus("2|4");
        test2.setDate(new Date());
        String s = ContrastUtils.compareTwoObj(test1, test2);

        return new ResultVo().success(s);
    }

}

六、結果