英文商城网站模板,网页图片高清,免费个人网站建站申请,网站 建设 步骤前面写过 Spring IOC 的源码分析#xff0c;很多读者希望可以出一个 Spring AOP 的源码分析#xff0c;不过 Spring AOP 的源码还是比较多的#xff0c;写出来不免篇幅会大些。本文不介绍源码分析#xff0c;而是介绍 Spring AOP 中的一些概念#xff0c;以及它的各种配置… 前面写过 Spring IOC 的源码分析很多读者希望可以出一个 Spring AOP 的源码分析不过 Spring AOP 的源码还是比较多的写出来不免篇幅会大些。本文不介绍源码分析而是介绍 Spring AOP 中的一些概念以及它的各种配置方法涵盖了 Spring AOP 发展到现在出现的全部 3 种配置方式。由于 Spring 强大的向后兼容性实际代码中往往会出现很多配置混杂的情况而且居然还能工作本文希望帮助大家理清楚这些知识。本文使用的测试源码已上传到 Githubhongjiev/spring-aop-learning。AOP, AspectJ, Spring AOP我们先来把它们的概念和关系说说清楚。AOP 要实现的是在我们原来写的代码的基础上进行一定的包装如在方法执行前、方法返回后、方法抛出异常后等地方进行一定的拦截处理或者叫增强处理。AOP 的实现并不是因为 Java 提供了什么神奇的钩子可以把方法的几个生命周期告诉我们而是我们要实现一个代理实际运行的实例其实是生成的代理类的实例。作为 Java 开发者我们都很熟悉 AspectJ 这个词甚至于我们提到 AOP 的时候想到的往往就是 AspectJ即使你可能不太懂它是怎么工作的。这里我们把 AspectJ 和 Spring AOP 做个简单的对比Spring AOP它基于动态代理来实现。默认地如果使用接口的用 JDK 提供的动态代理实现如果没有接口使用 CGLIB 实现。大家一定要明白背后的意思包括什么时候会不用 JDK 提供的动态代理而用 CGLIB 实现。Spring 3.2 以后spring-core 直接就把 CGLIB 和 ASM 的源码包括进来了这也是为什么我们不需要显示引入这两个依赖。Spring 的 IOC 容器和 AOP 都很重要Spring AOP 需要依赖于 IOC 容器来管理。如果你是 web 开发者有些时候你可能需要的是一个 Filter 或一个 Interceptor而不一定是 AOP。Spring AOP 只能作用于 Spring 容器中的 Bean它是使用纯粹的 Java 代码实现的只能作用于 bean 的方法。Spring 提供了 AspectJ 的支持后面我们会单独介绍怎么使用一般来说我们用纯的 Spring AOP 就够了。很多人会对比 Spring AOP 和 AspectJ 的性能Spring AOP 是基于代理实现的在容器启动的时候需要生成代理实例在方法调用上也会增加栈的深度使得 Spring AOP 的性能不如 AspectJ 那么好。AspectJAspectJ 出身也是名门来自于 Eclipse 基金会linkhttps://www.eclipse.org/aspectj属于静态织入它是通过修改代码来实现的它的织入时机可以是Compile-time weaving编译期织入如类 A 使用 AspectJ 添加了一个属性类 B 引用了它这个场景就需要编译期的时候就进行织入否则没法编译类 B。Post-compile weaving也就是已经生成了 .class 文件或已经打成 jar 包了这种情况我们需要增强处理的话就要用到编译后织入。Load-time weaving指的是在加载类的时候进行织入要实现这个时期的织入有几种常见的方法。1、自定义类加载器来干这个这个应该是最容易想到的办法在被织入类加载到 JVM 前去对它进行加载这样就可以在加载的时候定义行为了。2、在 JVM 启动的时候指定 AspectJ 提供的 agent-javaagent:xxx/xxx/aspectjweaver.jar。AspectJ 能干很多 Spring AOP 干不了的事情它是 AOP 编程的完全解决方案。Spring AOP 致力于解决的是企业级开发中最普遍的 AOP 需求方法织入而不是力求成为一个像 AspectJ 一样的 AOP 编程完全解决方案。因为 AspectJ 在实际代码运行前完成了织入所以大家会说它生成的类是没有额外运行时开销的。很快我会专门写一篇文章介绍 AspectJ 的使用以及怎么在 Spring 应用中使用 AspectJ。在这里不准备解释那么多 AOP 编程中的术语了我们碰到一个说一个吧。Spring AOP首先要说明的是这里介绍的 Spring AOP 是纯的 Spring 代码和 AspectJ 没什么关系但是 Spring 延用了 AspectJ 中的概念包括使用了 AspectJ 提供的 jar 包中的注解但是不依赖于其实现功能。后面介绍的如 Aspect、Pointcut、Before、After 等注解下面我们来介绍 Spring AOP 的使用方法先从最简单的配置方式开始说起这样读者想看源码也会比较容易。目前 Spring AOP 一共有三种配置方式Spring 做到了很好地向下兼容所以大家可以放心使用。Spring 1.2 基于接口的配置最早的 Spring AOP 是完全基于几个接口的想看源码的同学可以从这里起步。Spring 2.0 schema-based 配置Spring 2.0 以后使用 XML 的方式来配置使用 命名空间 aop /Spring 2.0 AspectJ 配置使用注解的方式来配置这种方式感觉是最方便的还有这里虽然叫做 AspectJ但是这个和 AspectJ 其实没啥关系。Spring 1.2 中的配置这节我们将介绍 Spring 1.2 中的配置这是最古老的配置但是由于 Spring 提供了很好的向后兼容以及很多人根本不知道什么配置是什么版本的以及是否有更新更好的配置方法替代所以还是会有很多代码是采用这种古老的配置方式的这里说的古老并没有贬义。下面用一个简单的例子来演示怎么使用 Spring 1.2 的配置方式。首先我们先定义两个接口 UserService 和 OrderService以及它们的实现类 UserServiceImpl 和 OrderServiceImpl接下来我们定义两个 advice分别用于拦截方法执行前和方法返回后advice 是我们接触的第一个概念记住它是干什么用的上面的两个 Advice 分别用于方法调用前输出参数和方法调用后输出结果。现在可以开始配置了我们配置一个名为 spring_1_2.xml 的文件接下来我们跑起来看看查看输出结果准备执行方法: createUser, 参数列表[Tom, Cruise, 55]方法返回User{firstNameTom, lastNameCruise, age55, addressnull}准备执行方法: queryUser, 参数列表[]方法返回User{firstNameTom, lastNameCruise, age55, addressnull}从结果可以看到对 UserService 中的两个方法都做了前、后拦截。这个例子理解起来应该非常简单就是一个代理实现。代理模式需要一个接口、一个具体实现类然后就是定义一个代理类用来包装实现类添加自定义逻辑在使用的时候需要用代理类来生成实例。此中方法有个致命的问题如果我们需要拦截 OrderService 中的方法那么我们还需要定义一个 OrderService 的代理。如果还要拦截 PostService得定义一个 PostService 的代理......而且我们看到我们的拦截器的粒度只控制到了类级别类中所有的方法都进行了拦截。接下来我们看看怎么样只拦截特定的方法。在上面的配置中配置拦截器的时候interceptorNames 除了指定为 Advice是还可以指定为 Interceptor 和 Advisor 的。这里我们来理解 Advisor 的概念它也比较简单它内部需要指定一个 AdviceAdvisor 决定该拦截哪些方法拦截后需要完成的工作还是内部的 Advice 来做。它有好几个实现类这里我们使用实现类 NameMatchMethodPointcutAdvisor 来演示从名字上就可以看出来它需要我们给它提供方法名字这样符合该配置的方法才会做拦截。注意这里的 mappedNames 配置是可以指定多个的用逗号分隔可以是不同类中的方法。输出结果如下只有 createUser 方法被拦截准备执行方法: createUser, 参数列表[Tom, Cruise, 55]到这里我们已经了解了 Advice 和 Advisor 了前面也说了还可以配置 Interceptor。对于 Java 开发者来说对 Interceptor 这个概念肯定都很熟悉了这里就不做演示了贴一下实现代码public class DebugInterceptor implements MethodInterceptor { public Object invoke(MethodInvocation invocation) throws Throwable { System.out.println(Before: invocation[ invocation ]); // 执行 真实实现类 的方法 Object rval invocation.proceed(); System.out.println(Invocation returned); return rval; }}上面的代码有个问题那就是我们得为每个 bean 都配置一个代理之后获取 bean 的时候需要获取这个代理类的 bean 实例如 (UserService) context.getBean(userServiceProxy)这显然非常不方便不利于我们之后要使用的自动根据类型注入。下面介绍 autoproxy 的解决方案。autoproxy从名字我们也可以看出来它是实现自动代理也就是说当 Spring 发现一个 bean 需要被切面织入的时候Spring 会自动生成这个 bean 的一个代理来拦截方法的执行确保定义的切面能被执行。这里强调自动也就是说 Spring 会自动做这件事而不用像前面介绍的我们需要显示地指定代理类的 bean。我们去掉原来的 proxy 配置改为使用 BeanNameAutoProxyCreator 来配置配置很简单beanNames 中可以使用正则来匹配 bean 的名字。这样配置出来以后userServiceBeforeAdvice 和 userServiceAfterAdvice 这两个拦截器就不仅仅可以作用于 UserServiceImpl 了也可以作用于 OrderServiceImpl、PostServiceImpl、ArticleServiceImpl......等等也就是说不再是配置某个 bean 的代理了。注意这里的 InterceptorNames 和前面一样也是可以配置成 advisor 的。然后我们修改下使用的地方发现没有我们在使用的时候完全不需要关心代理了直接使用原来的类型就可以了还是非常方便的。输出结果就是 OrderService 和 UserService 中的每个方法都得到了拦截准备执行方法: createUser, 参数列表[Tom, Cruise, 55]方法返回User{firstNameTom, lastNameCruise, age55, addressnull}准备执行方法: queryUser, 参数列表[]方法返回User{firstNameTom, lastNameCruise, age55, addressnull}准备执行方法: createOrder, 参数列表[Leo, 随便买点什么]方法返回Order{usernameLeo, product随便买点什么}准备执行方法: queryOrder, 参数列表[Leo]方法返回Order{usernameLeo, product随便买点什么}到这里是不是发现 BeanNameAutoProxyCreator 非常好用它需要指定被拦截类名的模式(如 *ServiceImpl)它可以配置多次这样就可以用来匹配不同模式的类了。另外在 BeanNameAutoProxyCreator 同一个包中还有一个非常有用的类 DefaultAdvisorAutoProxyCreator比上面的 BeanNameAutoProxyCreator 还要方便。之前我们说过advisor 内部包装了 adviceadvisor 负责决定拦截哪些方法内部 advice 定义拦截后的逻辑。所以仔细想想其实就是只要让我们的 advisor 生效就能实现我们需要的自定义拦截功能、拦截后的逻辑处理。1、我们需要再回头看下 Advisor 的配置上面我们用了 NameMatchMethodPointcutAdvisor 这个类bean idlogCreateAdvisor classorg.springframework.aop.support.NameMatchMethodPointcutAdvisor property nameadvice reflogArgsAdvice / property namemappedNames valuecreateUser,createOrder //bean其实 Advisor 还有一个更加灵活的实现类 RegexpMethodPointcutAdvisor它能实现正则匹配如bean idlogArgsAdvisor classorg.springframework.aop.support.RegexpMethodPointcutAdvisor property nameadvice reflogArgsAdvice / property namepattern valuecom.javadoop.*.service.*.create.* //bean也就是说我们能通过配置 Advisor精确定位到需要被拦截的方法然后使用内部的 Advice 执行逻辑处理。2、之后我们需要配置 DefaultAdvisorAutoProxyCreator它的配置非常简单直接使用下面这段配置就可以了它就会使得所有的 Advisor 自动生效无须其他配置。bean classorg.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator /然后我们运行一下输出准备执行方法: createUser, 参数列表[Tom, Cruise, 55]方法返回User{firstNameTom, lastNameCruise, age55, addressnull}准备执行方法: createOrder, 参数列表[Leo, 随便买点什么]方法返回Order{usernameLeo, product随便买点什么}从结果可以看出create 方法使用了 logArgsAdvisor 进行传参输出query 方法使用了 logResultAdvisor 进行了返回结果输出。到这里Spring 1.2 的配置就要介绍完了。本文不会介绍得面面俱到主要是关注最核心的配置如果读者感兴趣要学会自己去摸索比如这里的 Advisor 就不只有我这里介绍的 NameMatchMethodPointcutAdvisor 和 RegexpMethodPointcutAdvisorAutoProxyCreator 也不仅仅是 BeanNameAutoProxyCreator 和 DefaultAdvisorAutoProxyCreator。Spring 2.0 AspectJ 配置Spring 2.0 以后引入了 AspectJ 和 Schema-based 的两种配置方式我们先来介绍 AspectJ 的配置方式之后我们再来看使用 xml 的配置方式。注意了AspectJ 和 AspectJ 没多大关系并不是说基于 AspectJ 实现的而仅仅是使用了 AspectJ 中的概念包括使用的注解也是直接来自于 AspectJ 的包。首先我们需要依赖 aspectjweaver.jar 这个包这个包来自于 AspectJdependency groupIdorg.aspectj/groupId artifactIdaspectjweaver/artifactId version1.8.11/version/dependency如果是使用 Spring Boot 的话添加以下依赖即可dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-aop/artifactId/dependency在 AspectJ 的配置方式中之所以要引入 aspectjweaver 并不是因为我们需要使用 AspectJ 的处理功能而是因为 Spring 使用了 AspectJ 提供的一些注解实际上还是纯的 Spring AOP 代码。说了这么多明确一点AspectJ 采用注解的方式来配置使用 Spring AOP。首先我们需要开启 AspectJ 的注解配置方式有两种方式1、在 xml 中配置aop:aspectj-autoproxy/2、使用 EnableAspectJAutoProxyConfigurationEnableAspectJAutoProxypublic class AppConfig {}亲测好像不开启也是可以的测试了 Spring 3.2-5.0这我就不太理解了难道是我的环境问题。一旦开启了上面的配置那么所有使用 Aspect 注解的 bean 都会被 Spring 当做用来实现 AOP 的配置类我们称之为一个 Aspect。注意了Aspect 注解要作用在 bean 上面不管是使用 Component 等注解方式还是在 xml 中配置 bean首先它需要是一个 bean。比如下面这个 bean它的类名上使用了 Aspect它就会被当做 Spring AOP 的配置。bean idmyAspect classorg.xyz.NotVeryUsefulAspect !-- configure properties of aspect here as normal --/beanpackage org.xyz;import org.aspectj.lang.annotation.Aspect;Aspectpublic class NotVeryUsefulAspect {}接下来我们需要关心的是 Aspect 注解的 bean 中我们需要配置哪些内容。首先我们需要配置 PointcutPointcut 在大部分地方被翻译成切点用于定义哪些方法需要被增强或者说需要被拦截有点类似于之前介绍的 Advisor 的方法匹配。Spring AOP 只支持 bean 中的方法不像 AspectJ 那么强大所以我们可以认为 Pointcut 就是用来匹配 Spring 容器中的所有 bean 的方法的。Pointcut(execution(* transfer(..)))// the pointcut expressionprivate void anyOldTransfer() {}// the pointcut signature我们看到Pointcut 中使用了 execution 来正则匹配方法签名这也是最常用的除了 execution我们再看看其他的几个比较常用的匹配方式within指定所在类或所在包下面的方法Spring AOP 独有如 Pointcut(within(com.javadoop.springaoplearning.service..*))annotation方法上具有特定的注解如 Subscribe 用于订阅特定的事件。如 Pointcut(execution( .*(..)) annotation(com.javadoop.annotation.Subscribe))bean(idOrNameOfBean)匹配 bean 的名字Spring AOP 独有如 Pointcut(bean(*Service))Tips上面匹配中通常 . 代表一个包名.. 代表包及其子包方法参数任意匹配使用两个点 ..。对于 web 开发者Spring 有个很好的建议就是定义一个 SystemArchitectureAspectpublic class SystemArchitecture { // web 层 Pointcut(within(com.javadoop.web..*)) public void inWebLayer() {} // service 层 Pointcut(within(com.javadoop.service..*)) public void inServiceLayer() {} // dao 层 Pointcut(within(com.javadoop.dao..*)) public void inDataAccessLayer() {} // service 实现注意这里指的是方法实现其实通常也可以使用 bean(*ServiceImpl) Pointcut(execution(* com.javadoop..service.*.*(..))) public void businessService() {} // dao 实现 Pointcut(execution(* com.javadoop.dao.*.*(..))) public void dataAccessOperation() {}}上面这个 SystemArchitecture 很好理解该 Aspect 定义了一堆的 Pointcut随后在任何需要 Pointcut 的地方都可以直接引用如 xml 中的 pointcut-ref。配置 pointcut 就是配置我们需要拦截哪些方法接下来我们要配置需要对这些被拦截的方法做什么也就是前面介绍的 Advice。接下来我们要配置 Advice。下面这块代码示例了各种常用的情况注意实际写代码的时候不要把所有的切面都揉在一个 class 中。Aspectpublic class AdviceExample { // 这里会用到我们前面说的 SystemArchitecture // 下面方法就是写拦截 dao层实现 Before(com.javadoop.aop.SystemArchitecture.dataAccessOperation()) public void doAccessCheck() { // ... 实现代码 } // 当然我们也可以直接内联Pointcut直接在这里定义 Pointcut // 把 Advice 和 Pointcut 合在一起了但是这两个概念我们还是要区分清楚的 Before(execution(* com.javadoop.dao.*.*(..))) public void doAccessCheck() { // ... 实现代码 } AfterReturning(com.javadoop.aop.SystemArchitecture.dataAccessOperation()) public void doAccessCheck() { // ... } AfterReturning( pointcutcom.javadoop.aop.SystemArchitecture.dataAccessOperation(), returningretVal) public void doAccessCheck(Object retVal) { // 这样进来这个方法的处理时候retVal 就是相应方法的返回值是不是非常方便 // ... 实现代码 } // 异常返回 AfterThrowing(com.javadoop.aop.SystemArchitecture.dataAccessOperation()) public void doRecoveryActions() { // ... 实现代码 } AfterThrowing( pointcutcom.javadoop.aop.SystemArchitecture.dataAccessOperation(), throwingex) public void doRecoveryActions(DataAccessException ex) { // ... 实现代码 } // 注意理解它和 AfterReturning 之间的区别这里会拦截正常返回和异常的情况 After(com.javadoop.aop.SystemArchitecture.dataAccessOperation()) public void doReleaseLock() { // 通常就像 finally 块一样使用用来释放资源。 // 无论正常返回还是异常退出都会被拦截到 } // 感觉这个很有用吧既能做 Before 的事情也可以做 AfterReturning 的事情 Around(com.javadoop.aop.SystemArchitecture.businessService()) public Object doBasicProfiling(ProceedingJoinPoint pjp) throws Throwable { // start stopwatch Object retVal pjp.proceed(); // stop stopwatch return retVal; }}细心的读者可能发现了有些 Advice 缺少方法传参如在 Before 场景中参数往往是非常有用的比如我们要用日志记录下来被拦截方法的入参情况。Spring 提供了非常简单的获取入参的方法使用 org.aspectj.lang.JoinPoint 作为 Advice 的第一个参数即可如Before(com.javadoop.springaoplearning.aop_spring_2_aspectj.SystemArchitecture.businessService())public void logArgs(JoinPoint joinPoint) { System.out.println(方法执行前打印入参 Arrays.toString(joinPoint.getArgs()));}注意第一必须放置在第一个参数上第二如果是 Around我们通常会使用其子类 ProceedingJoinPoint因为它有 procceed()/procceed(args[]) 方法。到这里我们介绍完了 AspectJ 配置方式中的 Pointcut 和 Advice 的配置。对于开发者来说其实最重要的就是这两个了定义 Pointcut 和使用合适的 Advice 在各个 Pointcut 上。下面我们用这一节介绍的 AspectJ 来实现上一节实现的记录方法传参和记录方法返回值。xml 的配置非常简单这里是示例所以 bean 的配置还是使用了 xml 的配置方式。测试一下输出结果方法执行前打印入参[Tom, Cruise, 55]User{firstNameTom, lastNameCruise, age55, addressnull}方法执行前打印入参[]User{firstNameTom, lastNameCruise, age55, addressnull}JoinPoint 除了 getArgs() 外还有一些有用的方法大家可以进去稍微看一眼。最后提一点Aspect 中的配置不会作用于使用 Aspect 注解的 bean。Spring 2.0 schema-based 配置本节将介绍的是 Spring 2.0 以后提供的基于 aop / 命名空间的 XML 配置。这里说的 schema-based 就是指基于 aop 这个 schema。介绍 IOC 的时候也介绍过 Spring 是怎么解析各个命名空间的各种 *NamespaceHandler你要的源码在 org.springframework.aop.config.AopNamespaceHandler 中。有了前面的 AspectJ 的配置方式的知识理解 xml 方式的配置非常简单所以我们就可以废话少一点了。这里先介绍配置 Aspect便于后续理解aop:config aop:aspect idmyAspect refaBean ... /aop:aspect/aop:configbean idaBean class... .../beanaop:aspect 中需要指定一个 bean和前面介绍的 LogArgsAspect 和 LogResultAspect 一样我们知道该 bean 中我们需要写处理代码。然后我们写好 Aspect 代码后将其“织入”到合适的 Pointcut 中这就是面向切面。然后我们需要配置 Pointcut非常简单如下aop:config aop:pointcut idbusinessService expressionexecution(* com.javadoop.springaoplearning.service.*.*(..))/ !--也可以像下面这样-- aop:pointcut idbusinessService2 expressioncom.javadoop.SystemArchitecture.businessService()//aop:config将 aop:pointcut 作为 aop:config 的直接子元素将作为全局 Pointcut。我们也可以在 aop:aspect /内部配置 Pointcut这样该 Pointcut 仅用于该 Aspectaop:config aop:aspect reflogArgsAspect aop:pointcut idinternalPointcut expressioncom.javadoop.SystemArchitecture.businessService() / /aop:aspect/aop:config接下来我们应该配置 Advice 了为了避免废话过多我们直接上实例吧非常好理解将上一节用 AspectJ 方式配置的搬过来上面的例子中我们配置了两个 LogArgsAspect 和一个 LogResultAspect。其实基于 XML 的配置也是非常灵活的这里没办法给大家演示各种搭配大家抓住基本的 Pointcut、Advice 和 Aspect 这几个概念就很容易配置了。小结到这里本文介绍了 Spring AOP 的三种配置方式我们要知道的是到目前为止我们使用的都是 Spring AOP和 AspectJ 没什么关系。下一篇文章将会介绍 AspectJ 的使用方式以及怎样在 Spring 应用中使用 AspectJ。之后差不多就可以出 Spring AOP 源码分析了。附录本文使用的测试源码已上传到 Githubhongjiev/spring-aop-learning。建议读者 clone 下来以后通过命令行进行测试而不是依赖于 IDE1. mvn clean package2. java -jar target/spring-aop-learning-1.0-jar-with-dependencies.jar3. 修改 Application.java 中的代码或者其他代码然后重复 1 和 2来源https://www.javadoop.com/post/spring-aop-intro选择置顶关键时刻第一时间送达 长按二维码关注
