SpringBoot项目中使用AOP的方法

偏执的太偏执、 2022-09-14 03:11 162阅读 0赞

**1.概述**

将通用的逻辑用AOP技术实现可以极大的简化程序的编写，例如验签、鉴权等。Spring的声明式事务也是通过AOP技术实现的。

**Spring的AOP技术主要有4个核心概念：**

Pointcut: 切点，用于定义哪个方法会被拦截，例如 execution(\* cn.springcamp.springaop.service.\*.\*(..))

Advice: 拦截到方法后要执行的动作

Aspect: 切面，把Pointcut和Advice组合在一起形成一个切面

Join Point: 在执行时Pointcut的一个实例

Weaver: 实现AOP的框架，例如 AspectJ 或 Spring AOP

**2. 切点定义**

常用的Pointcut定义有 execution 和 @annotation 两种。execution 定义对方法无侵入，用于实现比较通用的切面。@annotation 可以作为注解加到特定的方法上，例如Spring的Transaction注解。

execution切点定义应该放在一个公共的类中，集中管理切点定义。

示例：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>public</code> <code>class</code> <code>CommonJoinPointConfig { </code> <code>&nbsp;&nbsp;</code><code>@Pointcut</code><code>(</code><code>"execution(* cn.springcamp.springaop.service.*.*(..))"</code><code>)</code> <code>&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>serviceLayerExecution() {}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

这样在具体的Aspect类中可以通过 CommonJoinPointConfig.serviceLayerExecution()来引用切点。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>public</code> <code>class</code> <code>BeforeAspect { </code> <code>&nbsp;&nbsp;</code><code>@Before</code><code>(</code><code>"CommonJoinPointConfig.serviceLayerExecution()"</code><code>)</code> <code>&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>before(JoinPoint joinPoint) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>" -------------&gt; Before Aspect "</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>" -------------&gt; before execution of "</code> <code>+ joinPoint);</code> <code>&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

当切点需要改变时，只需修改CommonJoinPointConfig类即可，不用修改每个Aspect类。

**3. 常用的切面**

Before: 在方法执行之前执行Advice，常用于验签、鉴权等。

After: 在方法执行完成后执行，无论是执行成功还是抛出异常.

AfterReturning: 仅在方法执行成功后执行.

AfterThrowing: 仅在方法执抛出异常后执行.

一个简单的Aspect：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>@Aspect</code> <code>@Component</code> <code>public</code> <code>class</code> <code>BeforeAspect { </code> <code>&nbsp;&nbsp;</code><code>@Before</code><code>(</code><code>"CommonJoinPointConfig.serviceLayerExecution()"</code><code>)</code> <code>&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>before(JoinPoint joinPoint) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>" -------------&gt; Before Aspect "</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>" -------------&gt; before execution of "</code> <code>+ joinPoint);</code> <code>&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**4. 自定义注解**

假设我们想收集特定方法的执行时间，一种比较合理的方式是自定义一个注解，然后在需要收集执行时间的方法上加上这个注解。

首先定义一个注解TrackTime：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>@Target</code><code>({ElementType.METHOD, ElementType.TYPE})</code> <code>@Retention</code><code>(RetentionPolicy.RUNTIME)</code> <code>public</code> <code>@interface</code> <code>TrackTime { </code> <code>&nbsp;&nbsp;</code><code>String param() </code><code>default</code> <code>""</code><code>;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

然后再定义一个Aspect类，用于实现注解的行为：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code>@Aspect</code> <code>@Component</code> <code>public</code> <code>class</code> <code>TrackTimeAspect { </code> <code>&nbsp;&nbsp;</code><code>@Around</code><code>(</code><code>"@annotation(trackTime)"</code><code>)</code> <code>&nbsp;&nbsp;</code><code>public</code> <code>Object around(ProceedingJoinPoint joinPoint, TrackTime trackTime) </code><code>throws</code> <code>Throwable { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Object result = </code><code>null</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>long</code> <code>startTime = System.currentTimeMillis();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>result = joinPoint.proceed();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>long</code> <code>timeTaken = System.currentTimeMillis() - startTime;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>" -------------&gt; Time Taken by "</code> <code>+ joinPoint + </code><code>" with param["</code> <code>+ trackTime.param() + </code><code>"] is "</code> <code>+ timeTaken);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>result;</code> <code>&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

在某个方法上使用这个注解，就可以收集这个方法的执行时间：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>@TrackTime</code><code>(param = </code><code>"myService"</code><code>)</code> <code>public</code> <code>String runFoo() { </code> <code>&nbsp;&nbsp;</code><code>System.out.println(</code><code>" -------------&gt; foo"</code><code>);</code> <code>&nbsp;&nbsp;</code><code>return</code> <code>"foo"</code><code>;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

注意 @TrackTime(param = "myService") 注解是可以传参的。

为了让注解可以传参数，需要在定义注解时指定一个参数String param() default "默认值"，

同时在Aspect类中，around方法上加上相应的参数，@Around注解中也需要用参数的变量名trackTime，而不能用类名TrackTime。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>@Around</code><code>(</code><code>"@annotation(trackTime)"</code><code>)</code> <code>public</code> <code>Object around(ProceedingJoinPoint joinPoint, TrackTime trackTime)</code> </td> 
 </tr> 
 </tbody> 
</table>

**5.总结**

在运行示例项目时，控制台会输出以下内容：

>  -------------> Before Aspect  
>  -------------> before execution of execution(String cn.springcamp.springaop.service.MyService.runFoo())  
>  -------------> foo  
>  -------------> Time Taken by execution(String cn.springcamp.springaop.service.MyService.runFoo()) with param\[myService\] is 8  
>  -------------> After Aspect  
>  -------------> after execution of execution(String cn.springcamp.springaop.service.MyService.runFoo())  
>  -------------> AfterReturning Aspect  
>  -------------> execution(String cn.springcamp.springaop.service.MyService.runFoo()) returned with value foo

可以看出几种 Aspect 的执行顺序依次为 Before After Around AfterReturning(AfterThrowing)