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

最新推荐文章于 2024-05-23 10:44:20 发布
最新推荐文章于 2024-05-23 10:44:20 发布
阅读量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 313
【代码】SpringBoot 集成使用AOP来记录接口调用的入参和出参。
IDEA的安装配置
yygyj的博客
03-04 2846
原网址：https://www.exception.site/essay/how-to-free-use-intellij-idea-2019-3 资料： 网盘链接: 链接: https://pan.baidu.com/s/1Yhq_7dP0MOayyEJ-g4_27A 密码: ute8 备用链接: 链接: https://pan.baidu.com/s/1qFTDOEZJaVDh2CMipDReLA 密码: sbrw PS: 持续关注，若新版本 IDEA 激活失效，可第一时间获取激活补丁哟 Intelli
Elasticsearch(ES) 添加/更新映射
java_xxxx的博客
09-21 4194
原文地址：https://www.exception.site/elasticsearch/elasticsearch-add-mappings 通过 Elasticsearch API 可以向索引(Index) 添加文档类型(Type), 或者向文档类型(Type) 中添加/更新字段(Field)。 PUT http://127.0.0.1:9200/commodity { "mappings": { "_doc": { "properties": { "commodity_id":
我的私密学习小圈子~
犬小哈
09-24 71
???? 自我介绍大家好，我是小哈。前某厂中台架构，公众号小哈学 Java 作者。91年生人，码龄 9 年，先后供职于支付、共享等互联网领域，主导负责过数据传输、日志中台、任务调度、文件平台等产品，以支撑各部门业务线。喜欢分享知识，热爱技术，也不止于技术，不只是写 Java，业余也爱玩前端、Python、Android 等，是个活跃的技术折腾者。目前，星球内部正在进行第一个实战项目，目前已输出 10w+...
一文教您如何通过 Java 压缩文件，打包一个 tar.gz Filebeat 采集器包
犬小哈
11-12 663
欢迎关注笔者的公众号: 小哈学Java, 专注于推送 Java 领域优质干货文章！！ 个人网站: https://www.exception.site/essay/create-tar-gz-by-java 一、背景 最近，小哈主要在负责日志中台的开发工作, 等等，啥是日志中台？ 俺只知道中台概念，这段时间的确很火，但是日志中台又是用来干啥的？ 这里小哈尽量地通俗的说下日志中台的职责，再说...
如何通过 JavaCSV 类库来优雅地（偷懒）读写 CSV 文件?
犬小哈
04-04 1345
欢迎关注笔者的公众号: 小哈学Java, 专注于推送 Java 领域优质干货文章！！ 个人博客: https://www.exception.site/essay/how-to-create-read-csv-by-javacsv 一、背景 小哈公司最近准备开发一套新的平台，具体什么平台，因为涉密，这里就不透露了。平台在最终的的技术选型中，其中主要依赖的技术栈是 Apache Flink， ...
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请求进行统一的日志记录，从而...
一文带您了解 Elasticsearch 中，如何进行索引管理（图文教程）
犬小哈
09-03 582
欢迎关注笔者的公众号: 小哈学Java, 每日推送 Java 领域干货文章，关注即免费无套路附送 100G 海量学习、面试资源哟！！ 在 Elasticsearch 中，索引是一个非常重要的概念，它是具有相同结构的文档集合。类比关系型数据库，比如 Mysql, 你可以把它对标看成和库同级别的概念。 今天小哈将带着大家了解, 在 Elasticsearch 中，都是如何对索引进行操作的。 目录...
Java初学必备-IntelliJ IDEA下载与安装教程
weixin_54585403的博客
04-13 586
IDEA简介 IDEA 全称 IntelliJ IDEA，是java语言开发的集成环境，IntelliJ在业界被公认为最好的java开发工具之一，尤其在智能代码助手、代码自动提示、重构、J2EE支持、各类版本工具(git、svn、github等)、JUnit、CVS整合、代码分析、 创新的GUI设计等方面的功能可以说是超常的。 Intellij IDEA 最突出的功能自然是调试（Debug)，可以对Java代码，JavaScript，JQuery，Ajax等技术进行调试。 IDEA特点 更好的项目管理方式
盘点16个有用的Java工具类，显著提升工作效率！
犬小哈
08-08 3242
点击上方“小哈学Java”，选择“星标”回复“666”，领取100G独家整理的学习资料哟~来源：http://1t.click/9gK在Java中，工具类定义了一组公共方...
干货文：SpringBoot 配置 AOP 打印请求参数和返回参数
江帅帅
06-25 1831
*实际原理：**在前端请求后端的是后，AOP 会最先起作用。你可以使用 AOP 的 @Before 注解来打印请求参数，@Around 注解打印返回参数，@Pointcut 注解来定义切点。**应用场景：**当我们想要查看前端传的数据是否正确，后端的返回值是否符合前端要求时，就可以打印请求参数和响应参数出来看，这样就有利于前后端对接；**重点说明：**结合使用 fastjson2 对请求对象和返回对象实现序列化打印，再配置相关过滤器，用来过滤敏感信息和无效的过长信息；
Spring AOP实现接口访问日志信息打印
Demon_Hao的博客
10-17 310
通过AOP实现日志打印，可以减少代码量以及提高代码可读性、记录方法的执行时间，方便后续程序的优化、方便发现问题和定位问题。3、切面实现日志打印类。
通过Aop切面打印日志
个人日常记录,分析
11-16 1112
通过Aop切面打印日志
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、付费专栏及课程。

余额充值