JAVA通過反射獲取實體屬性變更記錄日志信息

　　項目中某些地方要求記錄信息變更日志，通過反射獲取屬性對比新舊信息的變化情況，然后記錄日志

一、創建實體類比較標志注解（只比較有注解的屬性）

import java.lang.annotation.*;

/**
 * @Description //實體類比較標志注解
 * @Author yangli
 **/
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface BeanContrast {

    String fieldDesc() default "undefined";

}

二、創建變更信息實體

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

/**
 * @Description //實體修改信息類 
 **/
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class ModifyInfo {

    @BeanContrast(fidldDesc="修改字段")
    private String modifyField;

    @BeanContrast(fidldDesc="修改前")
    private String beforeModify; 

    @BeanContrast(fidldDesc="修改后")
    private String afterModify; 

}

三、創建工具類

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;

import java.beans.PropertyDescriptor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

/**
 * @Description //實體對象屬性比較工具類
 * @Author yangli
 **/
@Slf4j
public class BeanChangeUtils {

    /**
     * @Description: 比較對象下同一屬性的修改
     * @param oldBean
     * @param newBean
     * @Return: java.util.List<entity.ModifyInfo>
     * @Author: yangli
     **/
    public static List<ModifyInfo> contrastObj(Object oldBean, Object newBean) {
        List<ModifyInfo> modifyInfoList = new ArrayList<>();
        try {
            // 通過反射獲取類的類類型及字段屬性
            Class clazzOld = oldBean.getClass();
            Class clazzNew = newBean.getClass();

            Field[] fields = clazzOld.getDeclaredFields();
            for (Field field : fields) {
                // 檢查屬性上有無 自定義對比 注解 -> 無則直接跳過
                BeanContrast contrastAnnotation = field.getAnnotation(BeanContrast.class);
                if (contrastAnnotation == null) {
                    continue;
                }

                //獲取字段名描述
                String modifyField = contrastAnnotation.fieldDesc();

                PropertyDescriptor pdOld = new PropertyDescriptor(field.getName(), clazzOld);
                PropertyDescriptor pdNew = new PropertyDescriptor(field.getName(), clazzNew);
                // 獲取對應屬性值
                Method getMethodOld = pdOld.getReadMethod();
                Object o1 = getMethodOld.invoke(oldBean);
                Method getMethodNew = pdNew.getReadMethod();
                Object o2 = getMethodNew.invoke(newBean);
                if (o1 == null && o2 == null) {
                    continue;
                }

                if(o1 == null){
                    // o2不為null的情況
                    if(StringUtils.isNotBlank(o2.toString())) {
                        ModifyInfo modifyInfo = ModifyInfo.builder()
                                .modifyField(modifyField)
                                .beforeModify("")
                                .afterModify(o2.toString())
                                .build();
                        modifyInfoList.add(modifyInfo);
                    }
                } else {
                    // O1不為null
                    if(o2 == null ) {
                        // o2為null的情況
                        if (StringUtils.isNotBlank(o1.toString())) {
                            ModifyInfo modifyInfo = ModifyInfo.builder()
                                    .modifyField(modifyField)
                                    .beforeModify(o1.toString())
                                    .afterModify("")
                                    .build();
                            modifyInfoList.add(modifyInfo);
                        }
                    } else {
                        // o2 不為null的情況
                        if ((StringUtils.isNotBlank(o1.toString()) || StringUtils.isNotBlank(o2.toString()))
                                && !o1.toString().equals(o2.toString())) {
                            ModifyInfo modifyInfo = ModifyInfo.builder()
                                    .modifyField(modifyField)
                                    .beforeModify(o1.toString())
                                    .afterModify(o2.toString())
                                    .build();
                            modifyInfoList.add(modifyInfo);
                        }
                    }
                }
            }
        } catch (Exception e) {
            log.error("對比實體變更信息失敗：", e);
            throw new Exception("系統異常");
        }

        return modifyInfoList;
    }

}

四、打完收功~