前言

在開發企業級應用時，完善的日志記錄系統對于問題排查、系統監控和用戶行為分析都至關重要。傳統的日志記錄方式往往需要在每個方法中手動添加日志代碼，這不僅增加了代碼量，也使得業務邏輯與日志記錄代碼耦合在一起。Spring
AOP（面向切面編程）為我們提供了一種優雅的解決方案，可以無侵入式地實現日志記錄功能。

本文將詳細介紹如何在SpringBoot項目中利用AOP實現統一的日志記錄功能。

一、AOP基本概念

在開始實現之前，我們先了解幾個AOP的核心概念：

• 切面（Aspect）：橫切關注點的模塊化，如日志記錄就是一個切面

• 連接點（Joinpoint）：程序執行過程中的某個特定點，如方法調用或異常拋出

• 通知（Advice）：在切面的某個連接點上執行的動作

• 切入點（Pointcut）：匹配連接點的謂詞，用于確定哪些連接點需要執行通知

• 目標對象（Target Object）：被一個或多個切面通知的對象

二、項目準備

需要創建一個SpringBoot項目，添加以下依賴：

<dependencies><!-- Spring Boot Starter Web --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- Spring Boot Starter AOP --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency><!-- Lombok 簡化代碼 --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency>
</dependencies>

三、實現日志記錄切面

1、創建自定義日志注解

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {/*** 操作名稱* @return*/String operation() default "";/*** 操作的類型* @return*/BusinessType businessType() default BusinessType.OTHER;
}

2、實現日志切面

創建一個切面類，實現日志切面功能。

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.Arrays;@Aspect
@Component
public class LoggingAspect {private static final Logger logger = LoggerFactory.getLogger(LoggingAspect.class);/*** 定義切入點：所有帶有@Loggable注解的方法*/@Pointcut("@annotation(com.yourpackage.Loggable)")public void loggableMethods() {}/*** 環繞通知：記錄方法執行前后的日志*/@Around("loggableMethods()")public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {MethodSignature signature = (MethodSignature) joinPoint.getSignature();Method method = signature.getMethod();Loggable loggable = method.getAnnotation(Loggable.class);String methodName = joinPoint.getTarget().getClass().getName() + "." + method.getName();// 記錄方法開始日志if (loggable.recordParams()) {logger.info("===> 開始執行 {}，參數: {}", methodName, Arrays.toString(joinPoint.getArgs()));} else {logger.info("===> 開始執行 {}", methodName);}long startTime = System.currentTimeMillis();try {// 執行目標方法Object result = joinPoint.proceed();// 記錄方法結束日志long elapsedTime = System.currentTimeMillis() - startTime;if (loggable.recordResult()) {logger.info("<=== 執行完成 {}，耗時: {}ms，結果: {}", methodName, elapsedTime, result);} else {logger.info("<=== 執行完成 {}，耗時: {}ms", methodName, elapsedTime);}return result;} catch (Exception e) {// 記錄異常日志long elapsedTime = System.currentTimeMillis() - startTime;logger.error("<=== 執行異常 {}，耗時: {}ms，異常: {}", methodName, elapsedTime, e.getMessage(), e);throw e;}}/*** 對Controller層的方法進行日志記錄*/@Pointcut("execution(* com.yourpackage.controller..*.*(..))")public void controllerLog() {}@Before("controllerLog()")public void doBefore(JoinPoint joinPoint) {// 獲取請求信息ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();if (attributes == null) {return;}HttpServletRequest request = attributes.getRequest();// 記錄請求信息logger.info("==============================請求開始==============================");logger.info("請求URL: {}", request.getRequestURL().toString());logger.info("HTTP方法: {}", request.getMethod());logger.info("IP地址: {}", request.getRemoteAddr());logger.info("類方法: {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());logger.info("請求參數: {}", Arrays.toString(joinPoint.getArgs()));}@AfterReturning(returning = "result", pointcut = "controllerLog()")public void doAfterReturning(Object result) {logger.info("返回結果: {}", result);logger.info("==============================請求結束==============================");}
}

3、配置AOP

確保SpringBoot應用啟用了AOP支持（默認就是啟用的），如果需要自定義配置，可以在application.properties中添加。

# AOP配置
spring.aop.auto=true
spring.aop.proxy-target-class=true

四、使用示例

1. 在Controller中使用

@RestController
@RequestMapping("/api/user")
public class UserController {@GetMapping("/{id}")@Loggable("根據ID獲取用戶信息")public User getUser(@PathVariable Long id) {// 業務邏輯return userService.getUserById(id);}@PostMapping@Loggable(value = "創建新用戶", recordParams = false)public User createUser(@RequestBody User user) {// 業務邏輯return userService.createUser(user);}
}

2. 在Service中使用

@Service
public class UserService {@Loggable("根據ID查詢用戶")public User getUserById(Long id) {// 業務邏輯}@Loggable(value = "創建用戶", recordResult = false)public User createUser(User user) {// 業務邏輯}
}

六、高級配置

1. 日志內容格式化

我們可以創建一個工具類來美化日志輸出：

public class LogFormatUtils {public static String formatMethodCall(String className, String methodName, Object[] args) {StringBuilder sb = new StringBuilder();sb.append(className).append(".").append(methodName).append("(");if (args != null && args.length > 0) {for (int i = 0; i < args.length; i++) {if (i > 0) {sb.append(", ");}sb.append(formatArg(args[i]));}}sb.append(")");return sb.toString();}private static String formatArg(Object arg) {if (arg == null) {return "null";}// 對于基本類型和字符串直接返回if (arg instanceof Number || arg instanceof Boolean || arg instanceof Character || arg instanceof String) {return arg.toString();}// 對于集合和數組，只顯示大小if (arg.getClass().isArray()) {return "array[" + Array.getLength(arg) + "]";}if (arg instanceof Collection) {return "collection[" + ((Collection<?>) arg).size() + "]";}if (arg instanceof Map) {return "map[" + ((Map<?, ?>) arg).size() + "]";}// 其他復雜對象只顯示類名return arg.getClass().getSimpleName();}
}

然后在切面中使用：

@Around("loggableMethods()")
public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {MethodSignature signature = (MethodSignature) joinPoint.getSignature();String methodCall = LogFormatUtils.formatMethodCall(joinPoint.getTarget().getClass().getSimpleName(),signature.getName(),joinPoint.getArgs());logger.info("===> 調用: {}", methodCall);// ... 其他邏輯
}

2. 異步日志記錄

對于一些并發場景，可以考慮異步記錄日志以減少性能影響：

@Configuration
@EnableAsync
public class AsyncConfig implements AsyncConfigurer {@Overridepublic Executor getAsyncExecutor() {ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();executor.setCorePoolSize(5);executor.setMaxPoolSize(10);executor.setQueueCapacity(100);executor.setThreadNamePrefix("AsyncLogger-");executor.initialize();return executor;}
}// 然后在切面方法上添加@Async注解
@Async
@Around("loggableMethods()")
public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {// 日志記錄邏輯
}

3. 日志脫敏處理

對于敏感信息如手機號、身份證號等，需要進行脫敏處理：

public class SensitiveInfoUtils {private static final String PHONE_REGEX = "(\\d{3})\\d{4}(\\d{4})";private static final String ID_CARD_REGEX = "(\\d{4})\\d{10}(\\w{4})";public static String desensitize(Object arg) {if (arg == null) {return null;}String str = arg.toString();// 手機號脫敏if (str.matches("\\d{11}")) {return str.replaceAll(PHONE_REGEX, "$1****$2");}// 身份證號脫敏if (str.matches("\\d{18}|\\d{17}[xX]")) {return str.replaceAll(ID_CARD_REGEX, "$1**********$2");}// 其他敏感信息處理...return str;}
}// 在LogFormatUtils中使用
private static String formatArg(Object arg) {// ... 其他邏輯return SensitiveInfoUtils.desensitize(arg);
}

七、代理類生成的核心邏輯

問題1： 既然是代理類，那么像@Transaction 注解標注在方法上怎么搞？給方法生成代理類？（顯然不是）

@Transactional 雖然通常標注在方法上，但 Spring 的代理生成策略會綜合考慮 類級別和方法級別 的注解。
以下是其完整工作原理：
Spring 處理 @Transactional 時，代理生成分為兩步：

步驟 1：掃描 Bean 的代理需求

• 類級別檢查：Spring 在創建 Bean 時，會檢查 類或父類 是否有 @Transactional 注解（類級別注解會影響所有方法）。

• 方法級別檢查：如果類未被注解，則掃描所有 公有方法（public），發現任意方法有 @Transactional 時，整個類會被代理。

步驟 2：生成代理對象

• JDK 動態代理：如果類實現了接口，默認使用 JDK 代理（基于 InvocationHandler）。

• CGLIB 代理：如果類未實現接口，則生成子類代理（通過字節碼增強）。

問題2：自定義的注解@LogExecutionTime，也會生成代理類嗎？

自定義的注解 @LogExecutionTime 是否會生成代理類，取決于如何實現這個注解的功能。如果通過 Spring AOP 來實現 @LogExecutionTime 的功能（例如記錄方法執行時間），那么確實會生成代理類。比如下面的代碼

//自定義一個注解
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME) // 注解在運行時保留
@Target(ElementType.METHOD) // 注解可以應用于方法
public @interface LogExecutionTime {
}//定義切面類,使用 @Aspect 注解標記，并在其中定義切點（Pointcut）和通知（Advice）。
//切點通過 @annotation(LogExecutionTime) 匹配所有帶有 @LogExecutionTime 注解的方法。
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;@Aspect // 聲明這是一個切面類
@Component // 確保切面類被 Spring 容器管理
public class LogExecutionTimeAspect {// 定義環繞通知，匹配所有帶有 @LogExecutionTime 注解的方法@Around("@annotation(LogExecutionTime)")public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {long startTime = System.currentTimeMillis(); // 記錄方法開始執行時間// 執行目標方法Object result = joinPoint.proceed();long executionTime = System.currentTimeMillis() - startTime; // 計算方法執行時間// 輸出日志System.out.println("Method " + joinPoint.getSignature().getName() + " executed in " + executionTime + "ms");return result; // 返回目標方法的執行結果}
}//在業務方法上面使用這個自定義注解
@Service
public class MyService {@LogExecutionTime // 標記需要記錄執行時間的方法public void myBusinessMethod() {// 模擬業務邏輯try {Thread.sleep(1000); // 模擬耗時操作} catch (InterruptedException e) {e.printStackTrace();}System.out.println("Business logic executed.");}
}

那么生成代理類的流程是這樣的，

1. 切面類注冊：Spring 掃描到 @Aspect 標注的類（如 LogExecutionTimeAspect ngAspect），將其注冊為 Bean，并識別其中的切點和通知。（切面類不生成代理類）
2. 接著根據切點，再掃描符合條件的bean，**@annotation(LogExecutionTime)**所有帶有 @LogExecutionTime 注解的方法所在的類對應的bean都會生成代理類。

八、具體執行步驟

給符合條件的bean，生成代理類之后，就要開始執行了，由于不確定是哪一個方法加了@Transactional這種所謂的aop注解，所以代理類，會對每一個方法進行檢查。具體步驟如下：

步驟 1：調用代理對象的方法

// 這里實際調用的是代理對象的方法，代理對象會去調用目標對象的原方法
userService.getUserById(1L);

步驟 2：代理對象檢查方法是否匹配切點

檢查目標方法：代理對象會檢查 UserService.getUserById() 是否匹配切面定義的切點（即是否有 @LogExecutionTime 注解）。

// 偽代碼：Spring 的切點匹配邏輯
if (方法有 @LogExecutionTime 注解 || 類有 @LogExecutionTime 注解) {將該方法加入攔截鏈;
}

步驟 3：執行攔截鏈

如果方法匹配切點，代理對象會：

找到所有匹配的 Advice（如 @Around 通知）。

按順序執行通知鏈（如先執行 @Before，再執行 @Around）。

在 @Around 中，通過 ProceedingJoinPoint.proceed() 調用原始方法。