在现代的 Spring 项目中，日志记录是一项常见的需求，特别是对于 API 请求的记录。利用 Spring AOP（面向切面编程），我们能够优雅地实现日志切面，自动记录请求和响应的日志，同时避免暴露敏感数据。本文将详细介绍如何使用 Spring AOP 实现日志切面，并且提供一个完整的示例，包括如何排除敏感字段。
AOP 的核心概念
AOP（面向切面编程，Aspect-Oriented Programming）是一种编程范式，旨在将关注点分离（Separation of Concerns，SoC）引入程序设计中，从而使得程序的各个模块能够更好地解耦。AOP 主要关注横切关注点（cross-cutting concerns）的处理，比如日志记录、事务管理、安全控制等，这些功能通常横跨多个模块。AOP 通过切面（Aspect）来组织这些横切关注点，将其从核心业务逻辑中分离出来，从而提高代码的可重用性和可维护性。
-
切面（Aspect）
切面是 AOP 的核心概念，它可以理解为对横切关注点的封装。一个切面通常包含多个通知（Advice）和连接点（Join Point）。 -
连接点（Join Point）
连接点是程序执行的一个明确位置，通常指的是方法的调用、方法的执行、方法的抛出异常等。 -
通知（Advice）
通知是切面在特定的连接点上要执行的操作。常见的通知类型有：Before：在目标方法执行之前执行。After：在目标方法执行之后执行（无论方法是否正常返回）。AfterReturning：在目标方法成功返回时执行。AfterThrowing：在目标方法抛出异常时执行。Around：在目标方法执行前后都可以自定义操作，通常是最强大的通知类型。
-
切点（Pointcut）
切点定义了哪些连接点需要被切面拦截。可以通过表达式来指定方法匹配规则。 -
目标对象（Target Object）
目标对象是指被增强的类，AOP 会在其方法上插入增强逻辑。 -
代理（Proxy）
代理是 AOP 中的关键组成部分。代理对象负责拦截目标方法的调用，并在方法调用前后执行相应的通知。
AOP的实现方式
AOP 主要通过两种方式来实现：
-
动态代理（Dynamic Proxy）
动态代理是一种在运行时生成代理对象的机制，常见的方式有 JDK 动态代理和 CGLIB 动态代理。- JDK 动态代理：仅对接口进行代理，要求目标类必须实现接口。
- CGLIB 动态代理：通过继承目标类来生成代理类，因此可以代理没有接口的类。
-
静态代理
静态代理是在编译时生成的代理类，代理类通常是由开发者手动编写的。
在 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. 排除敏感字段
步骤
- 确定需要排除的敏感字段：根据业务需求，确定哪些字段需要排除（如
password、phoneNumber、idCard、email等）。 - 使用 FastJSON 的
PropertyPreFilters：FastJSON 提供了PropertyPreFilters类，用于在序列化对象为 JSON 字符串时排除特定字段。 - 在日志切面中实现过滤逻辑：利用过滤器在记录请求参数和返回结果时排除敏感字段。
代码详解
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 和日志切面，我们将请求日志的记录与业务逻辑解耦，避免了在每个控制器方法中重复编写日志代码。这个日志切面能够自动记录每个请求的详细信息，同时避免暴露敏感信息。
优势：
- 解耦：业务逻辑和日志记录解耦，代码更加简洁。
- 复用性：日志记录的代码只需写一次，自动应用于所有目标方法。
- 安全性：能够过滤敏感字段，确保日志中不会泄露用户隐私。
- 可维护性：日志记录逻辑集中在切面中，修改方便，不需要到每个类中修改。
扫一扫
963
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
