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

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

ztj100 2025-05-14 18:29 2 浏览 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,进行请求测试,会看到如下输入结果。

总结

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

相关推荐

Java项目宝塔搭建实战MES-Springboot开源MES智能制造系统源码

大家好啊,我是测评君,欢迎来到web测评。...

一个令人头秃的问题,Logback 日志级别设置竟然无效?

原文链接:https://mp.weixin.qq.com/s/EFvbFwetmXXA9ZGBGswUsQ原作者:小黑十一点半...

实战!SpringBoot + RabbitMQ死信队列实现超时关单

需求背景之为什么要有超时关单原因一:...

火了!阿里P8架构师编写堪称神级SpringBoot手册,GitHub星标99+

Springboot现在已成为企业面试中必备的知识点,以及企业应用的重要模块。今天小编给大家分享一份来着阿里P8架构师编写的...

Java本地搭建宝塔部署实战springboot仓库管理系统源码

大家好啊,我是测评君,欢迎来到web测评。...

工具尝鲜(1)-Fleet构建运行一个Springboot入门Web项目

Fleet是JetBrains公司推出的轻量级编辑器,对标VSCode。该款产品还在公测当中,具体下载链接如下JetBrainsFleet:由JetBrains打造的下一代IDE。想要尝试的...

SPRINGBOOT WEB 实现文件夹上传(保留目录结构)

网上搜到的SpringBoot的代码不多,完整的不多,能用的也不多,基本上大部分的文章只是提供了少量的代码,讲一下思路,或者实现方案。之前一般的做法都是使用HTML5来做的,大部都是传文件的,传文件夹...

Java项目本地部署宝塔搭建实战报修小程序springboot版系统源码

大家好啊,我是测评君,欢迎来到web测评。...

新年IT界大笑料“工行取得基于SpringBoot的web系统后端实现专利

先看看专利描述...

看完SpringBoot源码后,整个人都精神了

前言当读完SpringBoot源码后,被Spring的设计者们折服,Spring系列中没有几行代码是我们看不懂的,而是难在理解设计思路,阅读Spring、SpringMVC、SpringBoot需要花...

阿里大牛再爆神著:SpringBoot+Cloud微服务手册

今天给大家分享的这份“Springboot+Springcloud微服务开发实战手册”共有以下三大特点...

WebClient是什么?SpringBoot中如何使用WebClient?

WebClient是什么?WebClient是SpringFramework5引入的一个非阻塞、响应式的Web客户端库。它提供了一种简单而强大的方式来进行HTTP请求,并处理来自服务器的响应。与传...

SpringBoot系列——基于mui的H5套壳APP开发web框架

  前言  大致原理:创建一个main主页面,只有主页面有头部、尾部,中间内容嵌入iframe内容子页面,如果在当前页面进行跳转操作,也是在iframe中进行跳转,而如果点击尾部按钮切换模块、页面,那...

在Spring Boot中使用 jose4j 实现 JSON Web Token (JWT)

JSONWebToken或JWT作为服务之间安全通信的一种方式而闻名。...

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

AOP简介AOP(AspectOrientedProgramming),面相切面编程,是通过代码预编译与运行时动态代理的方式来实现程序的统一功能维护的方案。AOP作为Spring框架的核心内容,通...

取消回复欢迎 发表评论: