SpringBoot用AOP+自定义注解实现操作日志写入数据库

前言

一、操作日志业务处理

根据数据库日志表和具体业务要求,写好操作日志实体类和操作日志业务层处理逻辑类OperationLogService

二、自定义注解

1.了解自定义注解

2.编写自定义注解

import java.lang.annotation.*;

/**
 * @author nianyu
 * 自定义操作日志注解(用于操作日志存入数据库操作日志表)
 */
@Target(value = ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OperationLogAnnotate {

	/**
     *操作类型
     */
    String operatorType() default "";

    /**
     * 操作请求
     */
    String operatorRequest() default "";

}

三、AOP切面

1.了解AOP切面

1.编写日志切面类

/**
 * 操作日志切面类
 *
 * @author nianyu
 */

@Aspect
@Component
public class OperationLogAspect {

	/**
     * OperationLogService 日志写入数据库的业务处理类
     */
    @Resource
    OperationLogService operationLogService;

    /**
     * 定义切点 @Pointcut
     * 在注解的位置切入代码
     * com.nianyu.log.annotation.OperationLogAnnotate 是注解所在路劲
     */
    @Pointcut("@annotation(com.nianyu.log.annotation.OperationLogAnnotate)")
    public void logPointCut() {
    }

	/**
     * 用户操作完后保存日志到数据库
     * 在注解的位置切入代码
     * com.nianyu.log.annotation.OperationLogAnnotate 是注解所在路径
     * @param ret 用户执行操作方法的返回结果,封装的类型为Result
     */
    @AfterReturning(value = "logPointCut() && @annotation(logger)", returning = "ret")
    public void saveOperationLog(JoinPoint joinPoint, OperationLogAnnotate logger, Result ret) {
     
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //创建一个操作日志实体类存放此次操作信息
        OperationLog operationLog = new OperationLog();
        try {
        	//获取用户id
            operationLog .setOperatorId(UserUtil.getCurrentUserId().toString());
        } catch (Exception e) {
            e.printStackTrace();
        }
        //获取操作请求
        operationLog.setOperatorRequest(logger.operatorRequest());
        //获取操作类型
        operationLog.setOperatorType(logger.operatorType()); 
        //获取ip
        operationLog.setOperatorIp(request.getRemoteAddr());
        //操作时间
        operationLog.setOperateDate(LocalDateTime.now());
        //获取类名方法名
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        operationLog.setOperatorMethod(className + "." + methodName + "()");
        //获取uri
        String requestURI = request.getRequestURI();
        operationLog.setOperatorUri(requestURI);
        //若有返回结果,封装返回信息
        if (null != ret) {
            operationLog.setOperatorReturnCode(ret.getCode());
            operationLog.setOperatorReturnMsg(ret.getMsg());
        }
        //将操作日志写入数据库
        operationLogService.addOperationLog(operationLog );
    }

四、操作日志写入数据库(使用自定义注解)

在需要存入数据库的操作方法上加上自定义注解

@PostMapping("/add")
@OperationLogAnnotate(operatorType="add",operatorRequest="增加XXXXX")
public Result addUser(@RequestBody User user){
    
     return tsstService.addUser(user);
}

启动项目,访问请求,查看数据库是否有刚才的操作记录