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;
    }

}

四、打完收功~