feat:增加SpringAOP文档

This commit is contained in:
2025-12-25 16:19:09 +08:00
parent 3911a00a51
commit 66d565d65b
5 changed files with 268 additions and 29 deletions

View File

@@ -0,0 +1,221 @@
---
title: Spring AOP简介
date: 2025-12-25
---
# 一、基本概念
  AOPAspect-Oriented Programming面向切面编程是一种编程范式核心思想是**将与业务核心逻辑无关但又被多个模块共享的功能(如日志、事务、权限校验、性能监控)抽取出来,形成独立的 “切面”**,在不修改原有业务代码的前提下,通过 “织入” 的方式动态添加到目标方法的执行流程中。
  Spring AOP 是 Spring 框架对 AOP 思想的实现,基于**动态代理JDK 动态代理 + CGLIB 动态代理)**,专注于解决企业级开发中的横切关注点问题。
| 术语 | 说明 |
|------|------|
| 切面Aspect | 封装横切逻辑的类(如日志切面、事务切面),包含通知和切点 |
| 连接点Joinpoint | 程序执行过程中的某个特定点如方法调用、异常抛出Spring AOP 中仅支持方法级连接点 |
| 切点Pointcut | 匹配连接点的规则,用于指定切面要织入到哪些方法上 |
| 通知Advice | 切面的具体逻辑(如日志打印、权限校验),按执行时机分为 5 种 |
| 目标对象Target | 被切面织入的目标类(业务类) |
| 代理对象Proxy | Spring AOP 为目标对象创建的代理类,横切逻辑通过代理执行 |
| 织入Weaving | 将切面逻辑添加到目标对象的过程Spring AOP 是运行时织入(通过动态代理) |
| 通知类型 | 执行时机 |
|----------|----------|
| 前置通知Before | 目标方法执行前执行 |
| 后置通知After | 目标方法执行后执行(无论是否抛出异常) |
| 返回通知AfterReturning | 目标方法正常返回后执行 |
| 异常通知AfterThrowing | 目标方法抛出异常后执行 |
| 环绕通知Around | 包裹目标方法执行,可自定义目标方法执行前后的逻辑(功能最强) |
# 二、原理
  Spring AOP 基于动态代理实现,分为两种方式:
1. JDK 动态代理
通过 java.lang.reflect.Proxy 生成代理类,代理类实现目标接口,调用 InvocationHandler 处理横切逻辑;基于接口,无侵入。
2. CGLIB 动态代理
通过继承目标类生成子类作为代理类,重写目标方法,织入横切逻辑;基于继承,目标类不能是 final方法不能是 final。
  Spring AOP 自动选择规则:如果目标类实现了接口,使用 JDK 动态代理;否则使用 CGLIB。
# 三、实战
  例如存在以下业务模块:
```java
@Service
public class OrderService {
// 模拟创建订单
public String createOrder(String orderNo) {
System.out.println("创建订单:" + orderNo);
return "订单创建成功:" + orderNo;
}
// 模拟删除订单(故意抛出异常)
public void deleteOrder(String orderNo) {
System.out.println("删除订单:" + orderNo);
throw new RuntimeException("删除订单失败:订单不存在");
}
}
```
  AOP实现
```java
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
import java.util.Arrays;
// 1. 标记为切面类
@Aspect
// 2. 交给Spring容器管理
@Component
public class LogAspect {
// 3. 定义切点匹配OrderService类的所有方法
@Pointcut("execution(* com.example.aopdemo.service.OrderService.*(..))")
public void orderServicePointcut() {}
// 4. 前置通知:目标方法执行前执行
@Before("orderServicePointcut()")
public void beforeAdvice(JoinPoint joinPoint) {
// 获取方法名和参数
String methodName = joinPoint.getSignature().getName();
Object[] args = joinPoint.getArgs();
System.out.println("[前置通知] 方法:" + methodName + ",参数:" + Arrays.toString(args));
}
// 5. 后置通知:目标方法执行后执行(无论是否异常)
@After("orderServicePointcut()")
public void afterAdvice(JoinPoint joinPoint) {
String methodName = joinPoint.getSignature().getName();
System.out.println("[后置通知] 方法:" + methodName + " 执行完毕");
}
// 6. 返回通知:目标方法正常返回后执行
@AfterReturning(value = "orderServicePointcut()", returning = "result")
public void afterReturningAdvice(JoinPoint joinPoint, Object result) {
String methodName = joinPoint.getSignature().getName();
System.out.println("[返回通知] 方法:" + methodName + ",返回值:" + result);
}
// 7. 异常通知:目标方法抛出异常后执行
@AfterThrowing(value = "orderServicePointcut()", throwing = "ex")
public void afterThrowingAdvice(JoinPoint joinPoint, Exception ex) {
String methodName = joinPoint.getSignature().getName();
System.out.println("[异常通知] 方法:" + methodName + ",异常:" + ex.getMessage());
}
// 8. 环绕通知:包裹目标方法执行(功能最强)
@Around("orderServicePointcut()")
public Object aroundAdvice(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
String methodName = proceedingJoinPoint.getSignature().getName();
Object[] args = proceedingJoinPoint.getArgs();
// 前置逻辑
System.out.println("[环绕通知-前置] 方法:" + methodName + ",参数:" + Arrays.toString(args));
Object result = null;
try {
// 执行目标方法
result = proceedingJoinPoint.proceed();
// 返回后逻辑
System.out.println("[环绕通知-返回] 方法:" + methodName + ",返回值:" + result);
} catch (Throwable e) {
// 异常逻辑
System.out.println("[环绕通知-异常] 方法:" + methodName + ",异常:" + e.getMessage());
throw e; // 必须抛出异常,否则上层无法捕获
} finally {
// 后置逻辑
System.out.println("[环绕通知-后置] 方法:" + methodName + " 执行完毕");
}
return result;
}
}
```
  测试:
```java
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class OrderServiceTest {
@Autowired
private OrderService orderService;
// 测试正常方法createOrder
@Test
public void testCreateOrder() {
orderService.createOrder("ORDER_20251225");
}
// 测试异常方法deleteOrder
@Test
public void testDeleteOrder() {
try {
orderService.deleteOrder("ORDER_9999");
} catch (Exception e) {
// 捕获异常,避免测试中断
}
}
}
```
  测试结果:
```plaintext
[环绕通知-前置] 方法createOrder参数[ORDER_20251225]
[前置通知] 方法createOrder参数[ORDER_20251225]
创建订单ORDER_20251225
[环绕通知-返回] 方法createOrder返回值订单创建成功ORDER_20251225
[返回通知] 方法createOrder返回值订单创建成功ORDER_20251225
[后置通知] 方法createOrder 执行完毕
[环绕通知-后置] 方法createOrder 执行完毕
[环绕通知-前置] 方法deleteOrder参数[ORDER_9999]
[前置通知] 方法deleteOrder参数[ORDER_9999]
删除订单ORDER_9999
[环绕通知-异常] 方法deleteOrder异常删除订单失败订单不存在
[异常通知] 方法deleteOrder异常删除订单失败订单不存在
[后置通知] 方法deleteOrder 执行完毕
[环绕通知-后置] 方法deleteOrder 执行完毕
```
# 四、切点表达式
| 切点表达式 | 说明 |
|------------|------|
| `execution(* com.example.service.*.*(..))` | 匹配 com.example.service 包下所有类的所有方法 |
| `execution(public String com.example.service.OrderService.create*(String))` | 匹配 OrderService 类中公共、返回值为 String、方法名以 create 开头、参数为 String 的方法 |
| `execution(* com.example..*Service.*(..))` | 匹配 com.example 包及其子包下所有以 Service 结尾的类的所有方法 |
| `@annotation(com.example.annotation.Log)` | 匹配标注了 @Log 自定义注解的方法 |
  组合切点:
```java
// 匹配OrderService的方法 且 方法名包含"Order"
@Pointcut("execution(* com.example.service.OrderService.*(..)) && execution(* *Order*(..))")
public void combinePointcut() {}
```
# 五、总结
  通俗的解释AOP本质是找目标通过切点规则精准找到要 “加戏” 的方法 / 类)→ 造代理Spring 自动给这些目标生成一个 “中间商”(代理对象))→ 加戏(在目标方法真正执行前 / 后 / 出问题时,让这个 “中间商” 帮你干额外的活)。
::: tip
基于 Spring AOP 的知名框架/组件汇总
| 框架/组件 | 核心作用 | Spring AOP 应用说明 |
|-----------|----------|---------------------|
| AspectJ | 提供切点表达式语法、注解解析(@Aspect/@Pointcut 等) | Spring AOP 仅复用其语法规则,底层仍为自身动态代理(未使用 AspectJ 编译期织入) |
| Spring Core | 容器管理、动态代理创建JDK/CGLIB | 负责切面/目标类的生命周期管理,生成代理对象并完成织入逻辑 |
| Spring Transaction | 声明式事务管理 | 切点:匹配 @Transactional 注解方法;<br>通知:方法执行前开启事务、执行后提交、异常时回滚 |
| Spring Cache | 声明式缓存管理 | 切点:匹配 @Cacheable/@CacheEvict 等注解方法;<br>通知:方法执行前查缓存、执行后更新缓存 |
| spring-boot-starter-aop | AOP 基础依赖封装 | 自动引入 AspectJ + Spring AOP 核心,开箱即用 |
| Spring Security | 安全权限管理 | 切点:匹配 @PreAuthorize 等权限注解方法;<br>通知:方法执行前校验用户权限,无权限抛异常 |
| MyBatis-Plus | 增强 MyBatis CRUD 操作 | 切点:匹配 Mapper 接口方法/标注注解的实体类;<br>通知:织入分页逻辑、注解(@TableName)解析等 |
| Shiro | 权限管理框架 | 切点:匹配 @RequiresPermissions 注解方法;<br>通知:方法执行前校验用户权限 |
| Seata | 分布式事务框架 | 切点:匹配 @GlobalTransactional 注解方法;<br>通知:织入全局事务的开启、提交、回滚逻辑 |
| Sentinel | 流量控制/熔断降级框架 | 切点:匹配 @SentinelResource 注解方法;<br>通知:方法执行前校验流量阈值、熔断规则 |
| Dynamic-TP | 动态线程池框架 | 切点:匹配线程池执行方法;<br>通知:织入线程池耗时、队列长度等监控逻辑 |
| p6spy | 数据库 SQL 监控 | 切点:拦截 JDBC 操作方法;<br>通知:织入 SQL 打印、执行耗时统计逻辑 |
| dynamic-datasource-spring-boot-starter | 动态数据源切换 | 切点:匹配 @DS 注解方法;<br>通知:方法执行前切换数据源、执行后恢复默认数据源 |
| xxl-job | 分布式任务调度 | 切点:匹配任务执行方法;<br>通知:织入任务执行日志、监控指标采集逻辑 |
| Spring Cloud Sleuth | 微服务链路追踪 | 切点:拦截 HTTP/RPC 调用方法;<br>通知:织入 traceId/spanId 传递、链路信息采集逻辑 |
:::

View File

@@ -38,6 +38,12 @@ public class AppConfig {
<bean id="userService" class="com.example.UserService"/>
```
::: tip
@Service@Controller这些注解是@Component的衍生注解
@Component注解可以通过@Autowired自动注入,一般用于自己编写的业务模块,需要配合@ComponentScan启用组件扫描(实际开发中@SpringBootApplication注解已经包含了@ComponentScan注解)。
@Bean注解一般用于注册第三方库的类
:::
## 2.4 作用域
&emsp;&emsp;控制 Bean 在容器中的实例数量和生命周期。Spring 提供多种作用域,默认是 singleton。通过 @Scope 注解指定,如 @Scope("prototype")。
- singleton单例容器中只有一个实例所有请求共享该实例默认值
@@ -46,25 +52,32 @@ public class AppConfig {
- sessionWeb每个会话创建一个实例在会话有效期内有效。
## 2.5 生命周期
1. 实例化Instantiation:容器通过构造器创建 Bean 实例(分配内存)。
2. 属性注入Population容器将依赖的 Bean 注入到当前 Bean 的字段或方法(如 @Autowired 标注的依赖)。
3. 初始化前Post-processing before initialization
执行 BeanPostProcessor 的 postProcessBeforeInitialization 方法AOP 代理生成在此阶段)。
4. 初始化Initialization
调用 @PostConstruct 注解的方法JSR-250 标准,推荐)。
若实现 InitializingBean 接口,调用 afterPropertiesSet() 方法。
执行自定义初始化方法(如 @Bean(initMethod = "init") 中指定的 init 方法)。
5. 初始化后Post-processing after initialization
执行 BeanPostProcessor 的 postProcessAfterInitialization 方法。
6. 使用In UseBean 被应用程序调用。
7. 销毁Destruction
调用 @PreDestroy 注解的方法JSR-250 标准,推荐)。
若实现 DisposableBean 接口,调用 destroy() 方法。
执行自定义销毁方法(如 @Bean(destroyMethod = "destroy") 中指定的 destroy 方法)。
1. 实例化Instantiation
容器通过构造器创建 Bean 实例(分配内存)。
2. 属性注入Population
容器将依赖的 Bean 注入到当前 Bean 的字段或方法(如 @Autowired 标注的依赖)。
3. 初始化前Post-processing before initialization
执行 BeanPostProcessor 的 postProcessBeforeInitialization 方法AOP 代理生成在此阶段)。
4. 初始化Initialization
调用 @PostConstruct 注解的方法JSR-250 标准,推荐)。
若实现 InitializingBean 接口,调用 afterPropertiesSet() 方法。
执行自定义初始化方法(如 @Bean(initMethod = "init") 中指定的 init 方法)。
5. 初始化后Post-processing after initialization
执行 BeanPostProcessor 的 postProcessAfterInitialization 方法。
6. 使用In Use
Bean 被应用程序调用。
7. 销毁Destruction
调用 @PreDestroy 注解的方法JSR-250 标准,推荐)。
若实现 DisposableBean 接口,调用 destroy() 方法。
执行自定义销毁方法(如 @Bean(destroyMethod = "destroy") 中指定的 destroy 方法)。
![暂无图片](https://cxx0822.iepose.cn/rustfs/blog/b1054386c885ffefb0f08074ad6b6268.png 'Bean生命周期.png')
# 三、BeanDefinition
## 3.1 定义
&emsp;&emsp;BeanDefinition是Spring框架中描述Bean的元数据对象它包含了创建Bean实例所需的所有信息。
@@ -172,7 +185,7 @@ public interface BeanFactory {
}
```
## 4.4 实现示例
## 4.4 使用示例
```java
// 创建BeanFactory实例
DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
@@ -193,7 +206,7 @@ UserService userService = beanFactory.getBean("userService", UserService.class);
- 延迟加载默认在第一次请求时才创建Bean实例
- 基础功能提供最基本的IOC功能
# 五、ApplicationContext
# 五、ApplicationContext ★★★
## 5.1 定义
&emsp;&emsp;ApplicationContext是BeanFactory的子接口在BeanFactory的基础上提供了更多企业级功能是Spring容器的完整实现。
@@ -544,5 +557,5 @@ protected void finishRefresh() {
- 标记整个容器启动流程结束,容器进入就绪状态
### 5.4.13 总结
&emsp;&emsp;refresh()方法按固定顺序执行12个步骤核心可归纳为准备容器环境 → 解析并注册Bean定义→ 初始化事件、消息等基础设施 → 实例化所有非懒加载的单例Bean→ 完成启动并发布事件。整个过程通过模板方法模式定义,确保了扩展性和一致性。
&emsp;&emsp;核心在于两个关键扩展机制BeanFactoryPostProcessor在Bean定义阶段介入负责修改和注册Bean的定义信息BeanPostProcessor在Bean实例化阶段介入负责对创建好的Bean实例进行增强和包装。
&emsp;&emsp;refresh()方法按固定顺序执行12个步骤核心可归纳为**准备容器环境 → 解析并注册Bean定义→ 初始化事件、消息等基础设施 → 实例化所有非懒加载的单例Bean→ 完成启动并发布事件**。整个过程通过模板方法模式定义,确保了扩展性和一致性。
&emsp;&emsp;核心在于两个关键扩展机制:**BeanFactoryPostProcessor在Bean定义阶段介入负责修改和注册Bean的定义信息BeanPostProcessor在Bean实例化阶段介入负责对创建好的Bean实例进行增强和包装。**

View File

@@ -4,37 +4,37 @@
---
# 一、基础概念
&emsp;&emsp;Spring MVCSpring Model-View-Controller是 Spring Framework 中的一部分,它是一个基于 **<font style="color:#DF2A3F;">请求驱动</font>** 的 Web 框架,主要用于构建 Web 应用程序,并且遵循 MVC模型-视图-控制器) 设计模式。它将 Web 应用的业务逻辑、用户界面和请求处理分离,使得代码更加模块化和可维护。
&emsp;&emsp;Spring MVCSpring Model-View-Controller是 Spring Framework 中的一部分,它是一个基于 **请求驱动** 的 Web 框架,主要用于构建 Web 应用程序,并且遵循 MVC模型-视图-控制器) 设计模式。它将 Web 应用的业务逻辑、用户界面和请求处理分离,使得代码更加模块化和可维护。
# 二、具体流程
![暂无图片](https://cxx0822.iepose.cn/rustfs/blog/04fb16a3e32f247bbf0bb7e176de8444.png '具体流程.png')
1. **客户端发起HTTP请求**
1. 客户端发起HTTP请求
&emsp;&emsp;客户端浏览器、API 客户端等)向服务器发送 HTTP 请求。请求包含了目标 URL、HTTP 方法GET、POST 等)以及可能的请求参数。
前端通过发送 HTTP 请求(通常是 AJAX 请求)到后端的 API 端点,并期望获得响应(通常是 JSON 数据)。
2. **请求到达 DispatcherServlet**
2. 请求到达 DispatcherServlet
&emsp;&emsp;所有 HTTP 请求都会先到达 Spring MVC 的核心组件:**<font style="color:#DF2A3F;">DispatcherServlet</font>**。它是前端控制器负责将请求分发给正确的处理器。DispatcherServlet 是所有请求的入口Spring Boot 会自动配置它。
&emsp;&emsp;所有 HTTP 请求都会先到达 Spring MVC 的核心组件:**DispatcherServlet**。它是前端控制器负责将请求分发给正确的处理器。DispatcherServlet 是所有请求的入口Spring Boot 会自动配置它。
&emsp;&emsp;DispatcherServlet 接受所有的 HTTP 请求,根据请求 URL 和 HTTP 方法,定位匹配的控制器方法,将请求交给相应的 Handler Mapping 来匹配控制器。在请求处理前后,执行 拦截器(可选)。最终通过 View Resolver 返回一个合适的视图(对于 RESTful API通常返回 JSON 格式的数据)。
3. **查找处理器Handler Mapping**
3. 查找处理器Handler Mapping
&emsp;&emsp;DispatcherServlet 根据请求的 URL 和 HTTP 方法,查找与之匹配的处理器方法(通常是一个控制器中的方法)。这是由 HandlerMapping 完成的。Spring MVC 提供了多种方式来映射 URL 到控制器方法,例如 @RequestMapping@GetMapping 等注解。
&emsp;&emsp;@RestController:该注解标记的类会返回 JSON 数据。
&emsp;&emsp;@RequestMapping:用于映射 URL 路径和 HTTP 方法。
&emsp;&emsp;@GetMapping@PostMapping 等:简化版本的 @RequestMapping
4. **执行拦截器Interceptor**
4. 执行拦截器Interceptor
&emsp;&emsp;在请求到达控制器之前DispatcherServlet 会依次执行配置的拦截器。拦截器主要用于日志记录、安全检查、请求参数的预处理等。
&emsp;&emsp;preHandle请求进入控制器方法之前。
&emsp;&emsp;postHandle请求完成后视图渲染之前。
&emsp;&emsp;afterCompletion视图渲染完成后。
&emsp;&emsp;**<font style="color:#DF2A3F;">如果拦截器的 preHandle 方法返回 false请求会被拦截后续的处理不会继续进行。</font>**
&emsp;&emsp;**如果拦截器的 preHandle 方法返回 false请求会被拦截后续的处理不会继续进行。**
5. **控制器方法处理请求Handler Execution**
5. 控制器方法处理请求Handler Execution
&emsp;&emsp;DispatcherServlet 调用合适的控制器方法来处理请求。控制器方法负责处理请求的业务逻辑,并返回一个 Java 对象,这个对象会被自动转换成 JSON 格式返回给客户端。
&emsp;&emsp;Spring 通过 @ResponseBody 注解(或 @RestController)实现将 Java 对象自动转换为 JSON 格式。默认情况下Spring 使用 Jackson 来将 Java 对象序列化成 JSON 数据。
@@ -43,7 +43,7 @@
&emsp;&emsp;@RequestParam:用于获取单个请求参数。
&emsp;&emsp;@PathVariable:用于从 URL 中提取变量(如 /users/{id} 中的 {id})。
6. **响应返回客户端**
6. 响应返回客户端
&emsp;&emsp;DispatcherServlet 将处理完的结果JSON 数据)返回给客户端。响应数据通常会包含:
&emsp;&emsp;**状态码**:如 200 OK成功、201 Created资源创建成功、404 Not Found资源未找到、500 Internal Server Error服务器错误等。