Spring Boot AOP 没有生效

原创

mob649e8159b30b 2024-09-21 05:59:43 ©著作权

文章标签 AOP spring java 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e8159b30b的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot AOP 没有生效的解决方案

在使用 Spring Boot 开发项目时，我们有时会遇到 AOP（面向切面编程）不生效的问题。理解 AOP 的工作原理及其配置步骤对于解决这个问题至关重要。本文将通过一个简明的流程和代码示例，帮助你理解如何正确配置 AOP，以确保它能够正常工作。

AOP 实现流程

以下是实现 AOP 的基本流程步骤表：

步骤	描述
1	添加依赖库
2	创建切面类
3	定义切入点和通知
4	启用 AOP
5	测试 AOP 是否生效

1. 添加依赖库

首先，确保在 pom.xml 文件中添加了 AOP 的相关依赖。如果你使用的是 Maven，可以按照如下代码添加：

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

这段代码将引入 Spring AOP 的支持。

2. 创建切面类

切面是 AOP 的核心部分，它包括了切入点（pointcut）和通知（advice）。创建一个切面类的步骤如下：

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;

@Aspect
@Component  // 将该类声明为 Spring 组件
public class LoggingAspect {

    // 定义切入点和通知
    @Before("execution(* com.example.demo.service.*.*(..))") // 指定切入点
    public void logBefore() {
        System.out.println("方法执行之前的日志记录");
    }
}

上面的代码中：

@Aspect 表示这个类是一个切面。
@Before 表示在执行指定方法之前执行 logBefore 方法。
execution(* com.example.demo.service.*.*(..)) 是切入点表达式，它表示对 com.example.demo.service 包下所有类的所有方法织入 AOP 功能。

3. 启用 AOP

在 Spring Boot 中，AOP 通常是自动配置的。在你的主类（启动类）中，可以显式启用 AOP：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

由于使用了 @SpringBootApplication 注解，AOP 相关功能会被自动扫描并生效。

4. 测试 AOP 是否生效

在你的服务类中定义一个方法，并观测 AOP 是否生效：

package com.example.demo.service;

import org.springframework.stereotype.Service;

@Service
public class UserService {

    public void createUser() {
        System.out.println("创建用户");
    }
}

然后，在你的控制器中调用这个服务方法：

package com.example.demo.controller;

import com.example.demo.service.UserService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @GetMapping("/create-user")
    public String createUser() {
        userService.createUser();
        return "用户创建请求已被处理";
    }
}

当你访问 /create-user 这个接口时，控制台输出会是：

方法执行之前的日志记录
创建用户
用户创建请求已被处理

5. 序列图

为了更清晰地理解 AOP 的执行流程，下面是一个简单的序列图，展示了方法调用及 AOP 处理的顺序：

sequenceDiagram
    participant C as 控制器
    participant S as 服务
    participant A as 切面

    C->>S: 调用 createUser()
    A->>A: 方法执行之前的日志记录
    S->>C: 返回结果