在springboot中使用AOP进行全局日志记录

前言

此前项目上需要对用户的操作进行日志记录，以便后续追踪问题，所以就学习了使用 spring AOP 来进行日志记录。

1、 spring AOP 是什么？

spring 的两大核心就是 IOC 和 AOP，AOP 是 spring 框架面向切面的编程思想，AOP是横切性的技术，将涉及多业务流程的通用功能抽取并单独封装，形成独立的切面，再将这些切面横向切入到业务流程指定的位置中。

2、spring AOP 能做什么？

AOP 主要是从切面入手，将日志记录、安全控制、事务处理、全局异常处理等全局功能从我们的业务逻辑代码中划分出来。

3、spring AOP 我能用 AOP 解决什么问题？

正好我这边需要做一个全局的日志，如果每个方法都去写日志记录，这样代码量非常大，而且代码繁琐冗余，全局记录的话，只需要在方法上增加一个注解就可以实现日志记录。

好了，不多bb，直接上代码实现

一、引入依赖，增加自定义注解

1、引入 maven 依赖

        
        
            org.springframework.boot
            spring-boot-starter-aop

2、增加自定义注解 OperationLog

@Target(ElementType.METHOD) //注解放置的目标位置,METHOD是可注解在方法级别上
@Retention(RetentionPolicy.RUNTIME) //注解执行阶段
@Documented
public @interface OperationLog {
    String operDesc() default "";  // 操作说明
}

二、为自定义注解编写切面实现

@Aspect //标识一个切面类
@Component
public class OperationLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(OperationLogAspect.class);
    @Autowired
    private OperatelogsService OperatelogsService;
    @Autowired
    private SysUserService userService;
    /**
     * 设置操作日志切入点 记录操作日志 在注解的位置切入代码
     */
    @Pointcut("@annotation(com.wxw.annotation.OperationLog)")
    public void operLogPoinCut() {
    }
    /**
     * 正常返回通知，拦截用户操作日志，连接点正常执行完成后执行， 如果连接点抛出异常，则不会执行
     *
     * @param joinPoint 切入点
     * @param keys      返回结果
     */
    @AfterReturning(value = "operLogPoinCut()", returning = "keys")
    public void saveOperLog(JoinPoint joinPoint, Object keys) {
        // 获取RequestAttributes
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        // 从获取RequestAttributes中获取HttpServletRequest的信息
        HttpServletRequest request = (HttpServletRequest) requestAttributes
                .resolveReference(RequestAttributes.REFERENCE_REQUEST);
        Operatelogs operlog = new Operatelogs();
        try {
            // 从切面织入点处通过反射机制获取织入点处的方法
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            // 获取切入点所在的方法
            Method method = signature.getMethod();
            // 获取操作
            OperationLog opLog = method.getAnnotation(OperationLog.class);
            if (opLog != null) {
                String operDesc = opLog.operDesc();
                operlog.setfDescript(operDesc); // 操作描述
            }
            // 获取请求的类名
            String className = joinPoint.getTarget().getClass().getName();
            // 获取请求的方法名
            String methodName = method.getName();
            methodName = className + "." + methodName;
            operlog.setfRequestMethod(methodName); // 请求方法
            // 请求的参数
            Object[] arguments = joinPoint.getArgs();
            //判断参数数组是否为空
            Stream stream = ArrayUtils.isEmpty(arguments) ? Stream.empty() :  Arrays.asList(arguments).stream();
            //过滤 joinPoint.getArgs()返回的数组中携带有Request或者Response对象
            List