前言
在这一篇文章中,将会介绍AOP的基本使用,以及注解配置和xml配置。在使用spring首先需要进行导入相应的jar包,如下
准备工作
创建一个Calculate接口,然后创建一个该接口的实现类,如下
public interface Calculate {
public int add(int a, int b);
public int sub(int a, int b);
}
@Component
public class CalculateImpl implements Calculate {
@Override
public int add(int a, int b) {
return a + b;
}
@Override
public int sub(int a, int b) {
return a - b;
}
}
注解配置
在上一篇文章中说明了横切关注点,在aop中也是对这几个横切关注点进行切入的,如下
在aop中与这几个位置想对应的就是几个注解
- @Before:前置通知
- @AfterReturning:返回通知
- @AfterThrowing:异常通知
- @After:后置通知
- @Around:环绕通知,也就是上面四个通知
快速入门
我们对方法进行切面编程,只需要写一个方法,然后在方法上面加上相应的注解,然后在注解里面指定要进行切入的方法即可。下面是一个简单的例子
首先创建一个切面类,名称随意,用注解标识为切面类,里面写一个想要在相应横切关注点进行处理的方法,然后指定注解,标识要进行切入的位置,该注解再指定具体要切入的方法。有点绕,下面直接看代码
@Aspect
@Component
public class MyAspect {
@AfterReturning(value = "execution(public int com.ttpfx.spring.aop.CalculateImpl.add(int,int))", returning = "res")
public void afterInfo(JoinPoint joinPoint, Object res) {
System.out.println(joinPoint.getSignature().getName() + "方法执行完毕");
System.out.println("该方法参数为:" + Arrays.toString(joinPoint.getArgs()));
System.out.println("该方法返回结果为:" + res);
}
}
上面的代码第一次接触肯定难理解,下面来对代码进行解释
@Aspect
用来标识切面类,只有标识了这个注解,spring才会将该里面里面的方法进行切入。
切入表达式
这个就是@Before,@After等5个注解都必须指定的。代表要进行切入的具体位置,形式是 方法修饰符 返回值 方法全路径(参数)
在切入表达式中,可以使用通配符,使用*号就代码全部,这样就可以进行模糊指定。在指定方法的参数时,表示所有参数是用..来进行指定的
JoinPoint
这是一个对象,将切入点的所有信息都封装在了里面,通过这个对象,我们可以获取到几乎所有信息(除了方法的返回值及异常信息)。 这个对象方法十分简单,稍微看下就行了
获取方法返回值
在方法执行完后会有一个返回值,当然,通过上面的横切关注点的图,很明显的知道返回值只能在返回通知里面得到,也就是@AfterReturning中获取。在这个注解中,指定一个return的值,然后在方法的参数列表加上Object 指定return值即可
@AfterReturning(value = "execution(public int com.ttpfx.spring.aop.CalculateImpl.add(int,int))", returning = "res") public void afterInfo(JoinPoint joinPoint, Object res) {
获取异常信息
和上面一样,获取异常信息肯定只能在异常通知中获取,也就是@AfterThrowing,类似的,就是指定throwing即可
@AfterThrowing(value = "execution(public int com.ttpfx.spring.aop.CalculateImpl.add(int,int))", throwing = "e") public void afterThrowing(JoinPoint joinPoint,Throwable e){
环绕通知
这个比较特殊,由于要在所有的横切关注点生效,所以方法里面得要写成try-catch-finally的结构,并且在方法参数那里是写ProceedingJoinPoint,并且要将方法执行的结果进行返回。下面是一个环绕通知的写法
@Around(value = "execution(public int com.ttpfx.spring.aop.CalculateImpl.add(..))")
public Object myAround(ProceedingJoinPoint joinPoint){
Object o = null;
try {
System.out.println("前置通知");
//执行方法
o = joinPoint.proceed(joinPoint.getArgs());
System.out.println("返回通知");
}catch (Throwable e) {
e.printStackTrace();
System.out.println("异常通知");
} finally {
System.out.println("最终通知");
}
return o;
}
切面表达式重用
如果好几个方法都是对同样的位置进行切面,那么就可以将路径给提出来,相当于就是取个别名。直接看下面代码
@Pointcut(value = "execution(public int com.ttpfx.spring.aop.CalculateImpl.add(int,int))")
public void myPointcut() {
}
@AfterReturning(value = "myPointcut())", returning = "res")
public void afterInfo(JoinPoint joinPoint, Object res) {
System.out.println(joinPoint.getSignature().getName() + "方法执行完毕");
System.out.println("该方法参数为:" + Arrays.toString(joinPoint.getArgs()));
System.out.println("该方法返回结果为:" + res);
}
上面的代码就相当于是给切入点表达式取了个别名,叫做myPointcut,其他的切面配置时可以直接进行引用
切面优先级
如果有多个切面类对同一个方法进行切如,优先级该如何控制呢?在spring中就是使用@Order注解,填入一个n值,n越小,优先级越高,该注解放到切面类上。说明一下切面类的调用顺序。如果A>B,那么就是 A前置通知->B前置通知->执行方法->B后置通知->A后置通知 的方式来进行的。
注意事项!!!
经过上面的学习,我们已经学会了AOP的注解配置方式,但是创建测试方法却不能生效,这是因为我们没有开启切面编程的功能,我们需要在xml配置文件中加入如下的设置。
<aop:aspectj-autoproxy/>
XML配置
xml和注解差不多的,不详细说明了,下面给出配置的标签
<bean class="com.ttpfx.spring.aop.MyAspect" id="aspect"/>
<aop:config>
<!--定义切入点表达式-->
<aop:pointcut id="myPointcut" expression="execution(public int com.ttpfx.spring.aop.CalculateImpl.add(..))"/>
<!--切面类-->
<aop:aspect ref="aspect" order="1" id="myXmlAspect">
<!--各种切面方法-->
<aop:before method="toString" pointcut-ref="myPointcut"/>
<!--通过returning来得到返回值,方法参数中要有这里定义的值-->
<aop:after-returning method="toString" pointcut-ref="myPointcut" returning="res"/>
<!--通过throwing得到异常信息,方法参数中也要有这里定义的值-->
<aop:after-throwing method="toString" pointcut-ref="myPointcut" throwing="e"/>
<aop:after method="toString" pointcut-ref="myPointcut"/>
<aop:around method="toString" pointcut-ref="myPointcut"/>
</aop:aspect>
</aop:config>
总结
这篇文章中大致介绍了下AOP的各种配置,由于内容太多了,所以没有进行测试,讲的也比较粗略,但是常用的方式都讲到了,能用还是没有问题的。如果想了解更多,还需要查看官方文档或者其他的技术文章。