Spring AOP 实现日志记录 | Baeldung中文网

1. 概述

我们经常使用日志来记录程序执行过程中的关键步骤和有价值的信息。这些日志数据可用于后续的代码调试和分析。

此外，面向切面编程（AOP）是一种编程范式，它允许我们将横切关注点（如事务管理或日志记录）与业务逻辑分离，避免代码混乱。

本文将介绍如何使用Spring AOP框架实现日志记录功能。

2. 传统日志记录的痛点

通常我们会在方法的开头和结尾添加日志，以便跟踪应用执行流程，同时捕获方法参数和返回值：

public String greet(String name) {
    logger.debug(">> greet() - {}", name);
    String result = String.format("Hello %s", name);
    logger.debug("<< greet() - {}", result);
    return result;
}

虽然这种实现看似标准，但日志语句会污染业务代码。更糟糕的是，它增加了代码复杂度——如果没有日志需求，这个方法本可以简化为一行：

public String greet(String name) {
    return String.format("Hello %s", name);
}

3. 面向切面编程（AOP）

AOP的核心思想是关注"切面"而非对象和类。我们使用AOP在不修改现有代码的情况下，为特定功能添加额外行为。

3.1 AOP核心概念

先快速了解几个关键术语：

切面（Aspect）：需要贯穿应用的横切关注点（如日志）
连接点（Join Point）：程序执行过程中可以插入切面的点
通知（Advice）：在特定连接点执行的动作
切入点（Pointcut）：匹配连接点的表达式集合

⚠️ 注意：Spring AOP仅支持方法执行级别的连接点。如需字段、构造器等更细粒度的控制，应使用AspectJ等编译时库。

3.2 Maven依赖

添加spring-boot-starter-aop依赖：

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

4. 使用AOP实现日志记录

通过@Aspect注解创建切面类：

@Aspect
@Component
public class LoggingAspect {
}

@Aspect仅是标记注解，需配合@Component使Spring管理该Bean。

定义切入点表达式：

@Pointcut("execution(public * com.baeldung.logging.*.*(..))")
private void publicMethodsFromLoggingPackage() {
}

此表达式匹配com.baeldung.logging包下所有public方法。

4.1 使用环绕通知

环绕通知（@Around）允许在方法执行前后添加自定义逻辑，甚至控制是否执行目标方法：

@Around(value = "publicMethodsFromLoggingPackage()")
public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
    Object[] args = joinPoint.getArgs();
    String methodName = joinPoint.getSignature().getName();
    logger.debug(">> {}() - {}", methodName, Arrays.toString(args));
    Object result = joinPoint.proceed();
    logger.debug("<< {}() - {}", methodName, result);
    return result;
}

关键点说明：

ProceedingJoinPoint提供proceed()方法执行目标方法
getArgs()获取方法参数
getSignature().getName()获取方法名

测试调用：

@Test
void givenName_whenGreet_thenReturnCorrectResult() {
    String result = greetingService.greet("Baeldung");
    assertNotNull(result);
    assertEquals("Hello Baeldung", result);
}

控制台输出：

>> greet() - [Baeldung]
<< greet() - Hello Baeldung

5. 使用最小侵入性通知

选择通知类型时，应优先使用满足需求的最弱能力通知。过度使用@Around可能引入性能问题和潜在错误。

5.1 前置通知（`@Before`）

在方法执行前拦截：

@Before(value = "publicMethodsFromLoggingPackage()")
public void logBefore(JoinPoint joinPoint) {
    Object[] args = joinPoint.getArgs();
    String methodName = joinPoint.getSignature().getName();
    logger.debug(">> {}() - {}", methodName, Arrays.toString(args));
}

5.2 返回通知（`@AfterReturning`）

方法正常返回后执行：

@AfterReturning(value = "publicMethodsFromLoggingPackage()", returning = "result")
public void logAfter(JoinPoint joinPoint, Object result) {
    String methodName = joinPoint.getSignature().getName();
    logger.debug("<< {}() - {}", methodName, result);
}

✅ returning属性需与方法参数名一致，用于接收返回值。

5.3 异常通知（`@AfterThrowing`）

方法抛出异常时执行：

@AfterThrowing(pointcut = "publicMethodsFromLoggingPackage()", throwing = "exception")
public void logException(JoinPoint joinPoint, Throwable exception) {
    String methodName = joinPoint.getSignature().getName();
    logger.error("<< {}() - {}", methodName, exception.getMessage());
}

6. Spring AOP避坑指南

Spring AOP基于代理机制实现，可能影响应用性能。使用时需注意：

按需使用：避免为孤立或低频操作创建切面
条件启用：开发环境可通过Spring Profile控制切面生效
优先选择弱通知：如@Before/@After优于@Around

7. 总结

本文介绍了使用Spring AOP实现日志记录的两种方式：

环绕通知（@Around）
组合通知（@Before + @AfterReturning + @AfterThrowing）

核心原则：始终选择满足需求的最小侵入性通知。同时需警惕AOP对性能的影响，避免过度使用。

完整代码示例见GitHub仓库。

Persistence

REST

Security