spring的aop配置方法及注意细节
spring的aop使用方法
spring的aop是用通过动态代理的方式实现的
Java的动态代理有两种实现方式,不了解动态代理的可以看这里
一、AOP相关术语
- Joinpoint(连接点):所谓连接点就是指那些被拦截到的点。再spring中,这些点指的是方法,因为spring只支持方法类型的连接点。即被代理类中的所有方法。
- Pointcut(切入点):所谓切入点就是所有的连接点中被增强的方法。
- advice(通知/增强):所谓通知就是拦截到Joinpoint后做的事情
- 通知的类型:
- 前置通知:在代理代码之前的执行的
- 后置通知:在代理代码之后执行的
- 异常通知:在catch里的
- 最终通知:在finally里的
- 环绕通知:整个动态代理的方法就是环绕通知 如:invoke方法,在环绕方法中有明确的切入点方法的调用 如:method.invoke(object,args)
- 通知的类型:
- Introduction(引介):是一种特殊的通知,在不修改类代码的前提下,Introduction可以在运行期间为类动态地添加一些方法或字段
- Target(目标对象):被代理的对象
- weaving(织入):是指把增强应用到目标对象来创建新的对象的过程
- proxy(代理):一个类被AOP织入增强后,就产生一个结果代理类,即代理类
- Aspect(切面):切入点+通知 (被增强的方法+提供公共代码的类)切入点方法和执行通知的方法在执行调用的对应关系,即通知方法应该让spring知道在切入点的那个位置(之前,之后,异常等)执行
二、要明确的事
- 开发阶段
- 编写核心业务代码(开发主线)
- 把公共代码抽取出来,制作成通知(开发阶段最后再做)
- 在配置文件中,声明切入点与通知间的关系,即切面
- Spring根据配置织入
三、AOP基于xml配置步骤
这里以日志类为通知类举例,这里主要关注配置,不关注类的关系与实现
-
maven坐标
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>5.0.2.RELEASE</version> </dependency> <dependency> <groupId>org.aspectj</groupId> <artifactId>aspectjweaver</artifactId> <version>1.8.7</version> </dependency>
-
aop约束
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd"></beans>
-
spring中基于xml的aop配置、切入点表达式的写法
<!-- 配置srping的Ioc,把service对象配置进来--> <bean id="accountService" class="club.leyvan.service.impl.AccountServiceImpl"></bean> <!--spring中基于XML的AOP配置步骤 1、把通知Bean也交给spring来管理 2、使用aop:config标签表明开始AOP的配置 3、使用aop:aspect标签表明配置切面 id属性:是给切面提供一个唯一标识 ref属性:是指定通知类bean的Id。 4、在aop:aspect标签的内部使用对应标签来配置通知的类型 我们现在示例是让printLog方法在切入点方法执行之前之前:所以是前置通知 aop:before:表示配置前置通知 method属性:用于指定Logger类中哪个方法是前置通知 pointcut属性:用于指定切入点表达式,该表达式的含义指的是对业务层中哪些方法增强 切入点表达式的写法: 关键字:execution(表达式) 表达式: 访问修饰符 返回值 包名.包名.包名...类名.方法名(参数列表) 标准的表达式写法: public void club.leyvan.service.impl.AccountServiceImpl.saveAccount() 访问修饰符可以省略 void club.leyvan.service.impl.AccountServiceImpl.saveAccount() 返回值可以使用通配符,表示任意返回值 * club.leyvan.service.impl.AccountServiceImpl.saveAccount() 包名可以使用通配符,表示任意包。但是有几级包,就需要写几个*. * *.*.*.*.AccountServiceImpl.saveAccount()) 包名可以使用..表示当前包及其子包 * *..AccountServiceImpl.saveAccount() 类名和方法名都可以使用*来实现通配 * *..*.*() 参数列表: 可以直接写数据类型: 基本类型直接写名称 int 引用类型写包名.类名的方式 java.lang.String 可以使用通配符表示任意类型,但是必须有参数 可以使用..表示有无参数均可,有参数可以是任意类型 全通配写法: * *..*.*(..) 实际开发中切入点表达式的通常写法: 切到业务层实现类下的所有方法 * club.leyvan.service.impl.*.*(..) --> <!-- 配置Logger类 --> <bean id="logger" class="club.leyvan.utils.Logger"></bean> <!--配置AOP--> <aop:config> <!--配置切面 --> <aop:aspect id="logAdvice" ref="logger"> <!-- 配置通知的类型,并且建立通知方法和切入点方法的关联--> <aop:before method="printLog" pointcut="execution(* club.leyvan.service.impl.*.*(..))"></aop:before> </aop:aspect> </aop:config>
-
常用的通知类型、环绕通知及通用化切入点表达式
<!--配置AOP-->
<aop:config>
<!-- 配置切入点表达式 id属性用于指定表达式的唯一标识。expression属性用于指定表达式内容
此标签写在aop:aspect标签内部只能当前切面使用。
它还可以写在aop:aspect外面,此时就变成了所有切面可用
-->
<aop:pointcut id="pt1" expression="execution(* club.leyvan.service.impl.*.*(..))"></aop:pointcut>
<!--配置切面 -->
<aop:aspect id="logAdvice" ref="logger">
<!-- 配置前置通知:在切入点方法执行之前执行
<aop:before method="beforePrintLog" pointcut-ref="pt1" ></aop:before>-->
<!-- 配置后置通知:在切入点方法正常执行之后值。它和异常通知永远只能执行一个
<aop:after-returning method="afterReturningPrintLog" pointcut-ref="pt1"></aop:after-returning>-->
<!-- 配置异常通知:在切入点方法执行产生异常之后执行。它和后置通知永远只能执行一个
<aop:after-throwing method="afterThrowingPrintLog" pointcut-ref="pt1"></aop:after-throwing>-->
<!-- 配置最终通知:无论切入点方法是否正常执行它都会在其后面执行
<aop:after method="afterPrintLog" pointcut-ref="pt1"></aop:after>-->
<!-- 配置环绕通知 详细的注释请看Logger类中-->
<aop:around method="aroundPringLog" pointcut-ref="pt1"></aop:around>
</aop:aspect>
</aop:config>
public Object aroundPringLog(ProceedingJoinPoint pjp) {
Object rtValue = null;
try {
Object[] args = pjp.getArgs();//得到方法执行的所需参数
System.out.println("前置通知");
rtValue = pjp.proceed(args);//明确调用切入点方法(类似于method.invoke())
System.out.println("后置通知");
return rtValue;
}catch(Throwable t){
System.out.println("异常通知");
throw new RuntimeException(t);
}finally {
System.out.println("最终通知");
}
}
-
环绕通知的问题:当配置了环绕通知之后,切入点方法没有执行,而通知执行了
-
分析:通过对比动态代理中的环绕通知代码,发现动态代理的环绕通知有明确的切入点方法调用,而我们的代码中没有
- 解决:spring框架为我们提供了一个接口:ProceedingJoinPoint。该接口有一个方法proceed(),此方法就相当于明确的调用切入点方法,该方法可以作为环绕通知的方法参数,在程序执行时,spring框架会为我们提供接口的实现类供我们使用。
环绕通知可以理解为Spring提供的一种非配置的自定义的通知类型,是通过代码的方式完成
四、AOP基于注解的配置
xml中的配置:需要添加的约束和开启注解aop的支持
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<!-- 配置spring创建容器时要扫描的包-->
<context:component-scan base-package="com.itheima"></context:component-scan>
<!-- 配置spring开启注解AOP的支持 -->
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>
- @Aspect:表示当前类是一个切面类
- @Pointcut("execution(* club.leyvan.service.impl..(..))") 放在一个空方法上比如:private void pt1(){}
- @Before(“pt1()”) 应用切入点表达式及以方法名为参数即可 注意:要加括号
- @AfterReturning(“pt1()”)
- @AfterThrowing(“pt1()”)
- @After(“pt1()”)
- 存在问题:以上四个通知类行,spring以注解调用的顺序存在问题
- @Around(“pt1()”)
- @EnableAspectJAutoProxy 不适用xml的配置方式