来个切面日志打印请求和响应信息

本文介绍了如何在SpringBoot项目中使用AOP(面向切面编程)和Fastjson库,实现在请求接口和响应时自动记录日志,简化开发过程,便于问题排查。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

为了偷个懒,不用每次在请求接口和响应信息的时候都打印一下日志信息,索性就用切面来实现,这样爽歪歪。
一、依赖
我用的是jdk11,springboot是2.7.13的版本,对应引入的切面的依赖是:

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

二、切面

import com.alibaba.fastjson2.JSON;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
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.util.Arrays;
import java.util.Objects;

@Aspect
@Component
public class InterfaceAspect {
    private final Logger logger = LoggerFactory.getLogger(InterfaceAspect.class);
    @Around("execution(public * com.demo.cn.controller..*.*(..))")
    public Object controllerLog(ProceedingJoinPoint pdj) throws Throwable{
        HttpServletRequest request = ((ServletRequestAttributes) Objects.requireNonNull(RequestContextHolder.getRequestAttributes())).getRequest();
        long startTime = System.currentTimeMillis();//开始时间
        //获取参数数组
        Object[] args = pdj.getArgs();
        //执行原方法并获取返回结果
        Object ret = pdj.proceed(args);
        long endTime = System.currentTimeMillis();

        // 记录下请求内容
        logger.info("请求信息: URL={}, IP={}, PARAMS={}, CLASS_METHOD={}, SPEND_TIME={}",
                request.getRequestURL(),
                request.getRemoteAddr(),
                Arrays.toString(args),
                pdj.getSignature().getDeclaringTypeName() + "." + pdj.getSignature().getName(),
                (endTime - startTime) + "毫秒");
        logger.info("响应结果:{}", JSON.toJSONString(ret.toString()));
        return ret;
    }

就这样就可以了,很简单,却很方便排查问题。

-------------你知道的越多,不知道的越多--------------

您可以通过在接口调用前后添加切面(Aspect),在接口调用前记录请求参数时间戳,在接口调用后记录响应结果时间戳。具体地,您可以在切面中使用 `@Before` 注解 `@AfterReturning` 注解来分别捕捉接口调用前调用后的信息。在 `@AfterReturning` 注解中,您可以通过返回值参数 `Object returnValue` 来获取接口的返回结果,然后对其进行处理。这里提供一个简单的示例: ```java @Component @Aspect public class InterfaceLogAspect { private static final Logger LOGGER = LoggerFactory.getLogger(InterfaceLogAspect.class); @Before("execution(* com.example.demo.service.impl.*.*(..))") public void before(JoinPoint joinPoint) { LOGGER.info("Method {}() is invoked with args {} at {}.", joinPoint.getSignature().getName(), Arrays.toString(joinPoint.getArgs()), LocalDateTime.now()); } @AfterReturning(pointcut = "execution(* com.example.demo.service.impl.*.*(..))", returning = "returnValue") public void afterReturning(JoinPoint joinPoint, Object returnValue) { LOGGER.info("Method {}() is finished at {} with return value {}.", joinPoint.getSignature().getName(), LocalDateTime.now(), returnValue); } } ``` 在上述示例中,我们定义了一个名为 `InterfaceLogAspect` 的切面,并使用 `@Before` `@AfterReturning` 注解分别捕捉接口调用前调用后的信息。其中,我们使用 `JoinPoint` 对象来获取调用方法的名称参数,并使用 `LocalDateTime` 来记录时间戳。在 `@AfterReturning` 注解中,我们使用 `Object returnValue` 参数来获取接口返回的结果,并通过 `LOGGER` 对象来打印日志信息。您可以根据自己的需求修改上述示例中的代码。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值