Spring Boot 2.x 教程系列 | AOP 切面统一打印请求日志

最新推荐文章于 2024-05-29 16:46:55 发布
最新推荐文章于 2024-05-29 16:46:55 发布
阅读量2.9k 收藏 17
点赞数 3
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weiwosuoai/article/details/100032090
版权

欢迎关注微信公众号: 小哈学Java

文章首发于个人网站 https://www.exception.site/springboot/spring-boot-aop-web-request

本节中，您将学习如何在 Spring Boot 中使用 AOP 切面统一处理请求日志，打印进出参相关参数。

一、先看看日志输出效果

640?wx_fmt=png

可以看到，每个对于每个请求，开始与结束一目了然，并且打印了以下参数：

  • URL: 请求接口地址；

  • HTTP Method: 请求的方法，是 POST, GET, 还是 DELETE 等；

  • Class Method: 对应 Controller 的全路径以及调用的哪个方法;

  • IP: 请求 IP 地址；

  • Request Args: 请求入参，以 JSON 格式输出；

  • Response Args: 响应出参，以 JSON 格式输出；

  • Time-Consuming: 请求耗时；

效果应该还不错吧！接下来就让我们一步一步去实现该功能, 首先，新建一个 Spring Boot Web 项目。

二、添加 Maven 依赖

在项目 pom.xml 文件中添加依赖：

<!-- aop 依赖 -->	
<dependency>	
    <groupId>org.springframework.boot</groupId>	
    <artifactId>spring-boot-starter-aop</artifactId>	
</dependency>	
<!-- 用于日志切面中，以 json 格式打印出入参（本来使用阿里的 FASTJSON, 但是对于文件上传的接口，打印参数会报错，换为 Gson） -->	
<dependency>	
    <groupId>com.google.code.gson</groupId>	
    <artifactId>gson</artifactId>	
    <version>2.8.5</version>	
</dependency>

三、配置 AOP 切面

在配置 AOP 切面之前，我们需要了解下 aspectj 相关注解的作用：

  • @Aspect：声明该类为一个注解类；

  • @Pointcut：定义一个切点，后面跟随一个表达式，表达式可以定义为某个 package 下的方法，也可以是自定义注解等；

  • 切点定义好后，就是围绕这个切点做文章了：

  • @Before: 在切点之前，织入相关代码；

  • @After: 在切点之后，织入相关代码;

  • @AfterReturning: 在切点返回内容后，织入相关代码，一般用于对返回值做些加工处理的场景；

  • @AfterThrowing: 用来处理当织入的代码抛出异常后的逻辑处理;

  • @Around: 在切入点前后织入代码，并且可以自由的控制何时执行切点；

接下来，定义一个 WebLogAspect.java 切面类，代码如下：

package site.exception.springbootaopwebrequest.aspect;	
import com.google.gson.Gson;	
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;	
/**	
 * @author www.exception.site (exception 教程网)	
 * @date 2019/2/12	
 * @time 14:03	
 * @discription	
 **/	
@Aspect	
@Component	
public class WebLogAspect {	
    private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);	
    /** 以 controller 包下定义的所有请求为切入点 */	
    @Pointcut("execution(public * site.exception.springbootaopwebrequest.controller..*.*(..))")	
    public void webLog() {}	
    /**	
     * 在切点之前织入	
     * @param joinPoint	
     * @throws Throwable	
     */	
    @Before("webLog()")	
    public void doBefore(JoinPoint joinPoint) throws Throwable {	
        // 开始打印请求日志	
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();	
        HttpServletRequest request = attributes.getRequest();	
        // 打印请求相关参数	
        logger.info("========================================== Start ==========================================");	
        // 打印请求 url	
        logger.info("URL            : {}", request.getRequestURL().toString());	
        // 打印 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 ===========================================");	
        // 每个请求之间空一行	
        logger.info("");	
    }	
    /**	
     * 环绕	
     * @param proceedingJoinPoint	
     * @return	
     * @throws Throwable	
     */	
    @Around("webLog()")	
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {	
        long startTime = System.currentTimeMillis();	
        Object result = proceedingJoinPoint.proceed();	
        // 打印出参	
        logger.info("Response Args  : {}", new Gson().toJson(result));	
        // 执行耗时	
        logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);	
        return result;	
    }	
}

我们通过 @Aspect 声明了 WebLogAspect.java 为切面类，之后，通过 @Pointcut 定义了打印请求日志的切点，切点为 site.exception.springbootaopwebrequest.controller 包下所有的请求接口。

切点定义好后，我们通过 @Before 在切点之前打印请求的相关参数，通过 @Around 打印了请求接口的耗时时间，最后通过 @After 做了请求的收尾工作。

到这里，切面相关的代码就完成了！

三、测试

我们针对 GET, POST, 文件提交，以及多文件提交四种接口分别测试其效果, 接口定义如下：

package site.exception.springbootaopwebrequest.controller;	
import org.slf4j.Logger;	
import org.slf4j.LoggerFactory;	
import org.springframework.web.bind.annotation.*;	
import org.springframework.web.multipart.MultipartFile;	
import site.exception.springbootaopwebrequest.entity.User;	
/**	
 * @author www.exception.site (exception 教程网)	
 * @date 2019/2/16	
 * @time 21:03	
 * @discription	
 **/	
@RestController	
public class TestController {	
    private final static Logger logger = LoggerFactory.getLogger(TestController.class);	
    /**	
     * POST 方式接口测试	
     * @param user	
     * @return	
     */	
    @PostMapping("/user")	
    public User testPost(@RequestBody User user) {	
        logger.info("testPost ...");	
        return user;	
    }	
    /**	
     * GET 方式接口测试	
     * @return	
     */	
    @GetMapping("/user")	
    public String testGet(@RequestParam("username") String username,	
                          @RequestParam("password") String password) {	
        logger.info("testGet ...");	
        return "success";	
    }	
    /**	
     * 单文件上传接口测试	
     * @return	
     */	
    @PostMapping("/file/upload")	
    public String testFileUpload(@RequestParam("file") MultipartFile file) {	
        logger.info("testFileUpload ...");	
        return "success";	
    }	
    /**	
     * 多文件上传接口测试	
     * @return	
     */	
    @PostMapping("/multiFile/upload")	
    public String testMultiFileUpload(@RequestParam("file") MultipartFile[] file) {	
        logger.info("testMultiFileUpload ...");	
        return "success";	
    }	
}

User.java:

package site.exception.springbootaopwebrequest.entity;	
import java.io.Serializable;	
import java.util.Date;	
/**	
 * @author www.exception.site (exception 教程网)	
 * @date 2019/2/16	
 * @time 21:00	
 * @discription	
 **/	
public class User implements Serializable {	
    /**	
     * 用户名	
     */	
    private String username;	
    /**	
     * 密码	
     */	
    private String password;	
    /**	
     * 创建时间	
     */	
    private Date createTime;	
    public String getUsername() {	
        return username;	
    }	
    public void setUsername(String username) {	
        this.username = username;	
    }	
    public String getPassword() {	
        return password;	
    }	
    public void setPassword(String password) {	
        this.password = password;	
    }	
    public Date getCreateTime() {	
        return createTime;	
    }	
    public void setCreateTime(Date createTime) {	
        this.createTime = createTime;	
    }	
}

3.1 GET 接口测试

请求 http://localhost:8080/user?username=张三&password=123456接口，观察日志打印情况：

640?wx_fmt=png

GET 接口正常打印日志！

3.2 POST 接口测试

通过 Postman 请求 http://localhost:8080/user POST 接口：

640?wx_fmt=png

看看控制台输出效果：

640?wx_fmt=png

POST 接口也是 OK 的!

3.3 单文件提交接口测试

请求单文件提交接口： http://localhost:8080/file/upload :

640?wx_fmt=png

日志输出如下：

640?wx_fmt=png

3.4 多文件提交接口测试

请求单文件提交接口： http://localhost:8080/multiFile/upload :

640?wx_fmt=png

切面日志输出：

640?wx_fmt=png

为何不用 FASTJSON

笔者在开始阶段的确使用的是阿里 FASTJSON 来做出入参的打印，但是对于文件上传接口，FASTJSON 转换会出错，故改用谷歌的 Gson。

640?wx_fmt=png

GitHub 源码地址

https://github.com/weiwosuoai/spring-boot-tutorial/tree/master/spring-boot-aop-web-request

·END·

 近期热文：

如果你喜欢本文

请长按二维码，关注小哈学Java

640?wx_fmt=jpeg

转发朋友圈，是对我最大的支持。

看完，赶紧点个“好看”鸭

点鸭点鸭

↓↓↓↓

犬小哈
关注
  • 3
    点赞
  • 踩
  • 17
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
如何优雅地在 Spring Boot 中使用自定义注解，AOP 切面统一打印出入参日志 | 修订版…
01-06
今天主要说说如何通过自定义注解的方式，在 Spring Boot 中来实现 AOP 切面统一打印出入参日志。小伙伴们可以收藏一波。 废话不多说，进入正题 ！ 目录 一、先看看切面日志输出效果 二、添加 AOP Maven
详解Spring Boot中使用AOP统一处理Web请求日志
08-30
Spring Boot 中使用 AOP统一处理 Web 请求日志 Spring Boot 中使用 AOP 统一处理 Web 请求日志是指在 Spring Boot 应用程序中使用Aspect Oriented Programming（面向 Aspect 编程）技术来实现统一的 Web 请求日志...
SpringBoot 集成使用AOP来记录接口调用的入参和出参
qq_27860623的博客
05-23 324
【代码】SpringBoot 集成使用AOP来记录接口调用的入参和出参。
Spring Boot 2.x基础教程：快速上手指南
2301_76419561的博客
05-29 1890
当您首次探索并尝试学习Spring框架时，是否因其复杂的配置而感到畏惧？在您多次使用Spring框架后，是否对重复粘贴的配置文件感到厌烦？如果您正在寻找一种更简单、更快捷的方式来构建Spring应用，那么不妨尝试一下Spring Boot。Spring Boot使我们的Spring应用更加轻量级。我们不再需要像以前那样繁琐地构建项目、打包应用、部署到Tomcat等应用服务器中来运行我们的业务服务。
Spring Boot 2.0 教程 | AOP 切面统一打印请求日志
犬小哈
02-21 885
欢迎关注微信公众号: 小哈学Java 文章首发于个人网站 https://www.exception.site/springboot/spring-boot-aop-web-request 本节中，您将学习如何在 Spring Boot 中使用 AOP 切面统一处理请求日志，打印进出参相关参数。 一、先看看日志输出效果 可以看到，每个对于每个请求，开始与结束一目了然，并且打印了以下参数： ...
Spring Boot AOP 切面统一打印请求与响应日志
我的青春一去不复返
08-19 476
package com.wei.mall.filter; import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper; import java.util.Arrays; import javax.servlet.http.HttpServletRequest; import org.aspectj.lang.JoinPoint; import or.
Spring Boot2.x使用AOP进行请求和响应日志的打印
MoncyXu的博客
04-17 3289
主要步骤1.导入jar包2.配置yml文件3.编写AOP切面 1.导入jar包 加入该包后，spring boot默认就会开启aop了。 <!--aop--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-s...
Spring Boot 利用aop切面思想做日志打印
IWinds的博客
01-11 1057
利用aop切面思想实现日志打印功能
Spring Boot2.X使用AOP打印接口请求日志
胖虎儿的博客
02-06 5354
Spring Boot使用AOP打印接口请求日志 Spring的两大特性 IOC（自动注入）和AOP（面向切面）本文讲的是使用AOP面向切面的特行，在用户访问系统时候，根据其访问的控制层方法 打印对应的请求日志，例如：客户端浏览器型号，电脑系统型号， 方法执行时间，请求参数等等。。。。。。。 1.理解AOP （1）AOP就是在某一个类或方法执行前后打个标记，声明在执行到这里之前要先执行什么，执行完...
微服务框架（八）Spring Boot AOP 日志切面实现
若明天不见
08-10 6238
　　此系列文章将会描述Java框架Spring Boot、服务治理框架Dubbo、应用容器引擎Docker，及使用Spring Boot集成Dubbo、Mybatis等开源框架，其中穿插着Spring Boot中日志切面等技术的实现，然后通过gitlab-CI以持续集成为Docker镜像。 　　本文为使用Spring Boot AOP 实现日志切面、分离INFO和ERROR级别日志 本系...
猿创征文|Spring系列框架之面向切面编程AOP
未见花闻的博客
09-06 2628
本篇文章将介绍一种特别重要的思想，AOP（Aspect Oriented Programming），即面向切面编程，可以说是OOP（Object Oriented Programming，面向对象编程）的补充和完善。 AOP把软件系统分为两个部分：核心关注点和横切关注点。业务处理的主要流程是核心关注点，与之关系不大的部分是横切关注点。
Spring Boot中使用AOP统一处理Web请求日志
2301_79099480的博客
04-20 983
由于文档内容过多，为了避免影响到大家的阅读体验，在此只以截图展示部分内容，详细完整版的JavaScript面试题文档，或更多前端资料可以点此处免费获取。[外链图片转存中…(img-yCfZm07Q-1713557569300)][外链图片转存中…(img-ZwKSzIpn-1713557569301)]由于文档内容过多，为了避免影响到大家的阅读体验，在此只以截图展示部分内容，详细完整版的JavaScript面试题文档，或更多前端资料可以点此处免费获取。
spring-boot aop
01-23
Spring Boot AOP（面向切面编程）是一种强大的设计模式，它允许我们在不修改现有代码的情况下，插入额外的功能或监控代码。在Spring框架中，AOP主要用于日志记录、事务管理、性能统计等场景。本示例是关于如何在...
springboot配置aop切面日志打印过程解析
08-25
Spring Boot 配置 AOP 切面日志打印过程解析 本文主要介绍了 Spring Boot 配置 AOP 切面日志打印过程解析，通过示例代码详细讲解了 AOP 的概念、相关概念、AOP 代理、织入等知识点，并提供了实际的代码示例。 一、...
spring boot如何使用AOP统一处理web请求
08-25
本文主要介绍了如何使用Spring Boot框架结合AOP（Aspect-Oriented Programming，面向切面编程）技术来统一处理Web请求日志。通过使用AOP，我们可以在不修改原有业务逻辑的情况下，对Web请求进行统一的日志记录，从而...
pillow_heif-0.17.0-pp39-pypy39_pp73-macosx_14_0_arm64.whl
07-27
基本介绍 名称与起源：Pillow，原名为PIL（Python Imaging Library），但PIL只支持Python 2版本。随着Python 3的普及，Pillow作为PIL的一个分支出现，兼容Python 3并提供更多的功能和改进。 主要功能：Pillow支持多种图像格式的打开、保存、显示以及基本的图像操作和处理，如裁剪、缩放、旋转、翻转、滤镜应用等。 跨平台性：Pillow库可以在不同的操作系统上运行，包括Windows、Linux和MacOS等。 主要功能模块 Pillow库包含多个功能模块，每个模块都提供了特定的图像处理功能。以下是一些常用的模块： Image：用于处理图像文件，提供打开、保存、调整大小、旋转、裁剪、滤镜等功能。 ImageDraw：提供在图像上绘制各种形状（如线条、矩形、圆形）和文本的功能。 ImageFont：用于加载和使用TrueType字体文件，以便在图像上绘制文本时设置字体样式、大小和颜色。 ImageFilter：提供各种滤镜效果，如模糊、锐化、边缘增强等，用于图像增强、特效处理和图像识别等应用。 ImageEnhance：用于调整图像的亮度、对比度、颜色饱和度等参数，使图像更加清晰、明亮或具有特定的调色效果。 高级功能 除了基本的图像处理功能外，Pillow还支持一些高级功能，如色彩空间转换、直方图均衡化等。这些功能可以帮助用户进行更复杂的图像处理和分析。
cykooz.resizer-3.0.0-cp310-cp310-macosx_11_0_arm64.whl
07-27
python库，可以直接安装使用，再也不怕自己pip下载，出现等待超时的现象。欢迎下载使用，使用过程中如有使用问题，请及时与我沟通交流，帮你解决！ python库，可以直接安装使用，再也不怕自己pip下载，出现等待超时的现象。欢迎下载使用，使用过程中如有使用问题，请及时与我沟通交流，帮你解决！ python库，可以直接安装使用，再也不怕自己pip下载，出现等待超时的现象。欢迎下载使用，使用过程中如有使用问题，请及时与我沟通交流，帮你解决！ python库，可以直接安装使用，再也不怕自己pip下载，出现等待超时的现象。欢迎下载使用，使用过程中如有使用问题，请及时与我沟通交流，帮你解决！ python库，可以直接安装使用，再也不怕自己pip下载，出现等待超时的现象。欢迎下载使用，使用过程中如有使用问题，请及时与我沟通交流，帮你解决！
[毕设]Delphi题库管理与试卷自动生成系统.zip
最新发布
07-27
[毕设]Delphi题库管理与试卷自动生成系统
12. Spring Boot可以基于AOP实现指定切面的拦截处理
06-06
是的，Spring Boot可以基于AOP实现指定切面的拦截处理。AOP（面向切面编程）是一种编程范式，可以将与业务逻辑无关的横切关注点（如日志记录、安全控制、性能统计等）通过切面的方式进行集中管理。 在Spring Boot中，可以通过在切面类上使用`@Aspect`注解来标识一个类为切面类，通过在切面类的方法上使用不同的注解（如`@Before`、`@After`、`@Around`等）来指定不同类型的切点拦截处理。 例如，我们可以定义一个切面类`LogAspect`，用于记录所有控制层方法的执行时间和返回结果： ```java @Aspect @Component public class LogAspect { private static final Logger logger = LoggerFactory.getLogger(LogAspect.class); @Around("execution(* com.example.myapp.controller..*.*(..))") public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable { long startTime = System.currentTimeMillis(); Object result = joinPoint.proceed(); long endTime = System.currentTimeMillis(); long executionTime = endTime - startTime; logger.info("{} executed in {} ms, returned: {}", joinPoint.getSignature(), executionTime, result); return result; } } ``` 在上述代码中，`@Aspect`注解标识了`LogAspect`类为切面类，`@Around`注解指定了要拦截的切点为`com.example.myapp.controller`包下的所有方法，`logExecutionTime()`方法用于记录方法的执行时间和返回结果，并将日志输出到控制台中。 当控制层的方法被调用时，如果方法的签名匹配到了切点表达式，那么`LogAspect`类中对应的切面方法（如`logExecutionTime()`）就会被执行，从而实现了对方法的拦截处理。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值