通过aop切面记录controller请求与返回结果日志

最新推荐文章于 2024-12-27 23:32:18 发布

原创最新推荐文章于 2024-12-27 23:32:18 发布 · 1.3k 阅读

1 ·

CC 4.0 BY-SA版权

springboot 专栏收录该内容

11 篇文章

订阅专栏

本文介绍如何使用Spring AOP实现对Controller请求参数及返回结果的日志记录功能。通过定义切面，在请求前后分别记录请求详情及返回数据。

1，加入aop包

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

2，切面代码

/**
 * 定义切面，记录controller请求参数与返回结果
 *
 * @author: hewenmin
 * @date: 2021/4/1 11:39
 * @param: null
 * @return:
 */
@Aspect
@Component
public class RequestRecordAspect {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Pointcut(value = "execution(public * com.jlkj.controller..*.*(..))")
    public void webLog() {
    }

    /**
     * 请求进入之前，日志记录
     * @author: hewenmin
     * @date: 2021/4/1 11:41
     * @param: null
     * @return:
     */
    @Before(value = "webLog()")
    public void doBefore(JoinPoint joinPoint) {
        // 接收到请求，打印请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 打印请求内容
        logger.info("URL : " + request.getRequestURL().toString());
        logger.info("HTTP_METHOD : " + request.getMethod());
        logger.info("IP : " + request.getRemoteAddr());
        logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
    }

    /**
     * 请求处理完成，返回日志记录
     *
     * @author: hewenmin
     * @date: 2021/4/1 11:41
     * @param: ret
     * @return: void
     */
    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) {
        logger.info("请求处理完成，返回数据：{}", ret.toString());
    }
}