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

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

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

总结

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

相关推荐

sharding-jdbc实现`分库分表`与`读写分离`

一、前言本文将基于以下环境整合...

三分钟了解mysql中主键、外键、非空、唯一、默认约束是什么

在数据库中,数据表是数据库中最重要、最基本的操作对象,是数据存储的基本单位。数据表被定义为列的集合,数据在表中是按照行和列的格式来存储的。每一行代表一条唯一的记录,每一列代表记录中的一个域。...

MySQL8行级锁_mysql如何加行级锁

MySQL8行级锁版本:8.0.34基本概念...

mysql使用小技巧_mysql使用入门

1、MySQL中有许多很实用的函数,好好利用它们可以省去很多时间:group_concat()将取到的值用逗号连接,可以这么用:selectgroup_concat(distinctid)fr...

MySQL/MariaDB中如何支持全部的Unicode?

永远不要在MySQL中使用utf8,并且始终使用utf8mb4。utf8mb4介绍MySQL/MariaDB中,utf8字符集并不是对Unicode的真正实现,即不是真正的UTF-8编码,因...

聊聊 MySQL Server 可执行注释,你懂了吗?

前言MySQLServer当前支持如下3种注释风格:...

MySQL系列-源码编译安装(v5.7.34)

一、系统环境要求...

MySQL的锁就锁住我啦!与腾讯大佬的技术交谈,是我小看它了

对酒当歌,人生几何!朝朝暮暮,唯有己脱。苦苦寻觅找工作之间,殊不知今日之事乃我心之痛,难道是我不配拥有工作嘛。自面试后他所谓的等待都过去一段时日,可惜在下京东上的小金库都要见低啦。每每想到不由心中一...

MySQL字符问题_mysql中字符串的位置

中文写入乱码问题:我输入的中文编码是urf8的,建的库是urf8的,但是插入mysql总是乱码,一堆"???????????????????????"我用的是ibatis,终于找到原因了,我是这么解决...

深圳尚学堂:mysql基本sql语句大全(三)

数据开发-经典1.按姓氏笔画排序:Select*FromTableNameOrderByCustomerNameCollateChinese_PRC_Stroke_ci_as//从少...

MySQL进行行级锁的?一会next-key锁,一会间隙锁,一会记录锁?

大家好,是不是很多人都对MySQL加行级锁的规则搞的迷迷糊糊,一会是next-key锁,一会是间隙锁,一会又是记录锁。坦白说,确实还挺复杂的,但是好在我找点了点规律,也知道如何如何用命令分析加...

一文讲清怎么利用Python Django实现Excel数据表的导入导出功能

摘要:Python作为一门简单易学且功能强大的编程语言,广受程序员、数据分析师和AI工程师的青睐。本文系统讲解了如何使用Python的Django框架结合openpyxl库实现Excel...

用DataX实现两个MySQL实例间的数据同步

DataXDataX使用Java实现。如果可以实现数据库实例之间准实时的...

MySQL数据库知识_mysql数据库基础知识

MySQL是一种关系型数据库管理系统;那废话不多说,直接上自己以前学习整理文档:查看数据库命令:(1).查看存储过程状态:showprocedurestatus;(2).显示系统变量:show...

如何为MySQL中的JSON字段设置索引

背景MySQL在2015年中发布的5.7.8版本中首次引入了JSON数据类型。自此,它成了一种逃离严格列定义的方式,可以存储各种形状和大小的JSON文档,例如审计日志、配置信息、第三方数据包、用户自定...

取消回复欢迎 发表评论: