AOP 记录日志

最新推荐文章于 2025-08-04 17:40:03 发布

原创最新推荐文章于 2025-08-04 17:40:03 发布 · 142 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring #AOP

经验谈专栏收录该内容

35 篇文章

订阅专栏

该博客展示了如何使用Spring AOP进行日志记录，特别是在更新审核流程时。通过自定义注解`@FieldInterface`来标识字段，并在后置通知中遍历对象字段，获取并打印注解值，实现变更详情的记录。此外，还涉及到不同类型的DTO转换为DO的过程，用于日志入库。

package com.ipr.audit.aop;

import java.lang.annotation.*;


/**
 * @author xnALPHA
 */
@Documented
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)

public @interface FieldInterface {



    String name() default "";

}

public class ProcessFormDTO implements Serializable{

    private static final long serialVersionUID = -8689138748150278713L;

    private Long id;
    /**
     * 申请流程名称
     */
    @FieldInterface(name = "申请流程名称")
    private String processName;

    /**
     * 申请流程说明
     */
    @FieldInterface(name = "申请流程说明")
    private String description;

    /**
     * 申请流程名称
     */
    @FieldInterface(name = "申请流程名称")
    private Long categoryId;

    /**
     * 审核类型名字
     */
    @FieldInterface(name = "审核类型名字")
    private String categoryName;

    /**
     * 审核流程说明(0 普通 1交互)
     */
    @FieldInterface(name = "审核流程说明")
    private Byte processType;

    /**
     * 创建人id
     */
    @FieldInterface(name = "创建人id")
    private Long createManager;

    /**
     * 创建人名称
     */
    @FieldInterface(name = "创建人名称")
    private String createManagerName;

    /**
     * 归属人id
     */
    @FieldInterface(name = "归属人id")
    private Long ownerManager;

    /**
     * 归属人名称
     */
    @FieldInterface(name = "归属人名称")
    private String ownerManagerName;

    /**
     * 归属人组织id
     */
    @FieldInterface(name = "归属人组织id")
    private Long ownerGroup;

    /**
     * 归属人组织名称
     */
    @FieldInterface(name = "归属人组织名称")
    private String ownerGroupName;
}

package com.ipr.audit.aop;

import com.alibaba.fastjson.JSON;
import com.ipr.audit.dto.process.ProcessFormDTO;
import com.ipr.dataobject.AuditProcessDO;
import com.ipr.mapper.IAuditProcessMapper;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Arrays;

/**
 * 审核流程日志记录
 *
 * @author xnALPHA
 */
@Aspect
@Component
public class AuditLog {

    private Logger logger = LoggerFactory.getLogger(AuditLog.class);

    @Resource
    private IAuditProcessMapper auditProcessMapperSlave;

    /**
     * 日志记录切入点
     */
    @Pointcut("execution(* com.ipr.biz.impl.ProcessBizImpl.updateProcess(..))")
    public void doLog() {
    }

    /**
     * 后置通知
     */
    @AfterReturning("doLog()")
    public void after(JoinPoint point) throws Exception {
        StringBuffer changeDetail = new StringBuffer();
        Object[] args = point.getArgs();
        ProcessFormDTO dto = (ProcessFormDTO) args[0];
        AuditProcessDO originalAuditProcess = auditProcessMapperSlave.getAuditProcessByProcessId(dto.getId());

        Class<? extends ProcessFormDTO> cls = dto.getClass();
        Field[] fields = cls.getDeclaredFields();
        for (Field f : fields) {
            f.setAccessible(true);
            String fName = f.getName();
            Object fValue = f.get(dto);
            // 判断是否方法上存在注解
            boolean annotationPresent = f.isAnnotationPresent(FieldInterface.class);
            if (annotationPresent && fValue != null) {
                System.out.println("属性名:" + fName + " 属性值:" + fValue);
                FieldInterface fieldDescription = f.getAnnotation(FieldInterface.class);
                // 获取注解值
                String nameStr = fieldDescription.name();
                System.out.println(nameStr);
            }
        }
//        Method[] methods = cls.getDeclaredMethods();
//        for (Method str : methods) {
//            // 判断是否方法上存在注解
//            boolean annotationPresent = str.isAnnotationPresent(FieldInterface.class);
//            if (annotationPresent) {
//                // 获取自定义注解对象
//                FieldInterface fieldInterface = str.getAnnotation(FieldInterface.class);
//                // 根据对象获取注解值
//                String isNotNullStr = fieldInterface.name();
//                System.out.println("------------------" + isNotNullStr);
//            }
//        }

        // todo 根据方法不同,入mongo库
        System.out.println("==============监听到更新流程===============");
        System.out.println("==============更新流程====================");
        System.out.println("==============流程=======================");
        System.out.println("==============程=========================");
    }

    /**
     * 环绕通知
     */
//    @Around("doLog()")
    public void around(ProceedingJoinPoint point) {
        Object arg = null;
        System.out.println("************* 环绕前..... *************");
        System.out.println(point);
        //得到参数
        Object[] args = point.getArgs();
        System.out.println("args=> " + Arrays.toString(args));
        System.out.println(args[0] instanceof ProcessFormDTO);
        if (args[0] instanceof ProcessFormDTO) {
            ProcessFormDTO dto = (ProcessFormDTO) args[0];
            System.out.println(JSON.toJSONString(dto.getId()));
        }
        // 得到切入点的类型
        String kind = point.getKind();
        System.out.println("kind => " + kind);
        // 切入点 得到被增强方法的方法签名
        MethodSignature methodSignature = (MethodSignature) point.getSignature();

        // 方法名 到被增强方法的方法
        Method method = methodSignature.getMethod();
        System.out.println("method => " + method);

        // 方法名 到被增强方法的方法 上面的注解
        Signature signature = point.getSignature();
        String name = signature.getName();
        Class declaringType = signature.getDeclaringType();
        int modifiers = signature.getModifiers();
        String declaringTypeName = signature.getDeclaringTypeName();
        System.out.println("    name => " + name + "\\\n    declaringType => "
                + declaringType + "\\\n    modifiers => " + modifiers + "\\\n    declaringTypeName => " + declaringTypeName);
        System.out.println("signature => " + signature);
        // 得到目标
        Object target = point.getTarget();
        System.out.println("target => " + target);

        System.out.println("************* 环绕后 *************");
    }

}

开发初步完成效果:

package com.ipr.audit.aop;

import com.alibaba.fastjson.JSON;
import com.ipr.audit.dto.process.ProcessFormDTO;
import com.ipr.audit.dto.role.RoleFormDTO;
import com.ipr.audit.dto.step.AuditStepFormDTO;
import com.ipr.biz.ILogBiz;
import com.ipr.biz.convert.ProcessConvert;
import com.ipr.biz.convert.RoleConvert;
import com.ipr.biz.convert.StepConvert;
import com.ipr.dataobject.AuditLogDO;
import com.ipr.dataobject.AuditProcessDO;
import com.ipr.dataobject.AuditRoleDO;
import com.ipr.dataobject.AuditStepDO;
import com.ipr.mapper.IAuditProcessMapper;
import com.zhubajie.common.dto.ActionInfo;
import com.zhubajie.common.dto.Request;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Objects;

/**
 * 审核流程日志记录
 *
 * @author xnALPHA
 */
@Aspect
@Component
public class AuditLog {

    private Logger logger = LoggerFactory.getLogger(AuditLog.class);

    @Resource
    private IAuditProcessMapper auditProcessMapperSlave;
    @Resource
    private ILogBiz logBiz;

    /**
     * 日志记录切入点
     */
//    @Pointcut("execution(* com.ipr.biz.impl.ProcessBizImpl.updateProcess(..))")
    @Pointcut("@annotation(com.ipr.audit.aop.AddUpdateLog)")
    public void doLog() {
    }

    /**
     * 后置通知
     */
    @AfterReturning("doLog()")
    public void after(JoinPoint point) throws Exception {
        AuditLogDO auditLogDO = new AuditLogDO();
        // 接口请求参数
        Request args = (Request) point.getArgs()[0];
        ActionInfo actionInfo = args.getActionInfo();
        String operator = "SYSTEM";
        Integer operatorId = 0;
        if (!Objects.isNull(actionInfo)) {
            operator = actionInfo.getNickname();
            operatorId = actionInfo.getUserId();
        }
        auditLogDO.setOperatorId(operatorId.longValue());
        auditLogDO.setOperatorName(operator);
        // 变更详情
        StringBuffer changeDetail = new StringBuffer(operator);

        Field[] fields = null;
        Object original = new Object();
        if (args.getData() instanceof ProcessFormDTO) {
            ProcessFormDTO arg = (ProcessFormDTO) args.getData();
            AuditProcessDO auditProcessDO = ProcessConvert.fromProcessFormDTO(arg);
            auditLogDO.setProcessId(auditProcessDO.getProcessId());
            original = auditProcessMapperSlave.getAuditProcessByProcessId(auditProcessDO.getProcessId());
            Class<? extends ProcessFormDTO> cls = arg.getClass();
            fields = cls.getDeclaredFields();
        } else if (args.getData() instanceof RoleFormDTO) {
            RoleFormDTO arg = (RoleFormDTO) args.getData();
            AuditRoleDO roleDO = RoleConvert.fromRoleFormDTO(arg);
            auditLogDO.setRoleId(roleDO.getId());
            auditLogDO.setProcessId(roleDO.getProcessId());
            Class<? extends RoleFormDTO> cls = arg.getClass();
            fields = cls.getDeclaredFields();
        } else if (args.getData() instanceof AuditStepFormDTO) {
            AuditStepFormDTO arg = (AuditStepFormDTO) args.getData();
            AuditStepDO auditStepDO = StepConvert.fromAuditStepFormDTO(arg);
            auditLogDO.setRoleId(auditStepDO.getRoleId());
            auditLogDO.setStepId(auditStepDO.getStepId());
            Class<? extends AuditStepFormDTO> cls = arg.getClass();
            fields = cls.getDeclaredFields();
        }
        assert fields != null;
        for (Field f : fields) {
            // 判断是否方法上存在注解
            boolean annotationPresent = f.isAnnotationPresent(FieldInterface.class);
            f.setAccessible(true);
            String fName = f.getName();
            Object newValue = f.get(args.getData());
            if (annotationPresent && newValue != null) {
                System.out.println("属性名:" + fName + " 属性值:" + newValue);
                FieldInterface fieldDescription = f.getAnnotation(FieldInterface.class);
                // 获取注解值
                String nameStr = fieldDescription.name();
                String convertField = fieldDescription.convertField();
                System.out.println(nameStr);
                // 反射获取旧值
                String getLetters = "";
                if (StringUtils.isEmpty(convertField)) {
                    getLetters = fName.substring(0, 1).toUpperCase() + fName.substring(1);
                } else {
                    getLetters = convertField.substring(0, 1).toUpperCase() + convertField.substring(1);
                }
                String getter = "get" + getLetters;
                Method method = original.getClass().getMethod(getter);
                Object value = method.invoke(original);
                if (value instanceof Boolean) {
                    changeDetail.append("将").append(nameStr).append("由:\"").append(value).append("\"变更为:\"").append(newValue.equals(1)).append("\";\n");
                } else {
                    changeDetail.append("将").append(nameStr).append("由:\"").append(value).append("\"变更为:\"").append(newValue).append("\";\n");
                }
            }
        }

        System.out.println(changeDetail);
        auditLogDO.setOperateDetail(changeDetail.toString());
        // 入库
        addLogs(auditLogDO);
        System.out.println("==============监听到更新流程===============");
        System.out.println("==============更新流程====================");
        System.out.println("==============流程=======================");
        System.out.println("==============程=========================");
    }

    /**
     * 环绕通知
     */
//    @Around("doLog()")
    public void around(ProceedingJoinPoint point) {
        Object arg = null;
        System.out.println("************* 环绕前..... *************");
        System.out.println(point);
        //得到参数
        Object[] args = point.getArgs();
        System.out.println("args=> " + Arrays.toString(args));
        System.out.println(args[0] instanceof ProcessFormDTO);
        if (args[0] instanceof ProcessFormDTO) {
            ProcessFormDTO dto = (ProcessFormDTO) args[0];
            System.out.println(JSON.toJSONString(dto.getId()));
        }
        // 得到切入点的类型
        String kind = point.getKind();
        System.out.println("kind => " + kind);
        // 切入点 得到被增强方法的方法签名
        MethodSignature methodSignature = (MethodSignature) point.getSignature();

        // 方法名 到被增强方法的方法
        Method method = methodSignature.getMethod();
        System.out.println("method => " + method);

        // 方法名 到被增强方法的方法 上面的注解
        Signature signature = point.getSignature();
        String name = signature.getName();
        Class declaringType = signature.getDeclaringType();
        int modifiers = signature.getModifiers();
        String declaringTypeName = signature.getDeclaringTypeName();
        System.out.println("    name => " + name + "\\\n    declaringType => "
                + declaringType + "\\\n    modifiers => " + modifiers + "\\\n    declaringTypeName => " + declaringTypeName);
        System.out.println("signature => " + signature);
        // 得到目标
        Object target = point.getTarget();
        System.out.println("target => " + target);

        System.out.println("************* 环绕后 *************");
    }

    /**
     * 日志表新增记录
     *
     * @param auditLogDO
     */
    private void addLogs(AuditLogDO auditLogDO) {
//        Request<AuditLogDO> request = new Request<>(auditLogDO);
        int i = logBiz.insertAuditLog(auditLogDO);
        System.out.println(i);
    }
}