使用反射机制深入理解AOP机制并自定义AOP管理模块

最近在总结过去一年所做的项目，由于开发周期或者对需求的把握不是太到位，每个项目随着所做的项目进度，从需求分析到code阶段总或多或少有一些自己感觉不是太完美或没有尽善尽美的地方，使用开源框架和第三方接口只知道接口调用，对于其内部实现机理总是存在疑惑（这家伙是怎么做的，我怎么没有想到），虽然各个项目完成后一瘸一拐的还是能满足当初的开发需求。但是对于追求完美、刨根问底性选手，心中总有根刺，感觉不爽(不知道大家有没有这种感觉)。下面通过自己的理解使用java原生的注解方式实现spring aop的运行机理(还没看过spring /mybatis的源代码，过年的时候研究一下大侠们有好的想法可以共享一下，话说独乐乐不如众乐乐哦）

先说说spring AOP使用上的一些限制:

1.如果切点函数有重载时，定义的通知类中方法不能实现方法重载

2.spring AOP只支持方法层面的切口定义，当然这个也是spring的基本原则如spring mvc 与struts2的区别之一就是spring mvc是基于方法的设计struts2是基于类的设计；

3.spring aop 不支持参数级的切口定义，如有时候需要对传入切口的参数进行安全性，规范性、合法性处理的时候是不支持的。当然对参数处理涉及到解析参数类型获取、参数类型判断，对于使用反射机制获取这个是有一定难度滴。

下面通过详细的代码，来讲解如何通过使用java的annotation自定义切点接口和通过反射机制实现spring AOP机制。

第一步:自定义AOP中需要的注解接口

class层注解定义：

用途：类接口切点注解定义

package com.dbc.yangg.project;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** *  * @ClassName: MyClassAnnotation   * @Description: 类层注解定义   * @author [e-mail]   * @date 2014年1月18日 下午11:37:51   * */@Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)public @interface MyClassAnnotation {String value() default "firstAnno";}

method层advice定义类似于Spring AOP中@Before,@After,@Around,@AfterThrowing,@AfterReturning等

用途：方法切点接口注解定义

package com.dbc.yangg.project;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** *  * @ClassName: MySecondMethodAnnotation   * @Description: 方法层注解定义  * @author [e-mail]   * @date 2014年1月18日 下午11:44:44   * */@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)public @interface MyPointcutAnnotation {/** *  * @Title: className   * @Description: TODO   * @param @return    advicer class type   * @return Class<?>   * @throws */Class<?> className();/** *  * @Title: method   * @Description: TODO   * @param @return advicer method name      * @return String   * @throws */String method();//}

method parameters 层advicer定义类似mybatis中@Param注解

功能:参数层面切点接口注解定义

package com.dbc.yangg.project;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** *  * @ClassName: MyParameterAnnotation   * @Description: 方法中参数层注解定义  * @author [e-mail]   * @date 2014年1月18日 下午11:45:15   * */@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.PARAMETER)public @interface MyParameterAnnotation {/** *  * @Title: opType   * @Description: method 参数类型检查  * @param @return       * @return MyAopParameterOPType[]   * @throws */MyAopParameterOPType[] opType();/** *  * @Title: paraType   * @Description: method 参数类型  * @param @return       * @return Class<?>   * @throws */Class<?> paraType();}

处理MyAopParameterOPType类型定义

功能:定义参数切口定义注解处理的类型

 

package com.dbc.yangg.project;   /**  *   * @ClassName: MyAopParameterOPType    * @Description: TODO    * @author [e-mail]    * @date 2014年1月18日 下午12:07:25   *  */public enum MyAopParameterOPType {checkForDB("DB"),//特殊字符处理 ,通用转码或者其他处理checkForSecurity("security"),//参数是否合法等操作checkDeleteAuthority("DeleteAuthority"),checkUpdateAuthority("UpdateAuthority");private String value;private MyAopParameterOPType(String value){this.value=value;}public String getValue(){return this.value;}}

第二步:自定义AOP管理模块

主要功能:自定义AOP处理类，负责解析实际调用切点函数定义的通知

package com.dbc.yangg.project;import java.lang.annotation.Annotation;import java.lang.reflect.InvocationTargetException;import java.lang.reflect.Method;import org.apache.ibatis.annotations.SelectProvider;/** *  * @ClassName: MyAOPUtils   * @Description:   * @author [e-mail]   * @date 2014年1月18日 下午12:01:05   * */public class MyAOPUtils {/** *  * @Title: myAopUtilsManager   * @Description: 切点函数参数触发通知事件,所有通知事件的处理接口  * @param @param advicerManagerClass * @param @param indexArg * @param @param paraValues * @param @param paraTypes * @param @return       * @return boolean   * @throws */private static boolean parameterAdvicerUtils(Annotation advicerManagerClass,int indexArg,Object[] paraValues, Class<?>... paraTypes){if(advicerManagerClass instanceof MyPointcutAnnotation){//接口参数验证通过后执行//切点通知处理MyPointcutAnnotation AdvicerClass=(MyPointcutAnnotation)advicerManagerClass;Class<?> adviceClass=AdvicerClass.className();try {Method adviceMethod=adviceClass.getMethod(AdvicerClass.method(),paraTypes);adviceMethod.invoke(adviceClass.newInstance(), paraValues);} catch (NoSuchMethodException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (SecurityException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (IllegalAccessException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (IllegalArgumentException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (InvocationTargetException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (InstantiationException e) {// TODO Auto-generated catch block  e.printStackTrace();}}else if(advicerManagerClass instanceof MyParameterAnnotation){//对输入的参数做一些通用处理和安全性检查等等//一般用在DAO层sql拼装特殊字符检查，数据格式合法性检查，转码或对调用者使用定义切点接口使用权限，安全性，等信息进行检查和确认等场合；当切点参数通过通知类中定义的接口处理后再调用切点方法；如MyBatis中通过注解@SelectProvider方式生成合法的SQL语句需要对拼装的sql语句传入的参数进行验证等，还有就是从安全新考虑对传入的模块调用者身份进行检查，MyBatis通过注解方式定义接口实现动态SQL生成中关键就是对数据类型的解析if(indexArg<0){return true;}MyParameterAnnotation AdvicerClass=(MyParameterAnnotation)advicerManagerClass;//处理切点方法参数的通知，大概思路如下：//1.解析参数类型//2.获取参数值//3.调用通知处理接口检查参数合法性//4.返回检查结果 true:false}return true;} /** *  * @Title: myAopUtilsManager   * @Description: Pointcut method execute advice interface * @param @param advicerManagerClass 类型 * @param @param paraValues pointcut传入参数 * @param @param paraTypes  pointcut传入参数类型 * @return void   * @throws */private static boolean methodAdvicerUtils(Annotation advicerManagerClass,Object[] paraValues, Class<?>... paraTypes){return parameterAdvicerUtils(advicerManagerClass,-1,paraValues,paraTypes);}/** *  * @Title: excuteMethodAdvicers   * @Description: TODO   * @param @param pointJoinMethod * @param @param paraValues       * @return void   * @throws */private static boolean excuteMethodAdvicers(Method pointJoinMethod,Object[] paraValues){boolean result=true;Annotation[] methodAnns=pointJoinMethod.getAnnotations();for(Annotation methodAnn:methodAnns){result=methodAdvicerUtils(methodAnn, paraValues,pointJoinMethod.getParameterTypes());if(!result){break;}}return result;}/** *  * @Title: excuteParameterAdvicers   * @Description: TODO   * @param @param pointJoinMethod * @param @param paraValues * @param @return       * @return boolean   * @throws */private static boolean excuteParameterAdvicers(Method pointJoinMethod,Object[] paraValues){boolean result=true;Annotation[][] parameterAnns=pointJoinMethod.getParameterAnnotations();if(parameterAnns==null||parameterAnns.length==0){return result;}for(int index=0;index<parameterAnns.length;index++){if(!result){break;}Annotation[] argAnns=parameterAnns[index];for(Annotation argAnn:argAnns){result=parameterAdvicerUtils(argAnn,index, paraValues,pointJoinMethod.getParameterTypes());if(!result){break;}}}return result;}/** *  * @Title: excuteAdvicer   * @Description: TODO   * @param @param pointJoinMethod 切点函数 * @param @param paraValues 切点函数 实参 * @param @param methodResultObj 切点函数 返回类型 * @param @return       * @return boolean   * @throws *//** *  * @Title: excuteAdvicer   * @Description: TODO   * @param @param pointJoinMethod 切点函数 * @param @param paraValues 切点函数      * @return void   * @throws */public static boolean excuteAdvicer(Method pointJoinMethod,Object[] paraValues,Object methodResultObj){boolean result=false;if(excuteParameterAdvicers(pointJoinMethod,paraValues))//切点函数定义的需要验证的通知验证通过后执行{result=excuteMethodAdvicers(pointJoinMethod, paraValues);}return result;}}

第三步:定义业务测试类

主要功能:实际开发中的业务核心类

package com.dbc.yangg.project;/** *  * @ClassName: TestAnnotation   * @Description: 测试模块中核心逻辑处理类,使用AOP实现日志管理、安全管理、事务管理  * @author [e-mail]   * @date 2014年1月18日 下午11:41:55   * */@MyClassAnnotation("TestAnnotation")public class TestAnnotation extends AbstractTestAnnotation{@MyMethodAnnotation(methodName = "print")public void print() {// TODO Auto-generated method stubSystem.out.println("pointcut method1  running,method name:print");}/** *  *   定义切点 *   通知类{@link MyTestAdvice} *   通知方式函数名:doSomeIdleThing * @param parameter   * @see com.dbc.yangg.project.AbstractTestAnnotation#setParameter(java.lang.String[]) */@MyPointcutAnnotation(className = MyTestAdvice.class, method = "doSomeIdleThing")public void setParameter(@MyParameterAnnotation(opType = { MyAopParameterOPType.checkForDB,MyAopParameterOPType.checkForSecurity }, paraType = String[].class) String[] parameter) {// TODO Auto-generated method stubSystem.out.println(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");System.out.println("business method  running...");System.out.println("<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<");}}

第四步:定义业务AOP处理类

功能：当执行核心业务中切点时执行的通知

package com.dbc.yangg.project;/** *  * @ClassName: MyTestAdvice   * @Description: spring AOP{@link TestAnnotation}}切点处理类 (同spring AOP 切面类@Aspect) * @author [e-mail]   * @date 2014年1月18日 下午11:38:09   * */public class MyTestAdvice {/** *  * @Title: doSomeIdleThing   * @Description: {@link TestAnnotation}中setParameter切点执行时触发此通知@Before,@After,@Around,@AfterThrowing,@AfterReturning<br> * @param @param parameter       * @return void   * @throws */public void doSomeIdleThing(String[] parameter){System.out.println(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");System.out.println("proxy method start running...");for(String str:parameter){System.out.println("advice writer!print point args value:"+str);}System.out.println("<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<");}}

第五步:测试

package com.dbc.yangg.project;  import java.lang.annotation.Annotation;import java.lang.reflect.InvocationTargetException;import java.lang.reflect.Method;  public class Init {public static void main(String[] args){try {String[] arg={"hadoop","hbase","pig","hive","mahout","hdfs","mapreduce","yarn"};Object[] objs=new Object[1];objs[0]=arg;Class busClass=Class.forName(TestAnnotation.class.getName());Method busMethod=busClass.getMethod("setParameter", String[].class);busMethod.invoke(busClass.newInstance(), objs);MyAOPUtils.excuteAdvicer(busMethod,objs);} catch (ClassNotFoundException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (NoSuchMethodException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (SecurityException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (IllegalAccessException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (IllegalArgumentException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (InvocationTargetException e) {// TODO Auto-generated catch block  e.printStackTrace();} catch (InstantiationException e) {// TODO Auto-generated catch block  e.printStackTrace();} }}

测试结果:

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>business method  running...<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>proxy method start running...advice writer:hadoopadvice writer:hbaseadvice writer:pigadvice writer:hiveadvice writer:mahoutadvice writer:hdfsadvice writer:mapreduceadvice writer:yarn<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<