编写基于spring注解的aop编程案例
步骤:
/**
-
@author 刘东平
-
@version 创建时间:2019年5月2日 下午7:57:21
- Aop切面注解编程【动态代理】
-
:指在程序运行之间动态的将某段代码切入到指定方法指定位置进行运行编程方式
- 操作步骤:
- 1)、导入Aop模块:Spring Aop的依赖(spring-aspects)
- 2)、定义一个业务逻辑类(computer),在业务逻辑运行的时候将
- 日志打印一下(方法之前、方法之后、方法正常结束、方法抛出异常)
- 3)、定义一个日志切面类(ComputerAspect),切面类里面的方法需要动态的感知
- Computer.div方法运行到哪一步了。
-
通知方法:
-
前置通知:(@Before)ComputerStart,在目标方法(div)运行之前运行。
-
后置通知:(@After)ComputerEnd,在目标方法(div)运行结束之后运行
-
返回通知:(@AfterTrowing)ComputerReturn,在目标方法(div)正常返回之后运行
-
异常通知:(@AfterThrowing)ComputerException,在目标方法出现异常以后运行
-
环绕通知:动态通知,动态代理,手动推进目标方法运行(joinPoint.procced)
- 4)、给切面类的目标的方法标注何时何地运行(通知注解)
- 5)、将切面类和业务逻辑类(目标方法所在类)加入到容器当中。
- 6)、需要告诉spring那个是切面类,则需要在的切面的类添加@Aspect注解声明一下
- 7)、【关键:开启基于注解的AOP编程】需要的开启的aop切面注解@EnableAspectJAutoProxy
- 关键三步:
- 1)将业务逻辑组件和切面类都加入到容器当中,并且告诉容器的那个是切面类(@Aspect)
- 2)在切面类的每一个通知方法上标注通知注解,告诉spring的何时何地运行(切入点表达式【参照spring-aop有关文档】
- 3)开启基于注解的aop模式,@EnableAspectProxy类
*/
主配置类
package com.ldp.Srping_Annotation.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import com.ldp.Srping_Annotation.aop.Computer;
import com.ldp.Srping_Annotation.aop.ComputerAspect;
@EnableAspectJAutoProxy
@Configuration
public class MyConfigOfAspects {
//将业务逻辑类添加到容器
@Bean
public Computer computer() {
return new Computer();
}
//将切面类添加到容器
@Bean
public ComputerAspect computerAspect() {
return new ComputerAspect();
}
}
业务逻辑类Computer
package com.ldp.Srping_Annotation.aop;
//需要进行的aop编程的一个业务逻辑类computer,要对div进行切面编程
public class Computer {
//除法运算
public int div(int i,int j) {
return i/j;
}
}
切面类ComputerAspect
package com.ldp.Srping_Annotation.aop;
import java.util.ArrayList;
import java.util.Arrays;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
/**
*
* @author 刘东平
* @version 创建时间:2019年5月2日 下午8:05:07
* 这是一个切面类:需要添加@Aspect注解告诉spring容器这是一个切面类
*/
@Aspect
public class ComputerAspect {
//抽取公共的切入点表达式
//1.本类引用
//2.其他的切面引用
@Pointcut("execution(public int com.ldp.Srping_Annotation.aop.Computer.*(..))")
public void pointCut() {};
//注意JoinPoint必须放在参数列表的第一位,否则会抛异常
@Before("pointCut()")
public void ComputerStart(JoinPoint joinPoint) {
//获得参数列表
Object[] args = joinPoint.getArgs();
System.out.println(joinPoint.getSignature().getName()
+"运行中..@Before..参数列表{"+Arrays.asList(args)+"}");
}
@After("pointCut()")
public void ComputerEnd(JoinPoint joinPoint) {
System.out.println(joinPoint.getSignature().getName()
+"结束....@After");
}
@AfterReturning(value="pointCut()",returning="result")
public void ComputerReturn(JoinPoint joinPoint,Object result) {
System.out.println(joinPoint.getSignature().getName()
+"正常结束..@AfterReturning..返回值结果{"+result+"}");
}
@AfterThrowing(value="pointCut()",throwing="exception")
public void ComputerException(JoinPoint joinPoint,Exception exception) {
System.out.println(joinPoint.getSignature().getName()
+"出现异常..@AfterThrowing..异常信息{"+exception+"}");
}
}
测试类AspectsTest
package com.ldp.Srping_Annotation;
//这是一个测试Aop情况的测试类
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import com.ldp.Srping_Annotation.aop.Computer;
import com.ldp.Srping_Annotation.config.MyConfigAutowride;
import com.ldp.Srping_Annotation.config.MyConfigOfAspects;
public class AspectsTest {
private ApplicationContext applicationContext;
@Before
public void init() {
applicationContext=new AnnotationConfigApplicationContext(MyConfigOfAspects.class);
}
@Test
public void testPrintf() {
//获取容器当中所有的id名称
String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
for (String string : beanDefinitionNames) {
System.out.println(string);
}
}
@Test
public void TestAop() {
//注意自己创建的Computer调用是无法利用aop编程 的
//只有从容器当中获取到对象的,才被spring管理了,才可以进行的Soring的Aop切面编程
Computer bean = applicationContext.getBean(Computer.class);
int div = bean.div(9,3);
System.out.println("计算结果"+div);
}
}
正常测试结果:
五月 02, 2019 8:54:33 下午 org.springframework.context.annotation.AnnotationConfigApplicationContext prepareRefresh
信息: Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@e73f9ac: startup date [Thu May 02 20:54:33 CST 2019]; root of context hierarchy
五月 02, 2019 8:54:34 下午 org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor <init>
信息: JSR-330 'javax.inject.Inject' annotation found and supported for autowiring
div运行中..@Before..参数列表{[9, 3]}
div结束....@After
div正常结束..@AfterReturning..返回值结果{3}
计算结果3
异常测试
五月 02, 2019 9:02:38 下午 org.springframework.context.annotation.AnnotationConfigApplicationContext prepareRefresh
信息: Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@e73f9ac: startup date [Thu May 02 21:02:37 CST 2019]; root of context hierarchy
五月 02, 2019 9:02:38 下午 org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor <init>
信息: JSR-330 'javax.inject.Inject' annotation found and supported for autowiring
div运行中..@Before..参数列表{[9, 0]}
div结束....@After
div出现异常..@AfterThrowing..异常信息{java.lang.ArithmeticException: / by zero}
原理:
* AOP原理:【看给容器中注册了什么组件,这个组件什么时候工作,这个组件的功能是什么?】
* @EnableAspectJAutoProxy;
* 1、@EnableAspectJAutoProxy是什么?
* @Import(AspectJAutoProxyRegistrar.class):给容器中导入AspectJAutoProxyRegistrar
* 利用AspectJAutoProxyRegistrar自定义给容器中注册bean;BeanDefinetion
* internalAutoProxyCreator=AnnotationAwareAspectJAutoProxyCreator
*
* 给容器中注册一个AnnotationAwareAspectJAutoProxyCreator;
*
* 2、 AnnotationAwareAspectJAutoProxyCreator:
* AnnotationAwareAspectJAutoProxyCreator
* ->AspectJAwareAdvisorAutoProxyCreator
* ->AbstractAdvisorAutoProxyCreator
* ->AbstractAutoProxyCreator
* implements SmartInstantiationAwareBeanPostProcessor, BeanFactoryAware
* 关注后置处理器(在bean初始化完成前后做事情)、自动装配BeanFactory
*
* AbstractAutoProxyCreator.setBeanFactory()
* AbstractAutoProxyCreator.有后置处理器的逻辑;
*
* AbstractAdvisorAutoProxyCreator.setBeanFactory()-》initBeanFactory()
*
* AnnotationAwareAspectJAutoProxyCreator.initBeanFactory()
*
*
* 流程:
* 1)、传入配置类,创建ioc容器
* 2)、注册配置类,调用refresh()刷新容器;
* 3)、registerBeanPostProcessors(beanFactory);注册bean的后置处理器来方便拦截bean的创建;
* 1)、先获取ioc容器已经定义了的需要创建对象的所有BeanPostProcessor
* 2)、给容器中加别的BeanPostProcessor
* 3)、优先注册实现了PriorityOrdered接口的BeanPostProcessor;
* 4)、再给容器中注册实现了Ordered接口的BeanPostProcessor;
* 5)、注册没实现优先级接口的BeanPostProcessor;
* 6)、注册BeanPostProcessor,实际上就是创建BeanPostProcessor对象,保存在容器中;
* 创建internalAutoProxyCreator的BeanPostProcessor【AnnotationAwareAspectJAutoProxyCreator】
* 1)、创建Bean的实例
* 2)、populateBean;给bean的各种属性赋值
* 3)、initializeBean:初始化bean;
* 1)、invokeAwareMethods():处理Aware接口的方法回调
* 2)、applyBeanPostProcessorsBeforeInitialization():应用后置处理器的postProcessBeforeInitialization()
* 3)、invokeInitMethods();执行自定义的初始化方法
* 4)、applyBeanPostProcessorsAfterInitialization();执行后置处理器的postProcessAfterInitialization();
* 4)、BeanPostProcessor(AnnotationAwareAspectJAutoProxyCreator)创建成功;--》aspectJAdvisorsBuilder
* 7)、把BeanPostProcessor注册到BeanFactory中;
* beanFactory.addBeanPostProcessor(postProcessor);
* =======以上是创建和注册AnnotationAwareAspectJAutoProxyCreator的过程========
*
* AnnotationAwareAspectJAutoProxyCreator => InstantiationAwareBeanPostProcessor
* 4)、finishBeanFactoryInitialization(beanFactory);完成BeanFactory初始化工作;创建剩下的单实例bean
* 1)、遍历获取容器中所有的Bean,依次创建对象getBean(beanName);
* getBean->doGetBean()->getSingleton()->
* 2)、创建bean
* 【AnnotationAwareAspectJAutoProxyCreator在所有bean创建之前会有一个拦截,InstantiationAwareBeanPostProcessor,会调用postProcessBeforeInstantiation()】
* 1)、先从缓存中获取当前bean,如果能获取到,说明bean是之前被创建过的,直接使用,否则再创建;
* 只要创建好的Bean都会被缓存起来
* 2)、createBean();创建bean;
* AnnotationAwareAspectJAutoProxyCreator 会在任何bean创建之前先尝试返回bean的实例
* 【BeanPostProcessor是在Bean对象创建完成初始化前后调用的】
* 【InstantiationAwareBeanPostProcessor是在创建Bean实例之前先尝试用后置处理器返回对象的】
* 1)、resolveBeforeInstantiation(beanName, mbdToUse);解析BeforeInstantiation
* 希望后置处理器在此能返回一个代理对象;如果能返回代理对象就使用,如果不能就继续
* 1)、后置处理器先尝试返回对象;
* bean = applyBeanPostProcessorsBeforeInstantiation():
* 拿到所有后置处理器,如果是InstantiationAwareBeanPostProcessor;
* 就执行postProcessBeforeInstantiation
* if (bean != null) {
bean = applyBeanPostProcessorsAfterInitialization(bean, beanName);
}
*
* 2)、doCreateBean(beanName, mbdToUse, args);真正的去创建一个bean实例;和3.6流程一样;
* 3)、
*
*
* AnnotationAwareAspectJAutoProxyCreator【InstantiationAwareBeanPostProcessor】 的作用:
* 1)、每一个bean创建之前,调用postProcessBeforeInstantiation();
* 关心MathCalculator和LogAspect的创建
* 1)、判断当前bean是否在advisedBeans中(保存了所有需要增强bean)
* 2)、判断当前bean是否是基础类型的Advice、Pointcut、Advisor、AopInfrastructureBean,
* 或者是否是切面(@Aspect)
* 3)、是否需要跳过
* 1)、获取候选的增强器(切面里面的通知方法)【List<Advisor> candidateAdvisors】
* 每一个封装的通知方法的增强器是 InstantiationModelAwarePointcutAdvisor;
* 判断每一个增强器是否是 AspectJPointcutAdvisor 类型的;返回true
* 2)、永远返回false
*
* 2)、创建对象
* postProcessAfterInitialization;
* return wrapIfNecessary(bean, beanName, cacheKey);//包装如果需要的情况下
* 1)、获取当前bean的所有增强器(通知方法) Object[] specificInterceptors
* 1、找到候选的所有的增强器(找哪些通知方法是需要切入当前bean方法的)
* 2、获取到能在bean使用的增强器。
* 3、给增强器排序
* 2)、保存当前bean在advisedBeans中;
* 3)、如果当前bean需要增强,创建当前bean的代理对象;
* 1)、获取所有增强器(通知方法)
* 2)、保存到proxyFactory
* 3)、创建代理对象:Spring自动决定
* JdkDynamicAopProxy(config);jdk动态代理;
* ObjenesisCglibAopProxy(config);cglib的动态代理;
* 4)、给容器中返回当前组件使用cglib增强了的代理对象;
* 5)、以后容器中获取到的就是这个组件的代理对象,执行目标方法的时候,代理对象就会执行通知方法的流程;
*
*
* 3)、目标方法执行 ;
* 容器中保存了组件的代理对象(cglib增强后的对象),这个对象里面保存了详细信息(比如增强器,目标对象,xxx);
* 1)、CglibAopProxy.intercept();拦截目标方法的执行
* 2)、根据ProxyFactory对象获取将要执行的目标方法拦截器链;
* List<Object> chain = this.advised.getInterceptorsAndDynamicInterceptionAdvice(method, targetClass);
* 1)、List<Object> interceptorList保存所有拦截器 5
* 一个默认的ExposeInvocationInterceptor 和 4个增强器;
* 2)、遍历所有的增强器,将其转为Interceptor;
* registry.getInterceptors(advisor);
* 3)、将增强器转为List<MethodInterceptor>;
* 如果是MethodInterceptor,直接加入到集合中
* 如果不是,使用AdvisorAdapter将增强器转为MethodInterceptor;
* 转换完成返回MethodInterceptor数组;
*
* 3)、如果没有拦截器链,直接执行目标方法;
* 拦截器链(每一个通知方法又被包装为方法拦截器,利用MethodInterceptor机制)
* 4)、如果有拦截器链,把需要执行的目标对象,目标方法,
* 拦截器链等信息传入创建一个 CglibMethodInvocation 对象,
* 并调用 Object retVal = mi.proceed();
* 5)、拦截器链的触发过程;
* 1)、如果没有拦截器执行执行目标方法,或者拦截器的索引和拦截器数组-1大小一样(指定到了最后一个拦截器)执行目标方法;
* 2)、链式获取每一个拦截器,拦截器执行invoke方法,每一个拦截器等待下一个拦截器执行完成返回以后再来执行;
* 拦截器链的机制,保证通知方法与目标方法的执行顺序;
*
* 总结:
* 1)、 @EnableAspectJAutoProxy 开启AOP功能
* 2)、 @EnableAspectJAutoProxy 会给容器中注册一个组件 AnnotationAwareAspectJAutoProxyCreator
* 3)、AnnotationAwareAspectJAutoProxyCreator是一个后置处理器;
* 4)、容器的创建流程:
* 1)、registerBeanPostProcessors()注册后置处理器;创建AnnotationAwareAspectJAutoProxyCreator对象
* 2)、finishBeanFactoryInitialization()初始化剩下的单实例bean
* 1)、创建业务逻辑组件和切面组件
* 2)、AnnotationAwareAspectJAutoProxyCreator拦截组件的创建过程
* 3)、组件创建完之后,判断组件是否需要增强
* 是:切面的通知方法,包装成增强器(Advisor);给业务逻辑组件创建一个代理对象(cglib);
* 5)、执行目标方法:
* 1)、代理对象执行目标方法
* 2)、CglibAopProxy.intercept();
* 1)、得到目标方法的拦截器链(增强器包装成拦截器MethodInterceptor)
* 2)、利用拦截器的链式机制,依次进入每一个拦截器进行执行;
* 3)、效果:
* 正常执行:前置通知-》目标方法-》后置通知-》返回通知
* 出现异常:前置通知-》目标方法-》后置通知-》异常通知
*
*
*
*/