SpringBoot使用aop实现统一的日志记录

前言

在做项目的时候，最好在进入Controller的时候加上一个日志信息，可以记录一些日志的操作，方便我们在后台可以清除的看到调用过程,但是如果是做大型项目，那么我们难道要在所有的Controller层手动添加吗？
于是我们就用到了Spring的Aop 下面我们来看下在springboot中是怎么使用Aop来管理日志信息的吧

二、使用步骤

1.导入依赖

在Maven中添加依赖

	<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.0.RELEASE</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
    </dependencies>

2.创建一个Controller切面类

package com.xx.xx.asp;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
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;
import java.util.Arrays;
import java.util.Date;

@Aspect
@Component
@Slf4j
public class MyControllerLog {
    //保证同步安全性（可以不加）
    private ThreadLocal<Long> threadLocal = new ThreadLocal<>();

    //定义一个切入点
    @Pointcut("execution(* com.tanhua.server.controller..*.*(..))")
    public void logPointCut() {
    }

    //在方法之前切入内容（打印日志）
    @Before("logPointCut()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        threadLocal.set(new Date().getTime());
        //记录当前时间
        log.debug("访问时间：" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
        //从RequestContextHolder中获取servlet请求属性
        ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        //从servletRequestAttributes获取HttpServletRequest对象
        HttpServletRequest servletRequest = servletRequestAttributes.getRequest();
        //获取请求路径
        log.debug("请求路径为：" + servletRequest.getRequestURL());
        //获取请求方式
        log.debug("请求方式为:" + servletRequest.getMethod());
        //获取请求参数
        log.debug("请求参数为：" + Arrays.toString(joinPoint.getArgs()));
    }

    //在方法返回值之后切入内容（获得返回值）
    @AfterReturning(returning = "result", pointcut = "logPointCut()")
    public void doAfterReturning(Object result) throws Throwable {
        log.debug("方法返回值：" + result);
        log.debug("耗时：" + (new Date().getTime() - threadLocal.get()) + "毫秒");
    }

}

3.效果参考

4.execution的详细介绍

5.参考的文档

https://www.huaweicloud.com/articles/54aa9edbbb562ea82964edaf7f80d75c.html
https://blog.csdn.net/qq_39016934/article/details/110873506