Spring AOP 详解

daniell2012
关注文章
TinyMind专栏频道

博客分类：
AOPSpringjunitBeanJDK

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

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

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

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


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

切面类TestAspect

Java代码
  1. packagecom.spring.aop;
  2. /**
  3. *切面
  4. *
  5. */
  6. publicclassTestAspect{
  8. publicvoiddoAfter(JoinPointjp){
  9. System.out.println("logEndingmethod:"
  10. +jp.getTarget().getClass().getName()+"."
  11. +jp.getSignature().getName());
  12. }
  14. publicObjectdoAround(ProceedingJoinPointpjp)throwsThrowable{
  15. longtime=System.currentTimeMillis();
  16. ObjectretVal=pjp.proceed();
  17. time=System.currentTimeMillis()-time;
  18. System.out.println("processtime:"+time+"ms");
  19. returnretVal;
  20. }
  22. publicvoiddoBefore(JoinPointjp){
  23. System.out.println("logBeginingmethod:"
  24. +jp.getTarget().getClass().getName()+"."
  25. +jp.getSignature().getName());
  26. }
  28. publicvoiddoThrowing(JoinPointjp,Throwableex){
  29. System.out.println("method"+jp.getTarget().getClass().getName()
  30. +"."+jp.getSignature().getName()+"throwexception");
  31. System.out.println(ex.getMessage());
  32. }
  34. privatevoidsendEx(Stringex){
  35. //TODO发送短信或邮件提醒
  36. }
  37. }

Java代码
  1. packagecom.spring.service;
  2. /**
  3. *接口A
  4. */
  5. publicinterfaceAService{
  7. publicvoidfooA(String_msg);
  9. publicvoidbarA();
  10. }
Java代码
  1. packagecom.spring.service;
  2. /**
  3. *接口A的实现类
  4. */
  5. publicclassAServiceImplimplementsAService{
  7. publicvoidbarA(){
  8. System.out.println("AServiceImpl.barA()");
  9. }
  11. publicvoidfooA(String_msg){
  12. System.out.println("AServiceImpl.fooA(msg:"+_msg+")");
  13. }
  14. }

Java代码
  1. packagecom.spring.service;
  3. /**
  4. *Service类B
  5. */
  6. publicclassBServiceImpl{
  8. publicvoidbarB(String_msg,int_type){
  9. System.out.println("BServiceImpl.barB(msg:"+_msg+"type:"+_type+")");
  10. if(_type==1)
  11. thrownewIllegalArgumentException("测试异常");
  12. }
  14. publicvoidfooB(){
  15. System.out.println("BServiceImpl.fooB()");
  16. }
  18. }

ApplicationContext

Java代码
  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <beansxmlns="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:aspectid="TestAspect"ref="aspectBean">
  13. <!--配置com.spring.service包下所有类或接口的所有方法-->
  14. <aop:pointcutid="businessService"
  15. expression="execution(*com.spring.service.*.*(..))"/>
  16. <aop:beforepointcut-ref="businessService"method="doBefore"/>
  17. <aop:afterpointcut-ref="businessService"method="doAfter"/>
  18. <aop:aroundpointcut-ref="businessService"method="doAround"/>
  19. <aop:after-throwingpointcut-ref="businessService"method="doThrowing"throwing="ex"/>
  20. </aop:aspect>
  21. </aop:config>
  23. <beanid="aspectBean"class="com.spring.aop.TestAspect"/>
  24. <beanid="aService"class="com.spring.service.AServiceImpl"></bean>
  25. <beanid="bService"class="com.spring.service.BServiceImpl"></bean>
  27. </beans>

测试类AOPTest

Java代码
  1. publicclassAOPTestextendsAbstractDependencyInjectionSpringContextTests{
  3. privateAServiceaService;
  5. privateBServiceImplbService;
  7. protectedString[]getConfigLocations(){
  8. String[]configs=newString[]{"/applicationContext.xml"};
  9. returnconfigs;
  10. }
  13. /**
  14. *测试正常调用
  15. */
  16. publicvoidtestCall()
  17. {
  18. System.out.println("SpringTestJUnittest");
  19. aService.fooA("JUnittestfooA");
  20. aService.barA();
  21. bService.fooB();
  22. bService.barB("JUnittestbarB",0);
  23. }
  25. /**
  26. *测试After-Throwing
  27. */
  28. publicvoidtestThrow()
  29. {
  30. try{
  31. bService.barB("JUnitcallbarB",1);
  32. }catch(IllegalArgumentExceptione){
  34. }
  35. }
  37. publicvoidsetAService(AServiceservice){
  38. aService=service;
  39. }
  41. publicvoidsetBService(BServiceImplservice){
  42. bService=service;
  43. }
  44. }

运行结果如下：

Java代码
  1. logBeginingmethod:com.spring.service.AServiceImpl.fooA
  2. AServiceImpl.fooA(msg:JUnittestfooA)
  3. logEndingmethod:com.spring.service.AServiceImpl.fooA
  4. processtime:0ms
  5. logBeginingmethod:com.spring.service.AServiceImpl.barA
  6. AServiceImpl.barA()
  7. logEndingmethod:com.spring.service.AServiceImpl.barA
  8. processtime:0ms
  9. logBeginingmethod:com.spring.service.BServiceImpl.fooB
  10. BServiceImpl.fooB()
  11. logEndingmethod:com.spring.service.BServiceImpl.fooB
  12. processtime:0ms
  13. logBeginingmethod:com.spring.service.BServiceImpl.barB
  14. BServiceImpl.barB(msg:JUnittestbarBtype:0)
  15. logEndingmethod:com.spring.service.BServiceImpl.barB
  16. processtime:0ms
  18. logBeginingmethod:com.spring.service.BServiceImpl.barB
  19. BServiceImpl.barB(msg:JUnitcallbarBtype:1)
  20. logEndingmethod:com.spring.service.BServiceImpl.barB
  21. methodcom.spring.service.BServiceImpl.barBthrowexception
  22. 测试异常

《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-patterndeclaring-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:aspectid="TestAspect"ref="aspectBean">
  3. <aop:pointcutid="businessService"
  4. expression="execution(*com.spring.service.*.*(String,..))andargs(msg,..)"/>
  5. <aop:afterpointcut-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. publicvoiddoAfter(JoinPointjp,Stringmsg)
  • 访问当前的连接点

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

优质内容筛选与推荐>>
1、分享二：架构设计分享一：关于API分布式服务提供方式
2、SQL Server创建索引
3、项目结束，总结一下[分享]
4、关于cacti的相关问题
5、HTML5[2]:使用viewport控制手机浏览器布局


长按二维码向我转账

受苹果公司新规定影响，微信 iOS 版的赞赏功能被关闭，可通过二维码转账支持公众号。

    阅读
    好看
    已推荐到看一看
    你的朋友可以在“发现”-“看一看”看到你认为好看的文章。
    已取消，“好看”想法已同步删除
    已推荐到看一看 和朋友分享想法
    最多200字，当前共字 发送

    已发送

    朋友将在看一看看到

    确定
    分享你的想法...
    取消

    分享想法到看一看

    确定
    最多200字，当前共字

    发送中

    网络异常，请稍后重试

    微信扫一扫
    关注该公众号

    0 │ 收藏 │ 举报




    联系我们

    欢迎来到TinyMind。

    关于TinyMind的内容或商务合作、网站建议，举报不良信息等均可联系我们。

    TinyMind客服邮箱：support@tinymind.net.cn

    TinyMind.net.cn，专业AI技术社区