Java Spring -- AOP详解

一. AOP概念1.1 什么是 AOPAOP 的全称是 Aspect-Oriented Programming即面向切面编程。如果说面向对象编程OOP是将系统纵向划分为一个个独立的模块如用户模块、订单模块那么AOP 就是将这些模块中公共的、非业务的逻辑横向抽取出来形成一个个“切面”。简单来说AOP 是一种在不修改源代码的情况下给程序动态统一添加额外功能的技术。1.2 为什么要用 AOP在传统的开发中我们经常遇到这样的场景需要在每个业务方法执行前记录日志需要在涉及数据库操作的方法前后开启和提交事务需要在敏感接口调用前进行权限校验。如果不用 AOP我们只能把这些代码日志、事务、权限重复地写死在每一个业务方法里。这会导致两个严重问题代码冗余大量的非业务代码混杂在业务逻辑中导致代码臃肿。维护困难一旦日志格式变了或者事务策略改了你需要修改成百上千个方法极易出错。AOP 的核心价值就在于“解耦”。它利用一种称为“横切”的技术剖开封装的对象内部并将那些影响了多个类的公共行为封装到一个可重用模块即“切面”中。这样业务类只需要关注自己的核心逻辑而日志、事务等“脏活累活”全交给 AOP 处理。1.3 AOP 核心术语概念单词解释目标对象Target被增强的方法所在的对象代理对象Proxy对目标对象进行增强后的对象客户端实际调用的对象连接点Joinpoint目标对象中可以被增强的方法切入点Pointcut目标对象中实际被增强的方法通知\增强Advice增强部分的代码逻辑切面Aspect增强和切入点的组合织入Weaving将通知和切入点组合动态组合的过程二. 基于xml实现AOP2.1 快速入门1、导入AOP相关坐标dependencygroupIdorg.aspectj/groupIdartifactIdaspectjweaver/artifactIdversion1.9.6/version/dependency2、准备目标类、准备增强类并配置给Spring管理publicinterfaceUserService{voidshow1();voidshow2();}publicclassUserServiceImplimplementsUserService{publicvoidshow1(){System.out.println(show1...);}publicvoidshow2(){System.out.println(show2...);}}publicclassMyAdvice{publicvoidbeforeAdvice(){System.out.println(beforeAdvice);}publicvoidafterAdvice(){System.out.println(afterAdvice);}}!--配置目标类,内部的方法是连接点--beaniduserServiceclasscom.itheima.service.impl.UserServiceImpl/!--配置通知类,内部的方法是增强方法--bean id“myAdvice classcom.itheima.advice.MyAdvice/3、配置切点表达式哪些方法被增强4、配置织入切点被哪些通知方法增强是前置增强还是后置增强aop:config!--配置切点表达式,对哪些方法进行增强--aop:pointcutidmyPointcutexpressionexecution(void com.itheima.service.impl.UserServiceImpl.show1())/!--切面切点通知--aop:aspectrefmyAdvice!--指定前置通知方法是beforeAdvice--aop:beforemethodbeforeAdvicepointcut-refmyPointcut/!--指定后置通知方法是afterAdvice--aop:after-returningmethodafterAdvicepointcut-refmyPointcut//aop:aspect/aop:config2.2 配置详解切点表达式是配置要对哪些连接点哪些类的哪些方法进行通知的增强语法如下execution(访问修饰符? 返回值 包名.类名.?方法名(方法参数) throws 异常?)其中带?的表示可以省略的部分访问修饰符可以省略不写返回值类型、某一级包名、类名、方法名 可以使用 * 表示任意包名与类名之间使用单点 . 表示该包下的类使用双点 … 表示该包及其子包下的类参数列表可以使用两个点 … 表示任意参数。throws 异常可省略注意是方法上声明抛出的异常不是实际抛出的异常示例//表示访问修饰符为public、无返回值、在com.itheima.aop包下的TargetImpl类的无参方法showexecution(publicvoidcom.itheima.aop.TargetImpl.show())//表述com.itheima.aop包下的TargetImpl类的任意方法execution(*com.itheima.aop.TargetImpl.*(..))//表示com.itheima.aop包下的任意类的任意方法execution(*com.itheima.aop.*.*(..))//表示com.itheima.aop包及其子包下的任意类的任意方法execution(*com.itheima.aop..*.*(..))//表示任意包中的任意类的任意方法execution(**..*.*(..))AspectJ的通知由以下五种类型通知名称配置方式执行时机前置通知aop:before目标方法执行之前执行后置通知aop:after-returning目标方法执行之后执行若目标方法抛出异常则不再执行环绕通知aop:around目标方法执行前后执行若目标方法抛出异常则环绕通知的后半部分不再执行异常通知aop:after-throwing目标方法抛出异常时执行最终通知aop:after不管目标方法是否有异常最终都会执行类似finally块通知方法在被调用时Spring可以为其传递一些必要的参数参数类型作用JoinPoint连接点对象任何通知都可使用。可以获得当前目标对象、目标方法参数等信息。ProceedingJoinPointJoinPoint 的子类对象主要用于环绕通知中。通过执行其proceed()方法来调用并执行目标方法。Throwable异常对象专门用于异常通知中。需要在配置文件中指定接收该异常对象的参数名称以便在通知逻辑中获取并处理异常信息。2.3 配置原理1. 解析入口AopNamespaceHandler当 Spring 容器启动并加载 XML 配置文件时一旦遇到 aop:config、 aop:aspect 等 AOP 专属标签Spring 会找到对应的命名空间处理器AopNamespaceHandler。在这个处理器的 init() 方法中Spring 注册了针对不同标签的解析器 aop:config 标签由 ConfigBeanDefinitionParser 负责解析。 aop:aspectj-autoproxy 标签由 AspectJAutoProxyBeanDefinitionParser 负责解析。2. 核心解析ConfigBeanDefinitionParser当我们使用 aop:config 进行配置时ConfigBeanDefinitionParser 的 parse() 方法是核心入口。它主要做了两件至关重要的事情注册自动代理创建器它会向 Spring 容器中注册一个名为 AspectJAwareAdvisorAutoProxyCreator 的 Bean。这个类实现了 BeanPostProcessorBean 后置处理器接口它是 Spring AOP 在 XML 模式下的“幕后英雄”负责在 Bean 初始化时判断并创建代理对象。解析切面与通知它会遍历 aop:config 下的子元素将 aop:pointcut切点、 aop:aspect切面以及 aop:before通知等标签解析为内部的BeanDefinition并注册到容器中。这些 BeanDefinition 最终会被组装成 Advisor顾问即“在哪里切点做什么通知”的完整描述。3. 核心实现Bean 后置处理流程AspectJAwareAdvisorAutoProxyCreator继承了 AbstractAutoProxyCreator而后者实现了BeanPostProcessor接口。这意味着容器中每一个 Bean 在初始化完成后都会经过它的“审查”。它的核心逻辑体现在 postProcessAfterInitialization() 方法中// 简化版源码逻辑publicObjectpostProcessAfterInitialization(Objectbean,StringbeanName){if(bean!null){// 1. 判断当前 Bean 是否需要被代理// 内部会获取所有 Advisor并与当前 Bean 的方法进行切点匹配Object[]specificInterceptorsgetAdvicesAndAdvisorsForBean(bean.getClass(),beanName,null);// 2. 如果匹配到了通知即 specificInterceptors 不为空则创建代理对象if(specificInterceptors!DO_NOT_PROXY){// 调用代理工厂根据 JDK 或 CGLIB 生成代理对象returncreateProxy(bean.getClass(),beanName,specificInterceptors,newSingletonTargetSource(bean));}}// 3. 如果不匹配直接返回原始 Beanreturnbean;}三. 基于注解实现AOP3.1 快速入门导入 AOP 相关坐标与 XML 方式相同需要引入 AspectJ 的依赖dependencygroupIdorg.aspectj/groupIdartifactIdaspectjweaver/artifactIdversion1.9.6/version/dependency准备目标类与增强类目标类依然是我们的 UserServiceImpl。增强类切面类需要使用 Component 注册到 Spring 容器并使用 Aspect 注解声明它是一个切面。// 目标类ServicepublicclassUserServiceImplimplementsUserService{Overridepublicvoidshow1(){System.out.println(show1...);}Overridepublicvoidshow2(){System.out.println(show2...);}}// 切面类增强类Component// 1. 注册到 Spring 容器Aspect// 2. 声明这是一个切面类publicclassLogAspect{// 前置通知Before(execution(* com.itheima.service.impl.UserServiceImpl.*(..)))publicvoidbeforeAdvice(){System.out.println(【注解AOP】前置通知方法执行前...);}// 后置通知AfterReturning(execution(* com.itheima.service.impl.UserServiceImpl.*(..)))publicvoidafterAdvice(){System.out.println(【注解AOP】后置通知方法执行后...);}}开启 AOP 自动代理在 Spring Boot 项目中引入 spring-boot-starter-aop 依赖后会自动开启。如果是传统 Spring 项目需要在配置类或 XML 中显式开启// 方式一在配置类上添加注解EnableAspectJAutoProxyConfigurationpublicclassAopConfig{}// 方式二在 XML 中开启// aop:aspectj-autoproxy/3.2 配置详解各种注解方式通知类型//前置通知Before(execution(* com.itheima.aop.*.*(..)))publicvoidbefore(JoinPointjoinPoint){}//后置通知AfterReturning(execution(* com.itheima.aop.*.*(..)))publicvoidAfterReturning(JoinPointjoinPoint){}//环绕通知Around(execution(* com.itheima.aop.*.*(..)))publicvoidaround(ProceedingJoinPointjoinPoint)throwsThrowable{}//异常通知AfterThrowing(execution(* com.itheima.aop.*.*(..)))publicvoidAfterThrowing(JoinPointjoinPoint){}//最终通知After(execution(* com.itheima.aop.*.*(..)))publicvoidAfter(JoinPointjoinPoint){}切点表达式的抽取使用一个空方法将切点表达式标注在空方法上其他通知方法引用即可ComponentAspectpublicclassAnnoAdvice{//切点表达式抽取Pointcut(execution(* com.itheima.aop.*.*(..)))publicvoidpointcut(){}//前置通知Before(pointcut())publicvoidbefore(JoinPointjoinPoint){}//后置通知AfterReturning(AnnoAdvice.pointcut())publicvoidAfterReturning(JoinPointjoinPoint){}// ... 省略其他代码 ...}XML 与注解的对照表XML 配置方式对应的注解作用说明aop:aspectAspect声明当前类是一个切面类aop:pointcutPointcut定义切点表达式可复用aop:beforeBefore前置通知在目标方法执行前执行aop:after-returningAfterReturning后置通知在目标方法成功返回后执行aop:aroundAround环绕通知功能最强大可控制目标方法执行aop:after-throwingAfterThrowing异常通知在目标方法抛出异常后执行aop:afterAfter最终通知无论是否异常都会执行3.3 配置原理1. 核心驱动注解EnableAspectJAutoProxy在 XML 配置中我们需要通过aop:aspectj-autoproxy/标签来开启 AOP 支持。而在纯注解开发中我们通常在配置类上使用EnableAspectJAutoProxy注解来代替它。ConfigurationComponentScan(com.itheima)EnableAspectJAutoProxy// 开启 Spring 对 AspectJ 自动代理的支持publicclassSpringConfig{}这个注解虽然看起来很简单但它背后做了两件至关重要的事情注册组件它通过Import(AspectJAutoProxyRegistrar.class)导入了一个注册器。注册核心 Bean该注册器会向 Spring 容器中注册一个名为AnnotationAwareAspectJAutoProxyCreator的 Bean。2. 核心解析AnnotationAwareAspectJAutoProxyCreatorAnnotationAwareAspectJAutoProxyCreator是 Spring AOP 在注解模式下的“幕后英雄”。它同样实现了BeanPostProcessorBean 后置处理器接口负责在 Bean 初始化时判断并创建代理对象。它的主要工作包括扫描切面在容器启动时扫描所有被Aspect标注的类并解析其中的 Pointcut、Before 等注解将它们封装成内部的 Advisor顾问。后置处理在每一个 Bean 初始化完成后判断该 Bean 是否匹配切点表达式如果匹配则创建代理对象。3. 核心实现Bean 后置处理流程与 XML 模式类似AnnotationAwareAspectJAutoProxyCreator继承了 AbstractAutoProxyCreator其核心逻辑同样体现在 postProcessAfterInitialization() 方法中// 简化版源码逻辑publicObjectpostProcessAfterInitialization(Objectbean,StringbeanName){if(bean!null){// 1. 判断当前 Bean 是否需要被代理// 内部会获取所有 Advisor并与当前 Bean 的方法进行切点匹配Object[]specificInterceptorsgetAdvicesAndAdvisorsForBean(bean.getClass(),beanName,null);// 2. 如果匹配到了通知即 specificInterceptors 不为空则创建代理对象if(specificInterceptors!DO_NOT_PROXY){// 调用代理工厂根据 JDK 或 CGLIB 生成代理对象returncreateProxy(bean.getClass(),beanName,specificInterceptors,newSingletonTargetSource(bean));}}// 3. 如果不匹配直接返回原始 Beanreturnbean;}四. 动态代理Spring AOP 的底层是通过动态代理来实现的。当 Spring 容器调用 getProxy() 方法创建代理对象时会根据目标类的具体情况选择以下两种动态代理技术之一代理技术使用条件配置方式JDK 动态代理技术目标类有接口是基于接口动态生成实现类的代理对象目标类有接口的情况下默认方式Cglib 动态代理技术目标类无接口且不能使用 final 修饰是基于被代理对象动态生成子对象为代理对象目标类无接口时默认使用该方式目标类有接口时手动配置aop:config proxy-target-classtrue强制使用 Cglib 方式JDK动态代理JDK 动态代理是 Java 原生提供的代理机制它的核心要求是目标类必须实现接口。// 代理工厂用来创建代理对象publicclassUserServiceProxyFactory{// 持有目标对象真实用户服务privateUserServiceuserServicenewUserServiceImpl();publicUserServicegetProxyObject(){// 使用 Proxy.newProxyInstance 获取代理对象/* * 参数说明 * 1. ClassLoader loader类加载器使用目标对象的类加载器即可 * 2. Class?[] interfaces目标对象实现的所有接口代理类会实现这些接口 * 3. InvocationHandler h代理对象的调用处理程序核心逻辑写在这里 */UserServiceproxy(UserService)Proxy.newProxyInstance(userService.getClass().getClassLoader(),userService.getClass().getInterfaces(),newInvocationHandler(){/* * invoke 方法会在代理对象调用任何接口方法时触发 * 参数说明 * proxy代理对象本身 * method当前被调用的方法的 Method 实例 * args调用方法时传递的实际参数 */OverridepublicObjectinvoke(Objectproxy,Methodmethod,Object[]args)throwsThrowable{// 1. 前置增强逻辑相当于 Spring AOP 的前置通知System.out.println(【JDK动态代理】方法 method.getName() 开始执行...);// 2. 通过反射调用目标对象的真实方法Objectresultmethod.invoke(userService,args);// 3. 后置增强逻辑相当于 Spring AOP 的后置通知System.out.println(【JDK动态代理】方法 method.getName() 执行完毕。);returnresult;}});returnproxy;}}CGLIB动态代理dependencygroupIdcglib/groupIdartifactIdcglib/artifactIdversion2.2.2/version/dependency// 代理工厂实现 MethodInterceptor 接口publicclassUserServiceCglibProxyFactoryimplementsMethodInterceptor{// 持有目标对象真实用户服务privateUserServiceImpluserServicenewUserServiceImpl();publicUserServiceImplgetProxyObject(){// 1. 创建 Enhancer 对象类似于 JDK 代理中的 Proxy 类EnhancerenhancernewEnhancer();// 2. 设置父类的字节码对象告诉 CGLIB 要继承谁enhancer.setSuperclass(userService.getClass());// 3. 设置回调函数相当于 JDK 代理中的 InvocationHandlerenhancer.setCallback(this);// 4. 创建并返回代理对象UserServiceImplproxy(UserServiceImpl)enhancer.create();returnproxy;}/* * intercept 方法会在代理对象调用任何方法时触发 * 参数说明 * o代理对象 * method真实对象中方法的 Method 实例 * args实际参数 * methodProxy代理对象中方法的 MethodProxy 实例 */OverridepublicObjectintercept(Objecto,Methodmethod,Object[]args,MethodProxymethodProxy)throwsThrowable{// 1. 前置增强逻辑相当于 Spring AOP 的前置通知System.out.println(【CGLIB动态代理】方法 method.getName() 开始执行...);// 2. 调用父类真实对象的方法// 注意这里使用的是 methodProxy.invokeSuper而不是 method.invokeObjectresultmethodProxy.invokeSuper(o,args);// 3. 后置增强逻辑相当于 Spring AOP 的后置通知System.out.println(【CGLIB动态代理】方法 method.getName() 执行完毕。);returnresult;}}