This commit is contained in:
罗祥
2019-08-22 14:39:51 +08:00
parent 0544a18997
commit 2c989f9db3
26 changed files with 844 additions and 1643 deletions

View File

@ -1,37 +1,35 @@
# spring AOP注解方式
# Spring AOP注解方式
## 目录<br/>
<nav>
<a href="#一说明">一、说明</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#11-项目结构说明">1.1 项目结构说明</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#12-依赖说明">1.2 依赖说明</a><br/>
<a href="#二spring-aop">二、spring aop</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#21-创建待切入接口及其实现类">2.1 创建待切入接口及其实现类</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#22-创建自定义切面类">2.2 创建自定义切面类</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#11-项目结构说明">1.1 项目结构说明</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#12-依赖说明">1.2 依赖说明</a><br/>
<a href="#二Spring-AOP">二、Spring AOP</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#21-准备工作">2.1 准备工作</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#22-自定义切面类">2.2 自定义切面类</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#23-配置切面">2.3 配置切面</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#24-测试切面">2.4 测试切面</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#25--切面执行顺序">2.5 切面执行顺序</a><br/>
<a href="#-关于切面表达式的说明">附: 关于切面表达式的说明</a><br/>
## 正文<br/>
<a href="#切面表达式">三、切面表达式</a><br/>
</nav>
## 一、说明
### 1.1 项目结构说明
1. 切面配置位于 com.heibaiying.config 下 AopConfig.java 文件
2. 自定义切面位于 advice 下,其中 CustomAdvice 是标准的自定义切面FirstAdvice 和 SecondAdvice 用于测试多切面共同作用于同一个切入点时的执行顺序;
3. OrderService 是待切入方法。
1. 切面配置位于 com.heibaiying.config 下 `AopConfig`
2. 自定义切面位于 advice 下,其中 `CustomAdvice` 是标准的自定义切面,`FirstAdvice``SecondAdvice` 用于测试多切面共同作用于同一个切入点时的执行顺序;
3. `OrderService` 是待切入方法。
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/spring-aop-annotation.png"/> </div>
### 1.2 依赖说明
除了 spring 的基本依赖外,需要导入 aop 依赖包
除了 Spring 的基本依赖外,需要导入 AOP 依赖包
```xml
<!--aop 相关依赖-->
<!--aop 相关依赖-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
@ -41,9 +39,11 @@
## 二、spring aop
## 二、Spring AOP
#### 2.1 创建待切入接口及其实现类
### 2.1 准备工作
创建待切入的接口及其实现类:
```java
public interface OrderService {
@ -67,18 +67,13 @@ public class OrderServiceImpl implements OrderService {
return new Order(id, "new Product", new Date());
}
}
```
#### 2.2 创建自定义切面类
### 2.2 自定义切面类
注:@Pointcut 的值可以是多个切面表达式的组合
使用 @Aspect 来定义切面类,@Pointcut 来定义切面表达式,它可以是多个切面表达式的组合
```java
/**
* @author : heibaiying
* @description : 自定义切面
*/
@Aspect
@Component //除了加上@Aspect 外 还需要声明为 spring 的组件 @Aspect 只是一个切面声明
public class CustomAdvice {
@ -132,13 +127,9 @@ public class CustomAdvice {
```
#### 2.3 配置切面
### 2.3 配置切面
```java
/**
* @author : heibaiying
* @description : 开启切面配置
*/
@Configuration
@ComponentScan("com.heibaiying.*")
@EnableAspectJAutoProxy // 开启@Aspect 注解支持 等价于<aop:aspectj-autoproxy>
@ -146,7 +137,7 @@ public class AopConfig {
}
```
#### 2.4 测试切面
### 2.4 测试切面
```java
@RunWith(SpringRunner.class)
@ -164,8 +155,8 @@ public class AopTest {
}
/**
* 多个切面作用于同一个切入点时,可以用@Order 指定切面的执行顺序
* 优先级高的切面在切入方法前执行的通知 (before) 会优先执行,但是位于方法后执行的通知 (after,afterReturning) 反而会延后执行
* 多个切面作用于同一个切入点时,可以用 @Order 指定切面的执行顺序
* 优先级高的切面在切入方法前执行的通知 (before) 会优先执行,但是位于方法后执行的通知 (after,afterReturning) 反而会延后执行
*/
@Test
public void delete() {
@ -174,30 +165,30 @@ public class AopTest {
}
```
#### 2.5 切面执行顺序
### 2.5 切面执行顺序
- 多个切面作用于同一个切入点时,可以用@Order 指定切面的执行顺序
- 多个切面作用于同一个切入点时,可以用 @Order 指定切面的执行顺序
- 优先级高的切面在切入方法前执行的通知 (before) 会优先执行,但是位于方法后执行的通知 (after,afterReturning) 反而会延后执行,类似于同心圆原理
- 优先级高的切面在切入方法前执行的通知 (before) 会优先执行,但是位于方法后执行的通知 (afterafterReturning ) 反而会延后执行,类似于同心圆原理
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/aop 执行顺序.png"/> </div>
## 附: 关于切面表达式的说明
## 三、切面表达式
切面表达式遵循以下格式:
```shell
execution(modifiers-pattern? ret-type-pattern declaring-type-pattern?name-pattern(param-pattern)
throws-pattern?)
throws-pattern?)
```
- 除了返回类型模式,名字模式和参数模式以外,所有的部分都是可选的;
- `*`,它代表了匹配任意的返回类型;
- `()` 匹配一个不接受任何参数的方法, `(..)` 匹配一个接受任意数量参数的方法(零或者更多)。 模式 `(*)` 匹配一个接受一个任何类型的参数的方法。 模式 `(*,String)` 匹配了一个接受两个参数的方法,第一个可以是任意类型,第二个则必须是 String 类型。
- 除了返回类型模式,名字模式和参数模式以外,所有的部分都是可选的
- `*` 代表了匹配任意的返回类型
- `()` 匹配一个不接受任何参数的方法, `(..)` 匹配一个接受任意数量参数的方法(零或者更多)。 `(*)` 匹配一个接受任意类型的参数的方法。 模式 `(*,String)` 匹配了一个接受两个参数的方法,第一个可以是任意类型,第二个则必须是 String 类型。
下面给出一些常见切入点表达式的例子。
下面一些常见切入点表达式
- 任意公共方法的执行:
@ -205,25 +196,25 @@ execution(modifiers-pattern? ret-type-pattern declaring-type-pattern?name-patter
execution(public * *(..))
```
- 任何一个以“set”开始的方法的执行:
- 任何一个以 `set` 开头的方法的执行:
```java
execution(* set*(..))
```
- `AccountService` 接口任意方法的执行:
- `AccountService` 接口任意方法的执行:
```java
execution(* com.xyz.service.AccountService.*(..))
```
- 定义在 service 包里任意方法的执行:
- 定义在 service 包里任意方法的执行:
```java
execution(* com.xyz.service.*.*(..))
```
- 定义在 service 包或者子包里任意方法的执行:
- 定义在 service 包或者子包里任意方法的执行:
```java
execution(* com.xyz.service..*.*(..))
@ -247,4 +238,4 @@ execution(modifiers-pattern? ret-type-pattern declaring-type-pattern?name-patter
this(com.xyz.service.AccountService)
```
更多表达式可以参考官方文档:[Declaring a Pointcut](https://docs.spring.io/spring/docs/5.1.3.RELEASE/spring-framework-reference/core.html#aop-pointcuts)
更多表达式可以参考官方文档:[Declaring a Pointcut](https://docs.spring.io/spring/docs/5.1.3.RELEASE/spring-framework-reference/core.html#aop-pointcuts)