spring的pointcut正則表達式的實現

Posted on by

1.Pointcut表達式各部分的約束規則

在spring中配置切面或者數據庫的事務會要求：對具體方法或者是一類特征相同的方法添加日志，事務，或者其他對原方法的增強。這時候就會用到pointcut表達式對方法進行過濾，篩選出符合要求的方法；

既然會涉及到篩選具體的方法，那pointcut一定要匹配出完整的方法路徑：全限定類名+方法名；在同一個類中，方法可能被重寫而區分重寫的方法就是：參數列表；因此pointcut表達式中必須包含這3部分：全限定類名+方法名+參數列表；在spring中還有：訪問修飾符，返回值類型；這2個不是必須的；pointcut整體結構：

有瞭pointcut的整體結構之後就可以根據自己的規則,分別寫這幾部分的正則表達式瞭；

  • execution()這部分是固定寫法，它包含瞭完整的表達式；
  • 訪問修飾符，返回值，classPath，methodName之間用空格分開；
  • methodName，paramList用()分開；methodName(paramList);

1.1 ACCESS_MODIFIER 訪問修飾符

訪問修飾符有四種取值：public，private，protected，defalut； " * " ,對訪問修飾符不加限制；

1.2 RETURN_TYPE 返回值類型

返回值類型可以是任意類型：8個基礎類型 + 對象 + 數組 + void；

  • 基礎類型的匹配 BASIC_TYPE: (byte|char|boolean|short|int|long|double|float)
  • 對象匹配：[A-Z]\\w*
  • 返回類型可以是以上2種類型的數組(可以是2維，3維，4維.。。)；PARAM_TYPE = (BASIC_TYPE|[A-Z]\\w)(\\[\\])**

最後結合返回值：void， * （表示任意類型）；返回值的所有可能取值的正則表達式：（void|PARAM_TYPE|\\*)

1.3 CLASS_PATH 全限定類名

有一個特點：(packageName + “.”) * + className;包名，類名都可以用同一個正則表達式；

CLASS_PATH = "((\\*?\\w+\\*?|\\*)\\.)*(\\*?\\w+\\*?|\\*)";

1.4 EXECUTION 表達式

  METHOD_NAME,PARAM_LIST這2個的匹配分別參照：全限定類名，返回值類型的正則表達式；將這些部分分別寫完之後，再按順序組合一下就可以得到完整的表達式瞭；再考慮到，寫表達式的時候，會習慣性的敲空格，因此可以在合適的地方允許空格；

public class PointcutUtils {
    private static final String ACCESS_MODIFIER = "(public|private|protected|default|\\*)";

    private static final String RETURN_TYPE;

    private static final String CLASS_PATH = "((\\*?\\w+\\*?|\\*)\\.)*(\\*?\\w+\\*?|\\*)";

    private static final String METHOD_NAME = "(\\*?\\w+\\*?|\\*)";

    private static final String PARAM_LIST ;

    private static final String EXECUTION ;
    //基礎類型
    private static final String BASIC_TYPE="(byte|char|boolean|short|int|long|double|float)";
    //參數類型
    private static final String PARAM_TYPE;


    static{
        //參數類型：基礎類型 + Object + 數組類型
        PARAM_TYPE = "("+BASIC_TYPE+"|[A-Z]\\w*)(\\[\\])*";
        //返回值類型：void  + 參數類型
        RETURN_TYPE="(void|"+PARAM_TYPE+"|\\*)";
        //參數列表
        PARAM_LIST = "(\\.\\.|"+PARAM_TYPE+"(\\s*,\\s*"+PARAM_TYPE+")*" +"|)";
        //execution表達式
        EXECUTION = "\\s*execution\\s*\\(\\s*"+ACCESS_MODIFIER+"\\s+"+RETURN_TYPE+"\\s+"+CLASS_PATH+"\\s+"+METHOD_NAME+"\\(\\s*"+PARAM_LIST+"\\s*\\)\\s*"+"\\s*\\)\\s*";

    }
	//檢測pointcut是否是正確的
    static boolean  checkPointcut(String pointcutReg){
        return pointcutReg == null ? false : pointcutReg.matches(EXECUTION);
    }

}

得到的EXECUTION表達式可以用來檢測pointcut表達式是否寫正確；
測試：

        String pointcut = "execution ( default int[][] * rr( .. ) ) ";
        //default訪問修飾符，int[][]二維數組 ；
        // * 不限定類名； rr 方法名； .. 任意類型的參數列表；符合定義的規則，預期結果為 true
        boolean correct = PointcutUtils.checkPointcut(pointcut );
        System.out.println(correct);//結果：true

2.拆分pointcut表達式

拆分流程：

代碼：

	//拆分pointcut
    public static Pointcut parsePointcut(String pointcut){
        if(!checkPointcut(pointcut))throw new IllegalArgumentException("execution grammar format error.");
        String exeReg = getBracketStr(pointcut);//獲取execution();中括號包裹的部分；
        String paramList = getBracketStr(exeReg).replaceAll(" ","");
        int start = exeReg.indexOf("(");
        exeReg = exeReg.substring(0,start);
        String[] regs = exeReg.split("\\s+");
        String accessModifier = regs[0];
        String returnType = regs[1];
        String classPath = regs[2];
        String methodName = regs[3];
        return new Pointcut(accessModifier,returnType,classPath,methodName,paramList);
    }
    static String getBracketStr(String str){
        int start = str.indexOf("(");
        int end = str.lastIndexOf(")");
        return str.substring(start+1,end).trim();
    }

3.過濾

  分別匹配class和method；在拿到pointcut的時候，如何匹配class和method呢？這個時候要對類路徑的正則表達式做一下處理；比如：pointcut的classpath部分：

"*weqq*.dgdfgfg.df*"

*weqq*:我們希望能匹配到包名含有 weqq的包；直接使用這個作為正則表達式去匹配類路徑肯定是不行的；

 * ====》 重復匹配0次或多次前一個字符或者表達式；
 
如何能達到要求呢？隻需要做一下簡單處理就好瞭：*weqq* ====》 \\w*weqq\\w*;將 * 替換成 \\w* 就可以匹配字符瞭

還有需要註意的是 ".",在正則表達式中表示匹配任意字符；

而我們希望它隻是包的分割符，它隻表示" . ",而不需要有任何其他的含義，因此需要將 "."轉換成普通字符    ：  .  ===>   \\.

匹配class的類名

 public static boolean matchClass(Pointcut pointcut,Class cla){
        if(pointcut.getClassPath().equals("*"))return true;
        return cla.getTypeName().matches(pointcut.getClassPath().replaceAll("\\*","\\\\w*").replaceAll("\\.","\\\\."));
    }

匹配方法:訪問修飾符，返回值，方法名，參數列表

   public static boolean matchMethod(Pointcut pointcut, Method method){
       return matchModifier(pointcut.getAccessModifier(),method) &&
              matchReturnType(pointcut.getReturnType(),method) &&
              matchMethodName(pointcut.getMethodName(),method) &&
              matchParamList(pointcut.getParamList(),method);


   }

   static boolean matchModifier(String modifier,Method method){
       int modifiers = method.getModifiers();
        switch (modifier){
            case "default"  :return method.isDefault();
            case "public"   :return Modifier.isPublic(modifiers);
            case "private"  :return Modifier.isPrivate(modifiers);
            case "protected":return Modifier.isProtected(modifiers);
            case "*"        :return true;
            default:
                return false;
        }
   }

   static boolean matchReturnType(String returnType,Method method){
        if(returnType.equals("*"))return true;
       return returnType.equals(method.getReturnType().getSimpleName());
   }

   static boolean matchMethodName(String name,Method method){
        if(name.equals("*"))return true;
        return method.getName().matches(name.replaceAll("\\*","\\\\w*"));
   }

   static boolean matchParamList(String paramList,Method method){

        if(paramList.equals(".."))return true;

       Class<?>[] parameterTypes = method.getParameterTypes();
       if((paramList.equals("")) ){
           if( parameterTypes.length == 0 )return true;
           else return false;
       }
       StringBuilder methodParamList = new StringBuilder();
       for (Class<?> parameterType : parameterTypes) {
           methodParamList.append(","+parameterType.getSimpleName());
       }
        String methodParam =  methodParamList.toString().substring(1);
        return methodParam.equals(paramList);

   }

同時匹配上類和方法，就可以對方法增強瞭；其實可以看到在實現pointcut表達式隻用到瞭少量的正則表達式的知識；execution整體拼湊起來有點多，但是分開來看每部分還是簡單的；隻需要瞭解簡單的正則和反射，就可以自定義一個pointcut過濾器瞭。有瞭這個之後，就可以自己定義實現選擇性AOP瞭；

到此這篇關於spring的pointcut正則表達式的實現的文章就介紹到這瞭,更多相關spring pointcut正則表達式內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：