Spring AOP与自定义注解Annotation的使用实践 @Around("@annotation(operationLog)") 可行

Spring AOP与自定义注解Annotation的使用

AOP，Spring框架的两大核心之一，又称面向切面编程，通过代理模式，对原有的类进行增强。在Spring框架中，AOP有两种动态代理方式，其一是基于JDK的动态代理，需要代理的类实现某一个接口；其二是基于CGLIB的方式，该方式不需要类实现接口就能进行代理。AOP的应用场景，常见的就是事务的处理和日志的记录，还有权限的认证。（笔者使用AOP的场景：保存所有用户对数据进行的增删改内容等，比如，张三修改了一个表格数据的值，就需要记录谁，什么时候，修改or添加or删除，哪项数据，数据的旧值和新值是什么。因为涉及到的接口很多，也很分散，所以笔者使用aop和自定义注解，让所有涉及到增删改的接口添加自定义注解，以达到在保存记录之后进行操作日志记录。）

Annotation，自定义注解，基于Java六大元注解的注解（target、document、retention、inherited、repeatable和类型注解）。一般创建自定义注解，至少会在该注解上添加@target（注解的位置，如添加到方法上或者是类上）和@retention（注解使用的时机，编译期间或者运行时等）俩个注解。

一、自定义注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OperationLog {
    //表示操作是那个服务哪个模块下的操作
    String module() default "xxxx服务";
 
    //操作的类型，添加，更新，删除
    String type() default "add";
 
    //操作者
    String user() default "system";
 
    //操作描述
    String operation() default "";
}

二、Aspect类

import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
 
import javax.servlet.http.HttpServletRequest;
import java.text.SimpleDateFormat;
 
@Aspect
@Component
public class OperationLogAspect {
    private ThreadLocal<SimpleDateFormat> format = ThreadLocal.withInitial(() -> new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
    
    //切点表达式，表示加了OperationLog注解的都是切点，路径是自定义注解的全路径
    @Pointcut("@annotation(com.alice.springboot.demo.OperationLog)")
    public void pointcut()
    {
        
    }
    
    @Around("@annotation(operationLog)")
    public Object operationLogRecord(ProceedingJoinPoint joinPoint, OperationLog operationLog)
    {
        //获取请求
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        //响应
        ResponseResult<Object> responseResult = null;
        //判断原方法是否正常执行的标志
        boolean isNormalProcess = false;
        
        try 
        {
            //返回切点处继续执行原方法，并接收原方法的响应
            responseResult = (ResponseResult<Object>) joinPoint.proceed();    
            //如果顺利执行，那么说明原方法执行正常，就可以进行日志记录。因为，如果原方法的增删改出问题了，那么日志就不需要记录了，不用记录失败的操作。
            isNormalProcess = true;
        }
        catch (Throwable e)
        {
            System.out.println("原方法报错，不需要记录日志");
        }
        
        try 
        {
            if (isNormalProcess)
            {
                //如果原方法正常执行完毕，那么需要记录操作日志
                saveOperationLog(joinPoint, operationLog, request);
            }
        }
        catch (Exception e)
        {
            System.out.println("保存操作日志出错");
        }
        
        return  responseResult;
    }
    
    private void saveOperationLog(ProceedingJoinPoint joinPoint, OperationLog operationLog, HttpServletRequest request)
    {
        //用来记录参数的值
        StringBuilder contentBuilder = new StringBuilder();
        //从切点获取切点的所有参数
        Object[] allParams = joinPoint.getArgs();
        
        for (Object param: allParams)
        {
            contentBuilder.append(JSON.toJSONString(param) + ",");
        }
        //删除最后一个多余的逗号
        contentBuilder.delete(contentBuilder.length() - 1, contentBuilder.length());
        
        //执行数据库操作，将信息保存到数据库，笔者这里使用的是mongodb，仅供参考，主要看获取自定义注解里面的值
        Document document = new  Document();
        //获取自定义注解里面的值
        document.append("module", operationLog.module())
                .append("type", operationLog.type())
                .append("user", operationLog.user())
                .append("operation", operationLog.operation())
                .append("content", contentBuilder.toString());
        
        logDao.saveLogs("mongo collection name", document);
    }
    
}

三、如何使用——controller层使用

package com.alice.springboot.demo;
 
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
@RequestMapping(value = "/test")
public class OperationLogController {
 
    @RequestMapping(value = "/add", method = RequestMethod.POST)
    @OperationLog(module = "xxx服务", type = "add", operation = "添加xxx")
    //这里使用到了自定义注解，并且赋值了自定义注解里面的某些值，最后在aspect里面可以获取到这些值
    public ResponseResult<String> addOperation(String user, String content)
    {
        ResponseResult<String> result = new ResponseResult<>();
 
        try
        {
            //执行添加操作
            result.setStatus(ResponseStatusEnum.SUCCESS);
            result.setMessage("添加操作成功");
        }
        catch (Exception e)
        {
            result.setStatus(ResponseStatusEnum.FAIL);
            result.setMessage("添加操作失败" + e.toString());
        }
 
        return result;
    }
}