Spring AOP 详解

时间 2019-11-09

标签 spring aop 详解栏目 Spring 繁體版

原文原文链接

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

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

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

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

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

切面类TestAspect日志

Java代码

package com.spring.aop;
/**
* 切面
*
*/
public class TestAspect {
public void doAfter(JoinPoint jp) {
System.out.println("log Ending method: "
+ jp.getTarget().getClass().getName() + "."
+ jp.getSignature().getName());
}
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
long time = System.currentTimeMillis();
Object retVal = pjp.proceed();
time = System.currentTimeMillis() - time;
System.out.println("process time: " + time + " ms");
return retVal;
}
public void doBefore(JoinPoint jp) {
System.out.println("log Begining method: "
+ jp.getTarget().getClass().getName() + "."
+ jp.getSignature().getName());
}
public void doThrowing(JoinPoint jp, Throwable ex) {
System.out.println("method " + jp.getTarget().getClass().getName()
+ "." + jp.getSignature().getName() + " throw exception");
System.out.println(ex.getMessage());
}
private void sendEx(String ex) {
//TODO 发送短信或邮件提醒
}
}

Java代码

package com.spring.service;
/**
* 接口A
*/
public interface AService {
public void fooA(String _msg);
public void barA();
}

Java代码

package com.spring.service;
/**
*接口A的实现类
*/
public class AServiceImpl implements AService {
public void barA() {
System.out.println("AServiceImpl.barA()");
}
public void fooA(String _msg) {
System.out.println("AServiceImpl.fooA(msg:"+_msg+")");
}
}

Java代码

package com.spring.service;
/**
* Service类B
*/
public class BServiceImpl {
public void barB(String _msg, int _type) {
System.out.println("BServiceImpl.barB(msg:"+_msg+" type:"+_type+")");
if(_type == 1)
throw new IllegalArgumentException("测试异常");
}
public void fooB() {
System.out.println("BServiceImpl.fooB()");
}
}

ApplicationContext

Java代码

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-2.5.xsd"
default-autowire="autodetect">
<aop:config>
<aop:aspect id="TestAspect" ref="aspectBean">
<aop:pointcut id="businessService"
expression="execution(* com.spring.service.*.*(..))" />
<aop:before pointcut-ref="businessService" method="doBefore"/>
<aop:after pointcut-ref="businessService" method="doAfter"/>
<aop:around pointcut-ref="businessService" method="doAround"/>
<aop:after-throwing pointcut-ref="businessService" method="doThrowing" throwing="ex"/>
</aop:aspect>
</aop:config>
<bean id="aspectBean" class="com.spring.aop.TestAspect" />
<bean id="aService" class="com.spring.service.AServiceImpl"></bean>
<bean id="bService" class="com.spring.service.BServiceImpl"></bean>
</beans>

测试类AOPTest

Java代码

public class AOPTest extends AbstractDependencyInjectionSpringContextTests {
private AService aService;
private BServiceImpl bService;
protected String[] getConfigLocations() {
String[] configs = new String[] { "/applicationContext.xml"};
return configs;
}
/**
* 测试正常调用
*/
public void testCall()
{
System.out.println("SpringTest JUnit test");
aService.fooA("JUnit test fooA");
aService.barA();
bService.fooB();
bService.barB("JUnit test barB",0);
}
/**
* 测试After-Throwing
*/
public void testThrow()
{
try {
bService.barB("JUnit call barB",1);
} catch (IllegalArgumentException e) {
}
}
public void setAService(AService service) {
aService = service;
}
public void setBService(BServiceImpl service) {
bService = service;
}
}

运行结果以下：

Java代码

log Begining method: com.spring.service.AServiceImpl.fooA
AServiceImpl.fooA(msg:JUnit test fooA)
log Ending method: com.spring.service.AServiceImpl.fooA
process time: 0 ms
log Begining method: com.spring.service.AServiceImpl.barA
AServiceImpl.barA()
log Ending method: com.spring.service.AServiceImpl.barA
process time: 0 ms
log Begining method: com.spring.service.BServiceImpl.fooB
BServiceImpl.fooB()
log Ending method: com.spring.service.BServiceImpl.fooB
process time: 0 ms
log Begining method: com.spring.service.BServiceImpl.barB
BServiceImpl.barB(msg:JUnit test barB type:0)
log Ending method: com.spring.service.BServiceImpl.barB
process time: 0 ms
log Begining method: com.spring.service.BServiceImpl.barB
BServiceImpl.barB(msg:JUnit call barB type:1)
log Ending method: com.spring.service.BServiceImpl.barB
method com.spring.service.BServiceImpl.barB throw exception
测试异常

《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代码

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代码

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

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

Java代码

public void doAfter(JoinPoint jp,String msg)

访问当前的链接点

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