手把手教你写个AOP框架

 

Why AOP?

 

AOP（Aspect-Oriented Programming），意思是面向切面编程。传统的OOP面向对象至关于站在一个上帝模式从上往下看，里面的一块块都是一个对象，由我任意组合；而AOP不一样之处在于，他是以一个旁观者的身法，从“侧面”看整个系统模块，看看哪里能够见缝插针，将本身想要处理的一段业务逻辑“编织”进去。

Code duplication is the ultimate code smell. It’s a sign that something is very wrong with implementation or design.（重复的代码会让代码的质量很糟糕。若是出现这个情况，那么必定是实现或者设计环境出了问题）

OOP自己是极力反对“重复发明轮子”的，可是有时却对重复的代码显得迫不得已，而AOP自己是一种很好的能解决这个问题的一种思想。

抽象了半天，仍是利用一个例子还更加形象的解释吧。若是你要作一个权限系统，那么确定须要在不少业务逻辑以前都加上一个权限判断——只有符合条件的才能完成后面的操做。若是利用传统思想，很显然你会把作权限判断的业务逻辑作封装，而后在每一个业务逻辑执行以前都执行如下那片处理权限判断的代码。以下图：

看到没，每次一个判断每次一个判断，若是让这些权限判断的代码散落在系统的各个角落，那会是一个噩梦！就算采用OOP思想，将权限检查的业务放在一个类中，照样无济于事。由于每段业务代码开头总有这么一段抹不掉的身影（doSecurityCheck）。

这时，AOP老兄终于按耐不住，要出场大展身手了！这位老兄立刻说，放着那段业务逻辑代码，我来处理！

他首先将权限处理的部分视做一个aspect（切面），而后想办法在运行时把切面weave（编织）进业务逻辑中合适的位置。好比就像这样作：

这样，AOP就成功的帮我把权限验证部分插入到调用代码的前面执行。具体调用哪一个方法其实AOP并不知道，只要你把切面织入了用户登陆，那后调用用户登陆，只要你织入了用户查询，那就调用用户查询。并且不仅仅是只掉某一个方法，它能够挨着排的调用。

这只是其中一个强大的用处，还有像日志记录、性能分析、事务处理等更多均可以利用到AOP的地方。

Think of AOP as complementing, not competing with, OOP. AOP can supplement OOP where it is weak. （AOP和OOP没有竞争关系，相反，AOP可以很好的补充OOP的不足）

AOP基本术语

 

l  Aspect（切面）：就是你想给程序织入的代码片断、如权限处理、日志记录等。

l  Weaving（编织）：就是给指定的程序加上额外的业务逻辑的过程，好比将权限验证插入到用户登陆的过程。

l  Advice（通知）：表示是在程序的哪里织入切面，好比前面织入，仍是后面织入，或者是抛出异常的时候织入。

l  Joinpoint（链接点）：表示给那个程序织入切面，也就是被代理的目标对象的目标方法。

l  Pointcut（切入点）：表示给哪些程序织入切面，是链接点的集合，好比是用户登陆和用户查询等都须要被织入。

 

为了方便用户使用AOP，须要定义几种通知类型。

l  Before：前置通知，在业务逻辑以前通知

l  After：后置通知，在业务逻辑正常完结以后通知

l  End：结束通知，无论业务逻辑是否正常完结，都会在后面执行的通知

l  Error：错误通知，在业务逻辑抛出异常的时候通知

 

AOP执行流程

 

下图展现了AOP核心调用过程，经过调用AOP代理类，开始一个一个调用后面的（前置）通知/拦截器链条，完成以后在调用目标方法，最后回来的时候接着调用（后置、结束）通知/拦截器链条。

如此一来就成功的完成了在AOP中给某个程序（目标方法）以前加上一段业务逻辑，以后加上一段业务逻辑的流程，而且杀伤力极大，能够将目标方法的范围进行任意控制。

 

动手实现一个AOP

 

前戏那么长，高潮不会短！此次写的AOP参考了不少Spring的代码，吸取了大师补充的营养。

利用测试驱动开发的原则，咱们先来考虑考虑咱们会怎么用（写好测试代码），而后想一想API怎么设计（将接口写好），最后考虑实现的问题。

        @Test
	public void testTranscation() {
		// 建立动态代理工厂，这是调用动态代理实现aop的初始点
		AopProxyFactory proxy = new AopProxyFactory();

		// 建立目标对象
		proxy.setTarget(new AopDemo());

		// 设置各个advice，以便在调用目标对象的指定方法时能够出现这些advice
		proxy.addAdvice(new TransactionAspect());

		// 获取代理对象
		IAopDemo p = (IAopDemo) proxy.getProxy();

		// 经过代理对象调用目标对象的指定方法
		p.doSomething();
	}

参考spring的API设计，咱们给出了上面这段测试代码。这样就能给AOP代理工厂配置目标对象，和各类各样的通知，目前只有事务处理的通知。而后经过代理工厂获取目标对象的代理对象，并完成类型转换的过程。最后调用指定方法，完成在这个方法的周围实现事务处理过程。

设置目标对象的方法无需赘言，就是看中了那个对象，设置进去，这样就能搞个代理帮他作了。。。

添加通知的实现，我想设计的好用一点。什么叫好用呢？也就是给你一些接口，Before、After、Error、End等，只要你定义的aspect类（切面）实现了任意一个接口，就能保证按照这个接口名字所显示的那样执行。好比我实现了Before接口和他的抽象方法，并在里面加了个“记录日志”的功能，这样，我之后就能在个人目标方法执行以前完成一次记录日志的过程了。这里咱们使用的是事务处理的aspect切面：

@Component
@Match(methodMatch = "org.*.doSomething")
public class TransactionAspect implements Before, End, Error {

	@Override
	public void error(Method method, Object[] args, Exception e) {
		System.out.println("回滚事务");
	}

	@Override
	public void before(Method method, Object[] args) {
		System.out.println("开启事务");
	}

	@Override
	public void end(Method method, Object[] args, Object retVal) {
		System.out.println("关闭事务");
	}

}

在代理工厂中，咱们使用Object  target存储这个目标对象，并使用集合来记录全部该类涉及到的通知。

        private Object target;

	private List<Advice> adviceList = new ArrayList<Advice>();

	/**
	 * 
	 * @Title: setTarget
	 * @Description: 设置目标
	 * @param @param target 设定文件
	 * @return void 返回类型
	 * @throws
	 */
	public void setTarget(Object target) {
		this.target = target;
	}

	public void addAdvice(Advice advice) {
		if (advice == null)
			throw new NullPointerException("添加的通知不能为空");
		adviceList.add(advice);
	}

而在完成配置代理工厂后，须要经过这个代理工厂来获取代理对象。在获取代理对象以前，咱们把以前完成的配置（目标方法、通知集合）都初始化到AdvisedSupport对象中，将这个对象总体传给后面的代理实现（jdk、cglib）完成代理类的初始化，以及通知和目标方法的调用。

        public Object getProxy() {
		if (target == null)
			throw new NullPointerException("目标对象不能为空");
		
		AdvisedSupport config=new AdvisedSupport(target, adviceList);

		AopProxy proxy = null;
		// 若该目标对象实现了接口，就优先选择jdk动态代理；若是没有实现任何接口，就只能采用cglib动态代理；
		if (config.hasInterfaces()) {
			logger.info("采用jdk动态代理");
			proxy = new JDKAopProxy(config);
		} else {
			logger.info("采用cglib动态代理");
			proxy = new CglibAopProxy(config);
		}
		return proxy.getProxy();
	}

这里咱们会根据不一样的状况来判断他是选择jdk动态代理仍是选择cglib动态代理。

这里以jdk动态代理为例，cglib留给读者自行分析：

public class JDKAopProxy implements AopProxy, InvocationHandler {

	private AdvisedSupport config;

	public JDKAopProxy(AdvisedSupport config) {
		this.config = config;
	}

	@Override
	public Object getProxy() {
		return Proxy.newProxyInstance(config.getClassLoader(),
				config.getInterfaces(), this);
	}

	@Override
	public Object invoke(Object proxy, Method method, Object[] args)
			throws Throwable {
		return new ReflectiveMethodInvocation(config.getInterceptors(),config.getMatchers(), args,
				method, config.getTarget()).proceed();
	}

}

这里咱们首先在getProxy初始化了代理类，而后当代理类的方法被调用时，会完成目标方法调用，这个步骤都是ReflectiveMethodInvocation对象完成的。这个类实现了MethodInvocation，目的是为了完成以后的回调过程，这个后面能够看到。在这个ReflectiveMethodInvocation类里面，咱们存储了足够多的信息

        /**
	 * 通知advice
	 */
	private List<MethodInterceptor> chain;

	/**
	 * 每一个advice所配置的匹配信息
	 */
	private List<Matcher> matches;

	/**
	 * 执行目标方法须要的参数
	 */
	private Object[] arguments;

	/**
	 * 目标方法
	 */
	private Method method;

	/**
	 * 目标对象
	 */
	private Object target;
	
	/**
	 * 记录当前advice链条（chain）所须要执行的方法的索引
	 */
	private int index;

目的很简单：就是将多个通知链条和目标对象的方法自己的调用整合起来，造成逻辑完善的链条——前置通知在目标方法前面排着队完成，若是目标方法抛出了异常就执行错误通知，一旦正常执行完成目标方法就执行后置通知，而结束通知时不论是是正常执行完目标方法仍是抛出了异常，最后都会执行的一个通知。

下面来看看这个类中处理一连串方法调用的核心方法proceed()：

@Override
	public Object proceed() throws Throwable {
		//当链条走完的时候调用目标方法
		if (index == chain.size())
			return invokeJoinpoint();

		Matcher matcher = matches.get(index);

		// 查看是否匹配，
		if (matcher.matches(this.method, this.target.getClass())) {
			return chain.get(index++).invoke(this);
		} else {
			index++;
			return proceed();
		}

	}

	/**
	 * 
	 * @Title: invokeJoinpoint
	 * @Description: 调用链接点方法
	 * @param @return
	 * @param @throws Throwable 设定文件
	 * @return Object 返回类型
	 * @throws
	 */
	protected Object invokeJoinpoint() throws Throwable {
		return method.invoke(target, arguments);
	}

很简单，就是当链条走完的时候，调用目标方法。不然就继续指向链条上的方法。这里有一个检测是否匹配的过程，也就是我给个人切面类，也就是处理事务的切面TransactionAspect配置了一个注解Match，这个注解表示当目标类是org包下的某个类时，我就会对他的doSomething方法完成拦截，在这个方法周围加上事务处理。

@Component
@Match(methodMatch = "org.*.doSomething")
public class TransactionAspect implements Before, End, Error {

	@Override
	public void error(Method method, Object[] args, Exception e) {
		System.out.println("回滚事务");
	}

	@Override
	public void before(Method method, Object[] args) {
		System.out.println("开启事务");
	}

	@Override
	public void end(Method method, Object[] args, Object retVal) {
		System.out.println("关闭事务");
	}

}

具体判断是否匹配，我采用的是正则表达式，也就是当目标类的某个方法被调用时，一旦检测到他符合methodMatch配置的正则表达式，就给该方法先后加上指定的逻辑。若是发现不匹配，这继续寻找链条上下一个通知，直到走完整个通知链条。

这里你们确定会有一个问题：在链条上获取到一个通知，执行该通知的时候，如何确保前置通知是再前面执行，后置通知是再后面执行呢？而且在完成调用以后确保执行后面的通知调用流程？

其实，spring在这里用到了一个很巧妙的编程技巧——经过多态原理和回调函数来处理。

chain.get(index++).invoke(this);

这里获取到了第index个通知，拿到的是个接口类型，可是实现类出卖了他的本质，表示它究竟是前置仍是后置或者是其余等。当执行invoke时，将该MethodInvocation的实现类ReflectiveMethodInvocation的对象的引用传递进去。如此调用的方法，实际上是这样的：

能够发现，当实现类是后置通知的时候，我会选择AfterInterceptor来执行，当时前置通知的时候，会选择BeforeInterceptor来执行。也就是，碰到合适的通知，就采用合适的拦截器处理。

之前置通知的方法拦截器为例：

public class BeforeInterceptor implements MethodInterceptor {

	private Before advice;

	public BeforeInterceptor(Before advice) {
		this.advice =advice;
	}

	@Override
	public Object invoke(MethodInvocation mi) throws Throwable {
		advice.before(mi.getMethod(), mi.getArguments());
		return mi.proceed();
	}

}

看到这里是否是有种似曾相识的感受，这不就是开始那个权限验证的翻版么？对啊，it is。这里实现的很明确，就是在目标方法调用以前执行before中的业务逻辑，接着进行mi.proceed()又回调到了咱们MethodInvocation的实现类ReflectiveMethodInvocation中的proceed方法中了。

这样，也就保证了链条的次序执行。

来看看咱们测试用例的输出结果吧：

开启事务

和哈哈哈哈哈...

关闭事务

目前还没能把ioc和aop整合起来使用，还有像ioc在web mvc框架中如何使用都还没提到，不过这些会在咱们之后的博客中不断出现。

源代码

 最后，放出源代码：https://github.com/mjaow/my_spring