Aspect 不适用于带有外部 jar 的 Spring boot 应用程序

Spring

Aspect 不适用于带有外部 jar 的 Spring Boot 应用程序

在开发 Spring Boot 应用程序时，我们经常使用 Aspect（切面）来实现横切关注点的功能，例如日志记录、性能监控等。然而，当我们的应用程序依赖于外部的 jar 包时，使用 Aspect 可能会遇到一些问题。本文将探讨为什么 Aspect 不适用于带有外部 jar 的 Spring Boot 应用程序，并提供相应的案例代码来说明。

问题背景

在 Spring Boot 应用程序中使用 Aspect 的主要方式是通过使用 Spring AOP（面向切面编程）来定义切面和切点。切面是一种横切关注点的模块化方式，而切点则是定义了在应用程序中哪些位置可以应用切面逻辑。

然而，当我们的应用程序引入了外部的 jar 包时，Aspect 的工作机制可能会受到影响。原因在于，外部的 jar 包可能会使用自己的类加载器来加载其中的类，而不是使用 Spring Boot 应用程序的类加载器。这导致在应用程序中定义的切面无法正确地应用于外部 jar 包中的类。

问题示例

为了更好地理解这个问题，让我们来看一个简单的示例。假设我们的 Spring Boot 应用程序依赖于一个外部的 jar 包，该 jar 包中定义了一个名为 "ExternalService" 的类，我们想要在该类的方法执行之前打印一条日志。

首先，我们需要定义一个切面类，用来实现日志记录的逻辑。代码如下所示：

Java
@Component
@Aspect
public class LoggingAspect {
    @Before("execution(* com.example.ExternalService.*(..))")
    public void logBefore(JoinPoint joinPoint) {
        System.out.println("Before method execution: " + joinPoint.getSignature().getName());
    }
}

然后，在我们的应用程序中使用 ExternalService 类，并触发其方法的执行。代码如下所示：

Java
@SpringBootApplication
public class Application implements CommandLineRunner {
    @Autowired
    private ExternalService externalService;
    public static void mAIn(String[] args) {
        SpringApplication.run(Application.class, args);
    }
    @Override
    public void run(String... args) {
        externalService.doSomething();
    }
}

如果我们运行这个应用程序，我们期望在执行 externalService.doSomething() 方法之前看到一条日志输出。然而，实际上我们并没有看到任何日志输出。

问题原因

问题的根源在于，ExternalService 类是使用外部 jar 包的类加载器加载的，而不是使用 Spring Boot 应用程序的类加载器加载的。因此，切面定义的切点无法匹配到 ExternalService 类的方法执行。

解决方案

为了解决这个问题，我们可以使用 AspectJ 作为替代方案，而不是使用 Spring AOP。AspectJ 是一种更强大的 AOP 框架，它可以直接在字节码层面进行切面编织，而不依赖于 Spring 容器。通过使用 AspectJ，我们可以确保切面逻辑可以正确地应用于外部 jar 包中的类。

首先，我们需要在 pom.XML 文件中添加 AspectJ 的相关依赖：

XML
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjrt</artifactId>
    <version>1.9.6</version>
</dependency>
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.6</version>
</dependency>

然后，我们需要在应用程序的配置文件中启用 AspectJ 的支持。在 application.properties 文件中添加以下配置：

Spring.aop.proxy-target-class=true

接下来，我们需要重新定义切面类，并使用 AspectJ 的注解来定义切面和切点。代码如下所示：

Java
@Aspect
public class LoggingAspect {
    @Before("execution(* com.example.ExternalService.*(..))")
    public void logBefore(JoinPoint joinPoint) {
        System.out.println("Before method execution: " + joinPoint.getSignature().getName());
    }
}

最后，我们需要在应用程序的启动类中添加以下代码来启用 AspectJ 的自动代理功能：

Java
@EnableAspectJAutoProxy
@SpringBootApplication
public class Application implements CommandLineRunner {
    // ...
}

现在，我们重新运行应用程序，就能够正确地看到在执行 externalService.doSomething() 方法之前打印的日志输出了。

尽管 Spring AOP 是一个方便而强大的 AOP 框架，但在带有外部 jar 的 Spring Boot 应用程序中使用 Aspect 时可能会遇到问题。由于外部 jar 包使用自己的类加载器加载类，导致切面无法正确地应用于外部 jar 包中的类。为了解决这个问题，我们可以使用 AspectJ 作为替代方案，它可以直接在字节码层面进行切面编织。通过使用 AspectJ，我们可以确保切面逻辑可以正确地应用于带有外部 jar 的 Spring Boot 应用程序中的类。