百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

Spring Boot使用AOP方式实现统一的Web请求日志记录?

ztj100 2025-05-14 18:29 43 浏览 0 评论

AOP简介

AOP(Aspect Oriented Programming),面相切面编程,是通过代码预编译与运行时动态代理的方式来实现程序的统一功能维护的方案。AOP作为Spring框架的核心内容,通过对程序设置一个切入点,然后在这个切入点上接入不同的执行内容来完成不同的操作。

例如在数据库事务管理方面,用来开启和提交和关闭事务,在记录日志方面,可以在不同的业务处理逻辑中切入日志记录操作。

因为AOP技术只是在切入点上进行工作,并不会破坏原有的程序执行逻辑,所以他对于业务逻辑的影响非常低,从而使得业务逻辑之间的耦合度较低,提升了程序代码的可复用性,同时也提高了开发效率。

下面我们就来介绍一下如何在Spring Boot引入AOP功能并且,通过AOP功能来实现一个Web请求日志处理功能。

准备工作

由于需要用到关于Web请求相关的内容,所以需要在项目中引入Web模块。

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

其次需要实现一个简单的Get请求处理器,如下所示。

@RestController
public class TestController {

    @GetMapping("/test")
    public String test(@RequestParam String name){
        return "Hello World!";
    }
}

引入AOP相关依赖

在做好上面的准备工作之后,接下来就是需要引入AOP模块,如下所示。

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

引入了AOP的依赖之后,并不需要去做一些其他的配置,因为Spring Boot主打的就是自动依赖,自动配置。所以接下来就是需要实现Web层的日志切面。

实现Web层日志切面

在实现AOP切面之前需要知道AOP的几个实现要素

  • 使用@Aspect注解将一个类定义为切面类
  • 使用@Pointcut注解来定义一个切点,并且这里可以指定一个规则表达式,用来匹配某个函数方法,或者是某个包路径等。
  • 根据不同的切点引入不同的切入内容,例如@Before、@After、@AfterReturning、@Around、@AfterThrowing等注解。分别是在前,后、返回前、环绕、报错之后进行操作处理。

编写测试类

@Aspect
@Component
public class WebLogAspect {

    private Logger logger = LoggerFactory.getLogger(WebLogAspect.class);

    @Pointcut("execution(public * com.example.demo..*.*(..))")
    public void webLog(){

    }

    @Before("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()));
    }

    @AfterReturning(returning = "ret",pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable{
        logger.info("请求处理完成");
        logger.info("RESPONS :"+ret);
    }
}

运行程序,在浏览器中输入
http://localhost:8080/test?name=test,进行请求测试,会看到如下输入结果。

总结

到这里,日志切面就算开发完成了,当然,在有些框架中会通过注解的方式来实现日志切面这样的话可以方便在标注了注解的类上有选择性的来实现日志切面,当然在实现日志切面的时候,还需要考虑到系统执行性能的问题。所以可以通过异步的方式来完成日志的记录操作。

相关推荐

人生苦短,我要在VSCode里面用Python

轻沉发自浅度寺量子位出品|公众号QbitAI在程序员圈子里,VisualStudioCode(以下简称VSCode)可以说是目前最火的代码编辑器之一了。它是微软出品的一款可扩展的轻量...

亲测可用:Pycharm2019.3专业版永久激活教程

概述随着2020年的到来,又有一批Pycharm的激活码到期了,各位同仁估计也是在到处搜索激活方案,在这里,笔者为大家收录了一个永久激活的方案,亲测可用,欢迎下载尝试:免责声明本项目只做个人学习研究之...

Python新手入门很简单(python教程入门)

我之前学习python走过很多的歧途,自学永远都是瞎猫碰死耗子一样,毫无头绪。后来心里一直都有一个做头条知识分享的梦,希望自己能够帮助曾经类似自己的人,于是我来了,每天更新5篇Python文章,喜欢的...

Pycharm的设置和基本使用(pycharm运行设置)

这篇文章,主要是针对刚开始学习python语言,不怎么会使用pycharm的童鞋们;我来带领大家详细了解下pycharm页面及常用的一些功能,让大家能通过此篇文章能快速的开始编写python代码。一...

依旧是25年最拔尖的PyTorch实用教程!堪比付费级内容!

我真的想知道作者到底咋把PyTorch教程整得这么牛的啊?明明在内容上已经足以成为付费教材了,但作者偏要免费开源给大家学习!...

手把手教你 在Pytorch框架上部署和测试关键点人脸检测项目DBFace

这期教向大家介绍仅仅1.3M的轻量级高精度的关键点人脸检测模型DBFace,并手把手教你如何在自己的电脑端进行部署和测试运行,运行时bug解决。01.前言前段时间DBFace人脸检测库横空出世,...

进入Python的世界02外篇-Pycharm配置Pyqt6

为什么这样配置,要开发带UI的python也只能这样了,安装过程如下:一安装工具打开终端:pipinstallPyQt6PyQt6-tools二打开设置并汉化点击plugin,安装汉化插件,...

vs code如何配置使用Anaconda(vscode调用anaconda库)

上一篇文章中(Anaconda使用完全指南),我们能介绍了Anaconda的安装和使用,以及如何在pycharm中配置Anaconda。本篇,将继续介绍在vscode中配置conda...

pycharm中conda解释器无法配置(pycharm配置anaconda解释器)

之前用的好好的pycharm正常配置解释器突然不能用了?可以显示有这个环境然后确认后可以conda正在配置解释器,但是进度条结束后还是不成功!!试过了pycharm重启,pycharm重装,anaco...

Volta:跨平台开发者的福音,统一前端js工具链从未如此简单!

我们都知道现在已经进入了Rust时代,不仅很多终端常用的工具都被rust重写了,而且现在很多前端工具也开始被Rust接手了,这不,现在就出现了一款JS工具管理工具,有了它,你可以管理多版本的js工具,...

开发者的福音,ElectronEgg: 新一代桌面应用开发框架

今天给大家介绍一个开源项目electron-egg。如果你是一个JS的前端开发人员,以前面对这项任务桌面应用开发在时,可能会感到无从下手,甚至觉得这是一项困难的挑战。ElectronEgg的出现,它能...

超强经得起考验的低代码开发平台Frappe

#挑战30天在头条写日记#开始进行管理软件的开发来讲,如果从头做起不是不可以,但选择一款免费的且经得起时间考验的低代码开发平台是非常有必要的,将大幅提升代码的质量、加快开发的效率、以及提高程序的扩展性...

一文带你搞懂Vue3 底层源码(vue3核心源码解析)

作者:妹红大大转发链接:https://mp.weixin.qq.com/s/D_PRIMAD6i225Pn-a_lzPA前言vue3出来有一段时间了。今天正式开始记录一下梗vue3.0.0-be...

Windows 11 + WSL2 打造轻量级 Linux 本地开发环境实战教程

一、前言...

基于小程序 DSL(微信、支付宝)的,可扩展的多端研发框架

Mor(发音为/mr/,类似more),是饿了么开发的一款基于小程序DSL的,可扩展的多端研发框架,使用小程序原生DSL构建,使用者只需书写一套(微信或支付宝)小程序,就可以通过Mor...

取消回复欢迎 发表评论: