Springboot自定义注解 AOP切面统一打印日志

u话不多说，先来张请求接口的日志打印效果：

先添加 pom 依赖

            <!-- aop 依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <!-- 用于日志切面中，以 json 格式打印出入参 -->
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.8.5</version>
        </dependency>

自定义日志注解 -- 源代码：

import java.lang.annotation.*;

/**
 *      # 自定义日志注解 #
 * @Target：注解用于什么地方，我们定义为作用于方法上；
 * @Retention：什么时候使用该注解，我们定义为运行时；
 * @Documented：注解是否将包含在 JavaDoc 中；
 * WebLog：注解名为 WebLog;
 * default "" ：定义一个属性，默认为空字符串；
 */

@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebLog {
    /**
     * 日志描述信息
     * @return
     **/
    String description() default "";
}

配置AOP切面 -- 源代码：

import com.google.gson.Gson;
import com.jx.wms.common.WebLog;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.lang.reflect.Method;

/**
 *
 * 配置 AOP 切面   ---  aspectj 相关注解的作用：
 *
 * 对于那些性能要求较高的应用，不想在生产环境中打印日志，只想在开发环境或者测试环境中使用，要怎么做呢？我们只需为切面添加 @Profile 就可以
 * @Profile({"dev", "test"})  这样就指定了只能作用于 dev 开发环境和 test 测试环境，生产环境 prod 是不生效的！
 *
 * @Aspect：声明该类为一个注解类；
 * @Pointcut：定义一个切点，后面跟随一个表达式，表达式可以定义为切某个注解，也可以切某个 package 下的方法；
 * 切点定义好后，就是围绕这个切点做文章了：
 *
 * @Before: 在切点之前，织入相关代码；
 * @After: 在切点之后，织入相关代码;
 * @AfterReturning: 在切点返回内容后，织入相关代码，一般用于对返回值做些加工处理的场景；
 * @AfterThrowing: 用来处理当织入的代码抛出异常后的逻辑处理;
 * @Around: 环绕，可以在切入点前后织入代码，并且可以自由的控制何时执行切点；
 *
 *
 * attention：！！
 *      web项目会有多切面，如何指定切面的优先级(执行顺序)？
 *      可以通过 @Order(i) 注解指定优先级， 注意i值越小，优先级越高 ------- 执行顺序类似栈，先进后出
 *      切点之前 Before: 中 @Order(i) i值越小  执行优先级越高
 *      切点之后 After: 中 @Otder(i) i值越小  优先级越低
 *
 *

 *
 *
 * @date 2023-12-7
 * @time 16:19
 * @discription
 **/
@Aspect
@Component
//@Profile({"dev", "test"})
public class WebLogAspect {

    private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
    /** 换行符 */
    private static final String LINE_SEPARATOR = System.lineSeparator();

    /** 以自定义 @WebLog 注解为切点 --- @annotation里配置的 @WebLog的自定义注解的全路径名 */
    @Pointcut(value = "@annotation(com.jx.wms.common.WebLog)")
    public void webLog() {}

    /**
     * 环绕 - 用于何时执行切点
     * @param proceedingJoinPoint
     * @return
     * @throws Throwable
     */
    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        /** 记录一下调用接口的开始时间 */
        long startTime = System.currentTimeMillis();
        /** 执行切点 : 执行切点后会依次执调用 @Before->接口逻辑code->@After->@AfterReturning */
        Object result = proceedingJoinPoint.proceed();
        // 打印出参
        logger.info("Response Args  : {}", new Gson().toJson(result));
        // 执行耗时
        logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
        // 接口结束后换行，方便分割查看
        logger.info("===================== END ===================" + LINE_SEPARATOR);
        return result;
    }


    /**
     * 在切点之前织入
     * @param joinPoint
     * @throws Throwable
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 开始打印请求日志
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 获取 @WebLog 注解的描述信息
        String methodDescription = getAspectLogDescription(joinPoint);

        // 打印请求相关参数
        logger.info("===================== Start ===================");
        // 打印请求 url
        logger.info("URL            : {}", request.getRequestURL().toString());
        // 打印描述信息
        logger.info("Description    : {}", methodDescription);
        // 打印 Http method
        logger.info("HTTP Method    : {}", request.getMethod());
        // 打印调用 controller 的全路径以及执行方法
        logger.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
        // 打印请求的 IP
        logger.info("IP             : {}", request.getRemoteAddr());
        // 打印请求入参
        logger.info("Request Args   : {}", new Gson().toJson(joinPoint.getArgs()));
    }


    /**
     * 在切点之后织入
     * @throws Throwable
     */
    @After("webLog()")
    public void doAfter() throws Throwable {
//        // 接口结束后换行，方便分割查看
//        logger.info("=========================================== End ===========================================" + LINE_SEPARATOR);
    }

    public void doAfterRetuning(){

    }

    /**
     * 获取切面注解的描述
     *
     * @param joinPoint 切点
     * @return 描述信息
     * @throws Exception
     */
    public String getAspectLogDescription(JoinPoint joinPoint)
            throws Exception {
        String targetName = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] arguments = joinPoint.getArgs();
        Class targetClass = Class.forName(targetName);
        Method[] methods = targetClass.getMethods();
        StringBuilder description = new StringBuilder("");
        for (Method method : methods) {
            if (method.getName().equals(methodName)) {
                Class[] clazzs = method.getParameterTypes();
                if (clazzs.length == arguments.length) {
                    description.append(method.getAnnotation(WebLog.class).description());
                    break;
                }
            }
        }
        return description.toString();
    }

}

配置完之后怎么使用呢？在Controller层的方法接口上面加上自定义的Log注解就可以啦！

如果不想打印某个接口的方法，无需加上Log注解即可~

PS：多个切面向指定优先级的话在切面上加上@Order(i)注解  i值越小 执行优先级越高撒