springboot项目利用AOP完成接口请求日志输出

原创已于 2024-10-16 12:32:20 修改 · 1.3k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#spring #AOP #API请求日志输出

于 2021-05-11 17:28:04 首次发布

java 同时被 2 个专栏收录

107 篇文章

订阅专栏

springboot

6 篇文章

订阅专栏

本文介绍如何使用 Spring Boot 和 AOP 实现统一的日志记录功能，包括请求 URL、HTTP 方法、Controller 调用详情、客户端 IP 地址及请求参数等。通过配置 Maven 依赖和自定义切面类，实现对 RESTful API 的全面监控。

在这里插入图片描述

今天不想说废话，直接正儿八经的上教学，按照步骤来，没毛病~

配置

引入maven依赖

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

代码

import com.google.gson.Gson;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;


@Component
@Aspect
@Slf4j
public class LogAop {
    @Autowired
    HttpServletRequest request;

    //换行符
    private final static String LINE_SEPARATOR = System.lineSeparator();

    @Pointcut("execution(public * com.example.demo.controller..*.*(..))")
    public void apiPointCut() {
    }

    @Around("apiPointCut()")
    public Object apiAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();
        //打印出参
        log.info("Response Args  : {}", new Gson().toJson(result));
        //执行耗时
        log.info("Time-Consuming : {} ms",System.currentTimeMillis()-startTime,LINE_SEPARATOR);
        return result;
    }

    @Before("apiPointCut()")
    public void beforeReturning(JoinPoint joinPoint) {
        //开始打印请求日志
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

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


    @After("apiPointCut()")
    public void doAfter(){
//        接口结束后换行，方便分割查看
        log.info("=============== End ===============");
    }

}