Spring AOP 详解[转]

此前对于AOP的使用仅限于声明式事务，除此之外在实际开发中也没有遇到过与之相关的问题。最近项目中遇到了以下几点需求，仔细思考之后，觉得采用AOP 来解决。一方面是为了以更加灵活的方式来解决问题，另一方面是借此机会深入学习Spring AOP相关的内容。本文是权当本人的自己AOP学习笔记，以下需求不用AOP肯定也能解决，至于是否牵强附会，仁者见仁智者见智。

  1. 对部分函数的调用进行日志记录，用于观察特定问题在运行过程中的函数调用情况
  2. 监控部分重要函数，若抛出指定的异常，需要以短信或邮件方式通知相关人员
  3. 金控部分重要函数的执行时间

事实上，以上需求没有AOP也能搞定，只是在实现过程中比较郁闷摆了。

  1. 需要打印日志的函数分散在各个包中，只能找到所有的函数体，手动添加日志。然而这些日志都是临时的，待问题解决之后应该需要清除打印日志的代码，只能再次手动清除^_^!
  2. 类 似1的情况，需要捕获异常的地方太多，如果手动添加时想到很可能明天又要手动清除，只能再汗。OK，该需求相对比较固定，属于长期监控的范畴，并不需求临 时添加后再清除。然而，客户某天要求，把其中20%的异常改为短信提醒，剩下的80%改用邮件提醒。改之，两天后，客户抱怨短信太多，全部改成邮件提 醒...
  3. 该需求通常用于监控某些函数的执行时间，用以判断系统执行慢的瓶颈所在。瓶颈被解决之后，烦恼同情况1

终于下定决心，采用AOP来解决！代码如下：

切面类TestAspect

Java代码  

  1. package com.spring.aop;
  2. /**
  3. * 切面
  4. *
  5. */
  6. public class TestAspect {
  7. public void doAfter(JoinPoint jp) {
  8. System.out.println("log Ending method: "
  9. + jp.getTarget().getClass().getName() + "."
  10. + jp.getSignature().getName());
  11. }
  12. public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
  13. long time = System.currentTimeMillis();
  14. Object retVal = pjp.proceed();
  15. time = System.currentTimeMillis() - time;
  16. System.out.println("process time: " + time + " ms");
  17. return retVal;
  18. }
  19. public void doBefore(JoinPoint jp) {
  20. System.out.println("log Begining method: "
  21. + jp.getTarget().getClass().getName() + "."
  22. + jp.getSignature().getName());
  23. }
  24. public void doThrowing(JoinPoint jp, Throwable ex) {
  25. System.out.println("method " + jp.getTarget().getClass().getName()
  26. + "." + jp.getSignature().getName() + " throw exception");
  27. System.out.println(ex.getMessage());
  28. }
  29. private void sendEx(String ex) {
  30. //TODO 发送短信或邮件提醒
  31. }
  32. }

Java代码  

  1. package com.spring.service;
  2. /**
  3. * 接口A
  4. */
  5. public interface AService {
  6. public void fooA(String _msg);
  7. public void barA();
  8. }

Java代码  

  1. package com.spring.service;
  2. /**
  3. *接口A的实现类
  4. */
  5. public class AServiceImpl implements AService {
  6. public void barA() {
  7. System.out.println("AServiceImpl.barA()");
  8. }
  9. public void fooA(String _msg) {
  10. System.out.println("AServiceImpl.fooA(msg:"+_msg+")");
  11. }
  12. }

Java代码  

  1. package com.spring.service;
  2. /**
  3. *   Service类B
  4. */
  5. public class BServiceImpl {
  6. public void barB(String _msg, int _type) {
  7. System.out.println("BServiceImpl.barB(msg:"+_msg+" type:"+_type+")");
  8. if(_type == 1)
  9. throw new IllegalArgumentException("测试异常");
  10. }
  11. public void fooB() {
  12. System.out.println("BServiceImpl.fooB()");
  13. }
  14. }

ApplicationContext

Java代码  

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xmlns:aop="http://www.springframework.org/schema/aop"
  5. xsi:schemaLocation="
  6. http://www.springframework.org/schema/beans
  7. http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
  8. http://www.springframework.org/schema/aop
  9. http://www.springframework.org/schema/aop/spring-aop-2.5.xsd"
  10. default-autowire="autodetect">
  11. <aop:config>
  12. <aop:aspect id="TestAspect" ref="aspectBean">
  13. <!--配置com.spring.service包下所有类或接口的所有方法-->
  14. <aop:pointcut id="businessService"
  15. expression="execution(* com.spring.service.*.*(..))" />
  16. <aop:before pointcut-ref="businessService" method="doBefore"/>
  17. <aop:after pointcut-ref="businessService" method="doAfter"/>
  18. <aop:around pointcut-ref="businessService" method="doAround"/>
  19. <aop:after-throwing pointcut-ref="businessService" method="doThrowing" throwing="ex"/>
  20. </aop:aspect>
  21. </aop:config>
  22. <bean id="aspectBean" class="com.spring.aop.TestAspect" />
  23. <bean id="aService" class="com.spring.service.AServiceImpl"></bean>
  24. <bean id="bService" class="com.spring.service.BServiceImpl"></bean>
  25. </beans>

测试类AOPTest

Java代码  

  1. public class AOPTest extends AbstractDependencyInjectionSpringContextTests {
  2. private AService aService;
  3. private BServiceImpl bService;
  4. protected String[] getConfigLocations() {
  5. String[] configs = new String[] { "/applicationContext.xml"};
  6. return configs;
  7. }
  8. /**
  9. * 测试正常调用
  10. */
  11. public void testCall()
  12. {
  13. System.out.println("SpringTest JUnit test");
  14. aService.fooA("JUnit test fooA");
  15. aService.barA();
  16. bService.fooB();
  17. bService.barB("JUnit test barB",0);
  18. }
  19. /**
  20. * 测试After-Throwing
  21. */
  22. public void testThrow()
  23. {
  24. try {
  25. bService.barB("JUnit call barB",1);
  26. } catch (IllegalArgumentException e) {
  27. }
  28. }
  29. public void setAService(AService service) {
  30. aService = service;
  31. }
  32. public void setBService(BServiceImpl service) {
  33. bService = service;
  34. }
  35. }

运行结果如下：

Java代码  

  1. log Begining method: com.spring.service.AServiceImpl.fooA
  2. AServiceImpl.fooA(msg:JUnit test fooA)
  3. log Ending method: com.spring.service.AServiceImpl.fooA
  4. process time: 0 ms
  5. log Begining method: com.spring.service.AServiceImpl.barA
  6. AServiceImpl.barA()
  7. log Ending method: com.spring.service.AServiceImpl.barA
  8. process time: 0 ms
  9. log Begining method: com.spring.service.BServiceImpl.fooB
  10. BServiceImpl.fooB()
  11. log Ending method: com.spring.service.BServiceImpl.fooB
  12. process time: 0 ms
  13. log Begining method: com.spring.service.BServiceImpl.barB
  14. BServiceImpl.barB(msg:JUnit test barB type:0)
  15. log Ending method: com.spring.service.BServiceImpl.barB
  16. process time: 0 ms
  17. log Begining method: com.spring.service.BServiceImpl.barB
  18. BServiceImpl.barB(msg:JUnit call barB type:1)
  19. log Ending method: com.spring.service.BServiceImpl.barB
  20. method com.spring.service.BServiceImpl.barB throw exception
  21. 测试异常

《Spring参考手册》中定义了以下几个AOP的重要概念，结合以上代码分析如下：

  • 切面（Aspect） ：官方的抽象定义为“一个关注点的模块化，这个关注点可能会横切多个对象”，在本例中，“切面”就是类TestAspect所关注的具体行为，例如，AServiceImpl.barA()的调用就是切面TestAspect所关注的行为之一。“切面”在ApplicationContext中<aop:aspect>来配置。
  • 连接点（Joinpoint） ：程序执行过程中的某一行为，例如，AServiceImpl.barA()的调用或者BServiceImpl.barB(String _msg, int _type)抛出异常等行为。
  • 通知（Advice） ：“切面”对于某个“连接点”所产生的动作，例如，TestAspect中对com.spring.service包下所有类的方法进行日志记录的动作就是一个Advice。其中，一个“切面”可以包含多个“Advice”，例如TestAspect
  • 切入点（Pointcut） ：匹配连接点的断言，在AOP中通知和一个切入点表达式关联。例如，TestAspect中的所有通知所关注的连接点，都由切入点表达式execution(* com.spring.service.*.*(..))来决定
  • 目标对象（Target Object） ：被一个或者多个切面所通知的对象。例如，AServcieImpl和BServiceImpl，当然在实际运行时，Spring AOP采用代理实现，实际AOP操作的是TargetObject的代理对象。
  • AOP代理（AOP Proxy） 在Spring AOP中有两种代理方式，JDK动态代理和CGLIB代理。默认情况下，TargetObject实现了接口时，则采用JDK动态代理，例如，AServiceImpl；反之，采用CGLIB代理，例如，BServiceImpl。强制使用CGLIB代理需要将 <aop:config> 的 proxy-target-class 属性设为true

通知（Advice）类型

  • 前置通知（Before advice） ：在某连接点（JoinPoint）之前执行的通知，但这个通知不能阻止连接点前的执行。ApplicationContext中在<aop:aspect>里面使用<aop:before>元素进行声明。例如，TestAspect中的doBefore方法
  • 后通知（After advice） ：当某连接点退出的时候执行的通知（不论是正常返回还是异常退出）。ApplicationContext中在<aop:aspect>里面使用<aop:after>元素进行声明。例如，TestAspect中的doAfter方法，所以AOPTest中调用BServiceImpl.barB抛出异常时，doAfter方法仍然执行
  • 返回后通知（After return advice） ：在某连接点正常完成后执行的通知，不包括抛出异常的情况。ApplicationContext中在<aop:aspect>里面使用<after-returning>元素进行声明。
  • 环绕通知（Around advice） ：包围一个连接点的通知，类似Web中Servlet规范中的Filter的doFilter方法。可以在方法的调用前后完成自定义的行为，也可以选择不执行。ApplicationContext中在<aop:aspect>里面使用<aop:around>元素进行声明。例如，TestAspect中的doAround方法。
  • 抛出异常后通知（After throwing advice） ： 在方法抛出异常退出时执行的通知。 ApplicationContext中在<aop:aspect>里面使用<aop:after-throwing>元素进行声明。例如，TestAspect中的doThrowing方法。

切入点表达式

  • 通常情况下，表达式中使用”execution“就可以满足大部分的要求。表达式格式如下：

Java代码  

  1. execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern) throws-pattern?)

modifiers-pattern：方法的操作权限

ret-type-pattern：返回值

declaring-type-pattern：方法所在的包

name-pattern：方法名

parm-pattern：参数名

throws-pattern：异常

其中，除ret-type-pattern和name-pattern之外，其他都是可选的。上例中，execution(* com.spring.service.*.*(..))表示com.spring.service包下，返回值为任意类型；方法名任意；参数不作限制的所有方法。

  • 通知参数

可以通过args来绑定参数，这样就可以在通知（Advice）中访问具体参数了。例如，<aop:aspect>配置如下

Java代码  

  1. <aop:config>
  2. <aop:aspect id="TestAspect" ref="aspectBean">
  3. <aop:pointcut id="businessService"
  4. expression="execution(* com.spring.service.*.*(String,..)) and args(msg,..)" />
  5. <aop:after pointcut-ref="businessService" method="doAfter"/>
  6. </aop:aspect>
  7. </aop:config>

TestAspect的doAfter方法中就可以访问msg参数，但这样以来AService中的barA()和BServiceImpl中的barB()就不再是连接点，因为execution(* com.spring.service.*.*(String,..))只配置第一个参数为String类型的方法。其中，doAfter方法定义如下：

Java代码  

  1. public void doAfter(JoinPoint jp,String msg)
  • 访问当前的连接点

任何通知（Advice）方法可以将第一个参数定义为 org.aspectj.lang.JoinPoint 类型。JoinPoint 接口提供了一系列有用的方法， 比如 getArgs() （返回方法参数）、getThis() （返回代理对象）、getTarget() （返回目标）、getSignature() （返回正在被通知的方法相关信息）和 toString()（打印出正在被通知的方法的有用信息。

时间： 2024-12-05 15:42:06

Spring AOP 详解[转]的相关文章

Spring AOP详解（转载）

此前对于AOP的使用仅限于声明式事务,除此之外在实际开发中也没有遇到过与之相关的问题.最近项目中遇到了以下几点需求,仔细思考之后,觉得采用AOP 来解决.一方面是为了以更加灵活的方式来解决问题,另一方面是借此机会深入学习Spring AOP相关的内容.本文是权当本人的自己AOP学习笔记,以下需求不用AOP肯定也能解决,至于是否牵强附会,仁者见仁智者见智. 对部分函数的调用进行日志记录,用于观察特定问题在运行过程中的函数调用情况 监控部分重要函数,若抛出指定的异常,需要以短信或邮件方式通知相关人员

Spring AOP详解（转载）所需要的包

上一篇文章中,<Spring Aop详解(转载)>里的代码都可以运行,只是包比较多,中间缺少了几个相应的包,根据报错,几经百度搜索,终于补全了所有包. 截图如下: 在主测试类里面,有人怀疑,没有main方法,是怎么运行的.这是用的junit,结合spring来进行的测试类. Spring AOP详解(转载)所需要的包,布布扣,bubuko.com

spring AOP详解〇

AOP正在成为软件开发的下一个圣杯.使用AOP,你可以将处理aspect的代码注入主程序,通常主程序的主要目的并不在于处理这些aspect.AOP可以防止代码混乱. 为了理解AOP如何做到这点,考虑一下记日志的工作.日志本身不太可能是你开发的主程序的主要任务.如果能将"不可见的".通用的日志代码注入主程序中,那该多好啊.AOP可以帮助你做到. Spring framework是很有前途的AOP技术.作为一种非侵略性的,轻型的AOP framework,你无需使用预编译器或其他的元标签,

Spring AOP 详解 【转】

此前对于AOP的使用仅限于声明式事务,除此之外在实际开发中也没有遇到过与之相关的问题.最近项目中遇到了以下几点需求,仔细思考之后,觉得采用AOP 来解决.一方面是为了以更加灵活的方式来解决问题,另一方面是借此机会深入学习Spring AOP相关的内容.本文是权当本人的自己AOP学习笔记,以下需求不用AOP肯定也能解决,至于是否牵强附会,仁者见仁智者见智. 对部分函数的调用进行日志记录,用于观察特定问题在运行过程中的函数调用情况 监控部分重要函数,若抛出指定的异常,需要以短信或邮件方式通知相关人员

Spring—AOP详解

推荐文章:    Spring—AOP详解:https://blog.csdn.net/q982151756/article/details/80513340 轻松理解AOP思想(面向切面编程):https://www.cnblogs.com/Wolfmanlq/p/6036019.html AOP那点事儿:面向切面编程:https://my.oschina.net/huangyong/blog/161338 OOP的完美点缀—AOP之SpringAOP实现原理:https://www.cnbl

细说Spring——AOP详解（动态代理实现AOP）

前言 嗯,我应该是有一段实现没有写过博客了,在写完了细说Spring——AOP详解(AOP概览)之后,我发现我不知道该怎么写AOP这一部分,所以就把写博客这件事给放下了,但是这件事情又不想就这么放弃,所以今天我仔细思考了一下,决定还是要克服困难,我仔细的想了一下怎么讲解AOP实现这一部分,然后我决定由浅入深的讲解动态代理,然后用动态代理实现一个简单的AOP,感觉这样能够让人对AOP的原理有一个比较深刻的认识,希望能帮到大家.而且最近学习又组建了ACM比赛的队伍,虽然已经要大三了,按理来说应该一心

Spring系列（四）：Spring AOP详解

一.AOP是什么 AOP(面向切面编程),可以说是一种编程思想,其中的Spring AOP和AspectJ都是现实了这种编程思想.相对OOP(面向过程编程)来说,提供了另外一种编程方式,对于OOP过程中产生的横切性问题,这些横切性与业务无关,可以通过预编译方式和运行期动态代理来实现.比如可以应用在:日志记录.性能监控.事务管理等. 二.AOP的基本概念 Aspect(切面):通常来说是一个类,里面定义了切点和通知,Spring AOP中可以用@AspectJ来标注这个类是切面: Join poi

Spring AOP 详解

详见:http://blog.yemou.net/article/query/info/tytfjhfascvhzxcyt117 此前对于AOP的使用仅限于声明式事务,除此之外在实际开发中也没有遇到过与之相关的问题.最近项目中遇到了以下几点需求,仔细思考之后,觉得采用AOP 来解决.一方面是为了以更加灵活的方式来解决问题,另一方面是借此机会深入学习Spring AOP相关的内容.本文是权当本人的自己AOP学习笔记,以下需求不用AOP肯定也能解决,至于是否牵强附会,仁者见仁智者见智. 对部分函数的

Spring AOP详解 、 JDK动态代理、CGLib动态代理

AOP是Aspect Oriented Programing的简称,面向切面编程.AOP适合于那些具有横切逻辑的应用:如性能监测,访问控制,事务管理以及日志记录.AOP将这些分散在各个业务逻辑中的代码通过横向切割的方式抽取到一个独立的模块中. 一.AOP术语 1.连接点(Joinpoint) 程序执行的某个特定位置:如类开始初始化之前.类初始化之后.类某个方法调用前.调用后等:一个类或一段程序代码拥有一些具有边界性质的特定点,这些代码中的特定点就成为“连接点”,Spring仅支持方法的连接点,即

spring aop详解

AOP AOP(Aspect Oriented Programming),即面向切面编程,可以说是OOP(Object Oriented Programming,面向对象编程)的补充和完善.OOP引入封装.继承.多态等概念来建立一种对象层次结构,用于模拟公共行为的一个集合.不过OOP允许开发者定义纵向的关系,但并不适合定义横向的关系,例如日志功能.日志代码往往横向地散布在所有对象层次中,而与它对应的对象的核心功能毫无关系对于其他类型的代码,如安全性.异常处理和透明的持续性也都是如此,这种散布在各