Spring AOP 实现日志切面

在现代的 Spring 项目中，日志记录是一项常见的需求，特别是对于 API 请求的记录。利用 Spring AOP（面向切面编程），我们能够优雅地实现日志切面，自动记录请求和响应的日志，同时避免暴露敏感数据。本文将详细介绍如何使用 Spring AOP 实现日志切面，并且提供一个完整的示例，包括如何排除敏感字段。

AOP 的核心概念

AOP（面向切面编程，Aspect-Oriented Programming）是一种编程范式，旨在将关注点分离（Separation of Concerns，SoC）引入程序设计中，从而使得程序的各个模块能够更好地解耦。AOP 主要关注横切关注点（cross-cutting concerns）的处理，比如日志记录、事务管理、安全控制等，这些功能通常横跨多个模块。AOP 通过切面（Aspect）来组织这些横切关注点，将其从核心业务逻辑中分离出来，从而提高代码的可重用性和可维护性。

  1. 切面（Aspect）
    切面是 AOP 的核心概念，它可以理解为对横切关注点的封装。一个切面通常包含多个通知（Advice）和连接点（Join Point）。

  2. 连接点（Join Point）
    连接点是程序执行的一个明确位置，通常指的是方法的调用、方法的执行、方法的抛出异常等。

  3. 通知（Advice）
    通知是切面在特定的连接点上要执行的操作。常见的通知类型有：

    • Before：在目标方法执行之前执行。
    • After：在目标方法执行之后执行（无论方法是否正常返回）。
    • AfterReturning：在目标方法成功返回时执行。
    • AfterThrowing：在目标方法抛出异常时执行。
    • Around：在目标方法执行前后都可以自定义操作，通常是最强大的通知类型。

  4. 切点（Pointcut）
    切点定义了哪些连接点需要被切面拦截。可以通过表达式来指定方法匹配规则。

  5. 目标对象（Target Object）
    目标对象是指被增强的类，AOP 会在其方法上插入增强逻辑。

  6. 代理（Proxy）
    代理是 AOP 中的关键组成部分。代理对象负责拦截目标方法的调用，并在方法调用前后执行相应的通知。

AOP的实现方式

AOP 主要通过两种方式来实现：

  1. 动态代理（Dynamic Proxy）
    动态代理是一种在运行时生成代理对象的机制，常见的方式有 JDK 动态代理和 CGLIB 动态代理。

    • JDK 动态代理：仅对接口进行代理，要求目标类必须实现接口。
    • CGLIB 动态代理：通过继承目标类来生成代理类，因此可以代理没有接口的类。

  2. 静态代理
    静态代理是在编译时生成的代理类，代理类通常是由开发者手动编写的。

在 Spring 中使用 AOP

1. 引入依赖

要使用 Spring AOP，我们需要引入 AOP 相关的依赖。如果你使用的是 Spring Boot，可以通过引入 spring-boot-starter-aop 来快速集成 AOP 功能。

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

2. 创建日志切面类（LogAspect）

接下来，我们会创建一个日志切面类，使用 AOP 拦截 Controller 层的所有请求，并记录请求信息（如请求地址、请求方法、请求参数等）和响应信息。

2.1 标注 @Aspect 注解

@Aspect 注解标记当前类为切面类，表示它将包含 AOP 相关的逻辑。

2.2 定义切点（@Pointcut）

切点是用来匹配需要拦截的方法。在日志切面的例子中，我们希望拦截所有 Controller 层的公共方法。通过 @Pointcut 注解定义切点，通常使用表达式来匹配方法。

2.3 定义通知（@Before 和 @Around）

在切面类中，我们定义具体的通知，例如：

  • 前置通知（@Before）：在目标方法执行之前记录日志。
  • 环绕通知（@Around）：在目标方法执行前后进行操作，记录响应时间等信息。

3. 具体实现

3.1 日志切面类的代码实现
package com.stu.train.common.aspect;import cn.hutool.core.util.RandomUtil;
import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.support.spring.PropertyPreFilters;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.http.HttpServletRequest;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.multipart.MultipartFile;@Aspect
@Component
public class LogAspect {private static final Logger LOG = LoggerFactory.getLogger(LogAspect.class);/*** 定义一个切点，匹配 Controller 层的所有公共方法*/@Pointcut("execution(public * com.stu..*Controller.*(..))")public void controllerPointcut() {}/*** 前置通知：在目标方法执行之前记录请求信息*/@Before("controllerPointcut()")public void doBefore(JoinPoint joinPoint) {// 生成一个唯一的日志ID，方便追踪日志MDC.put("LOG_ID", System.currentTimeMillis() + RandomUtil.randomString(3));// 获取当前请求的信息ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();HttpServletRequest request = attributes.getRequest();Signature signature = joinPoint.getSignature();String methodName = signature.getName();// 打印请求的基本信息LOG.info("------------- 开始 -------------");LOG.info("请求地址: {} {}", request.getRequestURL(), request.getMethod());LOG.info("类名方法: {}.{}", signature.getDeclaringTypeName(), methodName);LOG.info("远程地址: {}", request.getRemoteAddr());// 获取请求参数并排除特殊类型的参数，如文件类型Object[] args = joinPoint.getArgs();Object[] arguments = new Object[args.length];for (int i = 0; i < args.length; i++) {if (args[i] instanceof ServletRequest || args[i] instanceof ServletResponse || args[i] instanceof MultipartFile) {continue;}arguments[i] = args[i];}// 排除敏感字段，如密码、手机号等String[] excludeProperties = {"password", "phoneNumber", "idCard", "email"};PropertyPreFilters filters = new PropertyPreFilters();PropertyPreFilters.MySimplePropertyPreFilter excludefilter = filters.addFilter();excludefilter.addExcludes(excludeProperties);LOG.info("请求参数: {}", JSONObject.toJSONString(arguments, excludefilter));}/*** 环绕通知：在方法执行前后记录耗时并输出返回结果*/@Around("controllerPointcut()")public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {// 记录方法开始执行的时间long startTime = System.currentTimeMillis();// 执行目标方法Object result = proceedingJoinPoint.proceed();// 计算方法执行的时间long elapsedTime = System.currentTimeMillis() - startTime;// 排除敏感字段并记录返回结果String[] excludeProperties = {"password", "phoneNumber", "idCard", "email"};PropertyPreFilters filters = new PropertyPreFilters();PropertyPreFilters.MySimplePropertyPreFilter excludefilter = filters.addFilter();excludefilter.addExcludes(excludeProperties);LOG.info("返回结果: {}", JSONObject.toJSONString(result, excludefilter));// 打印方法执行的耗时LOG.info("------------- 结束 耗时：{} ms -------------", elapsedTime);return result;}
}

4. 解释代码

4.1 切点表达式（Pointcut）
@Pointcut("execution(public * com.stu..*Controller.*(..))")
  • execution(public * com.stu..*Controller.*(..))：这个表达式用于匹配 com.stu 包及其子包中的所有 Controller 类的公共方法。(..) 表示匹配任何参数。
4.2 前置通知（@Before）
@Before("controllerPointcut()")
public void doBefore(JoinPoint joinPoint)

  • @Before 注解表示在目标方法执行之前执行通知。我们通过 joinPoint.getArgs() 获取方法的参数，并过滤掉一些不需要记录的类型，如 ServletRequest、ServletResponse 和 MultipartFile（文件上传）。

  • PropertyPreFilters 用于过滤敏感字段，确保日志中不会输出密码、手机号等敏感信息。

4.3 环绕通知（@Around）
@Around("controllerPointcut()")
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable
  • @Around 注解是 Spring AOP 中最强大的通知类型，允许你在方法执行之前和执行之后进行操作。我们用它来记录方法的执行时间，并在方法执行完毕后记录返回结果。
  • proceedingJoinPoint.proceed() 执行目标方法，并返回结果。
4.4 日志输出

日志记录通过 LOG.info() 输出请求和响应的相关信息。日志内容包括：

  • 请求的 URL、请求方法、请求的类和方法名、远程地址。
  • 请求参数（过滤掉敏感字段）。
  • 返回结果（同样过滤敏感字段）。
  • 方法执行的耗时。

5. 排除敏感字段

步骤
  1. 确定需要排除的敏感字段：根据业务需求，确定哪些字段需要排除（如 password、phoneNumber、idCard、email 等）。
  2. 使用 FastJSON 的 PropertyPreFilters：FastJSON 提供了 PropertyPreFilters 类，用于在序列化对象为 JSON 字符串时排除特定字段。
  3. 在日志切面中实现过滤逻辑：利用过滤器在记录请求参数和返回结果时排除敏感字段。
代码详解
String[] excludeProperties = {"password", "phoneNumber", "idCard", "email"};
PropertyPreFilters filters = new PropertyPreFilters();
PropertyPreFilters.MySimplePropertyPreFilter excludefilter = filters.addFilter();
excludefilter.addExcludes(excludeProperties);
  • excludeProperties：定义需要排除的敏感字段。
  • PropertyPreFilters.MySimplePropertyPreFilter：创建一个过滤器，利用 addExcludes() 方法添加需要排除的字段。

在记录日志时，使用

该过滤器确保敏感字段不出现在日志中。

6. 总结：AOP 日志切面的优势

通过 AOP 和日志切面，我们将请求日志的记录与业务逻辑解耦，避免了在每个控制器方法中重复编写日志代码。这个日志切面能够自动记录每个请求的详细信息，同时避免暴露敏感信息。

优势：
  • 解耦：业务逻辑和日志记录解耦，代码更加简洁。
  • 复用性：日志记录的代码只需写一次，自动应用于所有目标方法。
  • 安全性：能够过滤敏感字段，确保日志中不会泄露用户隐私。
  • 可维护性：日志记录逻辑集中在切面中，修改方便，不需要到每个类中修改。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.xdnf.cn/news/15120.html

如若内容造成侵权/违法违规/事实不符，请联系一条长河网进行投诉反馈，一经查实，立即删除！

相关文章

【Chapter 3】Machine Learning Classification Case_Prediction of diabetes-XGBoost

【Chapter 3】Machine Learning Classification Case_Prediction of diabetes-XGBoost

文章目录 1、XGBoost Algorithm2、Comparison of algorithm implementation between Python code and Sentosa_DSML community edition(1) Data reading and statistical analysis(2)Data preprocessing(3)Model Training and Evaluation(4)Model visualization 3、summarize 1…
阅读更多...
Java学习——Day12

Java学习——Day12

多态指的是同一个方法不同对象调用会有不同的行为&#xff0c;多态是方法的多态&#xff0c;属性没有多态&#xff0c;多态要有继承和重写。 这就是多态&#xff0c;其实原理也很简单&#xff0c;就是利用继承方法的重写实现的 对象的转型 向上转型&#xff1a;子类转成父类&…
阅读更多...
AI生成字幕模型whisper介绍与使用

AI生成字幕模型whisper介绍与使用

文章目录 前言一、whisper介绍二、预训练模型下载与环境配置三、推理 前言 随着人工智能技术的飞速发展&#xff0c;AI生成字幕模型已成为视频内容创作和传播领域的重要工具。其中&#xff0c;OpenAI推出的Whisper模型以其卓越的性能和广泛的应用场景&#xff0c;受到了广大用…
阅读更多...
计算机毕业设计 | SpringBoot社区物业管理系统 小区管理(附源码)

计算机毕业设计 | SpringBoot社区物业管理系统 小区管理(附源码)

1&#xff0c; 概述 1.1 课题背景 近几年来&#xff0c;随着物业相关的各种信息越来越多&#xff0c;比如报修维修、缴费、车位、访客等信息&#xff0c;对物业管理方面的需求越来越高&#xff0c;我们在工作中越来越多方面需要利用网页端管理系统来进行管理&#xff0c;我们…
阅读更多...
4G与lora DTU农业监测应用数字化管理升级

4G与lora DTU农业监测应用数字化管理升级

农业监测的数字化管理升级&#xff0c;通过采用4G和LoRa等无线技术&#xff0c;解决渔业养殖、畜牧管理、农业灌溉以及远程监测等领域的互联互通。 渔业养殖水质监测 在渔业养殖中4G DTU通过采集各种水质传感器进行水质监测&#xff0c;4G DTU能够实时监测养殖水体的温度、pH值…
阅读更多...
GA/T1400视图库平台EasyCVR视频融合平台HLS视频协议是什么？

GA/T1400视图库平台EasyCVR视频融合平台HLS视频协议是什么？

在数字化时代&#xff0c;视频监控系统已成为保障安全、提升效率的关键技术。EasyCVR视频融合云平台&#xff0c;作为TSINGSEE青犀视频在“云边端”架构体系中的重要一环&#xff0c;专为大中型项目设计&#xff0c;提供了一个跨区域、网络化的视频监控综合管理系统平台。它不仅…
阅读更多...
maven工程修改jdk编译版本的几种方法

maven工程修改jdk编译版本的几种方法

一.背景 maven工程修改jdk编译版本的几种方法&#xff0c;以前这些小细节处理了就处理了&#xff0c;没有去记录&#xff0c;现在带徒弟&#xff0c;就写下吧&#xff01;可能不全面&#xff0c;不喜勿喷。哦&#xff0c;说下&#xff0c;本文的例子是在eclipse中开发截图的。 …
阅读更多...
详细介绍Transformer！

详细介绍Transformer！

&#x1f917;Transformer是一种神经网络架构&#xff0c;核心思想是利用自注意力机制来捕捉序列中元素之间的关系。从而避免了传统RNN难以处理长序列依赖的问题。 Transformer的主要组件和流程 &#x1f4ab;Encoder-Decoder结构 Transformer包含编码器和解码器两个主要部分…
阅读更多...
中国车牌分类

中国车牌分类

从颜色和单双层分类(不考虑临时车牌) 黄单黄双黄绿单蓝单蓝双绿单绿双黑单黑双白单白双 #特殊文字 挂使港澳学警领临
阅读更多...
【4060显卡也能跑高质量的Flux模型了吗】MIT Han 实验室开源了一个Flux的量化项目——SVDQuant

【4060显卡也能跑高质量的Flux模型了吗】MIT Han 实验室开源了一个Flux的量化项目——SVDQuant

麻省理工学院&#xff08;MIT&#xff09;Han 实验室一直在积极开展一系列项目&#xff0c;包括微小机器学习&#xff08;Tiny Machine Learning&#xff09;、SANA、SVDQuant 和 QServe&#xff0c;这些项目旨在提高人工智能计算的效率&#xff0c;并实现在边缘设备上的高效部…
阅读更多...
基于Java Springboot学生管理系统

基于Java Springboot学生管理系统

一、作品包含 源码数据库全套环境和工具资源部署教程 二、项目技术 前端技术&#xff1a;Html、Css、Js、Vue 数据库&#xff1a;MySQL 后端技术&#xff1a;Java、Spring Boot、MyBatis 三、运行环境 开发工具&#xff1a;IDEA 数据库&#xff1a;MySQL5.7 数据库管理…
阅读更多...
DELL Precision 系列默认用的都是非ECC内存

DELL Precision 系列默认用的都是非ECC内存

文章目录 DELL Precision 系列默认用的都是非ECC内存概述SSD升级SSD1SSD2 笔记DELL Precision 系列默认用的都是非ECC内存可以选非ECC的内存 备注备注如果不差钱备注END DELL Precision 系列默认用的都是非ECC内存 概述 去了一次DELL维修中心&#xff0c;清了一次灰。人工真贵…
阅读更多...
Linux基础（2）以及资源耗尽病毒的编写（详见B站泷羽sec）

Linux基础（2）以及资源耗尽病毒的编写（详见B站泷羽sec）

免责声明&#xff1a;本教程作者及相关参与人员对于任何直接或间接使用本教程内容而导致的任何形式的损失或损害&#xff0c;包括但不限于数据丢失、系统损坏、个人隐私泄露或经济损失等&#xff0c;不承担任何责任。所有使用本教程内容的个人或组织应自行承担全部风险。 Linux…
阅读更多...
20241114软考架构-------软考案例15答案

20241114软考架构-------软考案例15答案

每日打卡题案例15答案 15.【2016年真题】 难度&#xff1a;一般 阅读以下关于应用服务器的叙述&#xff0c;在答题纸上回答问题1至问题3。&#xff08;25分&#xff09; 【说明】 某电子产品制造公司&#xff0c;几年前开发建设了企业网站系统&#xff0c;实现了企业宣传、产品…
阅读更多...
【LeetCode】每日一题 2024_11_14 统计好节点的数目（图/树的 DFS）

【LeetCode】每日一题 2024_11_14 统计好节点的数目（图/树的 DFS）

前言 每天和你一起刷 LeetCode 每日一题~ LeetCode 启动&#xff01; 题目&#xff1a;统计好节点的数目 代码与解题思路 先读题&#xff1a;题目要求我们找出好节点的数量&#xff0c;什么是好节点&#xff1f;“好节点的所有子节点的数量都是相同的”&#xff0c;拿示例一…
阅读更多...
HarmonyOs DevEco Studio小技巧29--ArkTS文字如何渐变

HarmonyOs DevEco Studio小技巧29--ArkTS文字如何渐变

这是需求 昨天想了老多方法 一开始以为加上线性渐变这个属性就好了 Entry Component struct TextTest {State message: string 中华人民共和国万岁;build() {RelativeContainer() {Text(this.message).id(TextTestHelloWorld).fontSize(33).fontWeight(FontWeight.Bold).alig…
阅读更多...
块设备 - 想进阶的必经之路！

块设备 - 想进阶的必经之路！

在Linux内核开发的世界中&#xff0c;块设备&#xff08;Block Device&#xff09;是一块不可忽视的领域。它承载了文件系统的运行&#xff0c;管理着磁盘存储的核心逻辑&#xff0c;是初学者迈向内核进阶的重要知识点。本篇文章将用通俗易懂的语言&#xff0c;为你揭开块设备的…
阅读更多...
高鑫零售实现扭亏为盈，逆市增长的高鑫零售未来何在？

高鑫零售实现扭亏为盈，逆市增长的高鑫零售未来何在？

大润发母公司高鑫零售发布截至9月30日的2025财年中期业绩报告&#xff1a;营收347.08亿元人民币&#xff0c;税后溢利1.86亿元&#xff0c;同比增加5.64亿元&#xff0c;实现扭亏为盈&#xff0c;高鑫零售的成绩单我们该如何分析&#xff1f; 首先&#xff0c;整体来看&#x…
阅读更多...
AI绘画如何赚钱？分享5个简单，易上手的实用性案例

AI绘画如何赚钱？分享5个简单，易上手的实用性案例

近年来&#xff0c;人工智能&#xff08;AI&#xff09;技术在各个领域都取得了巨大的突破&#xff0c;其中之一就是AI绘画。通过分享一些令人兴奋的应用与变现案例&#xff0c;我们可以深入了解AI绘画的实际应用&#xff0c;以及它如何改变了传统艺术创作和商业模式。 在接下…
阅读更多...
如何在 Ubuntu 上安装 RStudio IDE（R语言集成开发环境） ?

如何在 Ubuntu 上安装 RStudio IDE（R语言集成开发环境） ?

RStudio 是一个功能强大的 R 语言集成开发环境(IDE)&#xff0c;R 是一种主要用于统计计算和数据分析的编程语言。任何从事数据科学项目或任何其他涉及 R 的类似任务的人&#xff0c;RStudio 都可以使您的工作更轻松。 本指南将引导您完成在 Ubuntu 系统上安装 RStudio 的过程…
阅读更多...
最新文章

Copyright @ 2022~2023