spring boot+自定義 AOP 實現全域性校驗

最近公司重構專案，重構為最熱的微服務框架 spring boot， 重構的時候遇到幾個可以統一處理的問題，也是專案中經常遇到，列如：統一校驗引數，統一捕獲異常。。。

僅憑程式碼 去控制引數的校驗，有時候是冗餘的，但通過框架支援的 去控制引數的校驗，是對於開發者很友好，先看下面的例子

    @NotEmpty(message="手機號不能為空")
    @Size(min=11,max=11,message="手機號碼長度不正確")
    @Pattern(regexp=StringUtils.REGEXP_MOBILE,message="手機號格式不正確")
    private String mobile;

這是spring boot支援的 校驗註解，然後我們在 contoller層 加上@Valid 註解 就可以達到校驗的目的。這是一種框架自帶的

本章 就展示一種 自定義的 AOP 校驗，首先 寫一個註解，註解裡面可以寫上 我們需要校驗的規則， 比如長度，正則。。。

@Documented
@Target({ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidateParam {

    int min() default 0;
    
    int max() default Integer.MAX_VALUE;
    
    String message() default "params is not null";
     
    String regexp();
    
    Class<?>[] groups() default { };

     Class<? extends Payload>[] payload() default { };
     
     boolean isNotNull() default true;

}

然後定義一個AOP類

package com.onecard.primecard.common.aop;

import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.regex.Pattern;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.stereotype.Component;

import com.jfcf.core.dto.ResultData;
import com.onecard.core.support.util.StringUtils;
import com.onecard.primecard.common.annotation.ValidateParam;
import com.onecard.primecard.common.utils.ResultDataUtil;




/**
 * 全域性 切面類(校驗引數)
 * 
 * @author Administrator
 *
 */
@Aspect
@Component
public class GobalHandlerAspect {
    
    private static Logger logger = LoggerFactory.getLogger(GobalHandlerAspect.class);
    
    @Pointcut("execution(* 包名.controller..*.*(..)) && execution(* 包名.controller..*.*(..))")
    public void checkAspect(){};
    
    @Before("checkAspect()")
    public void befor(JoinPoint joinPoint) throws Exception{
        //前置統一輸出引數
        Object[] args = joinPoint.getArgs();
        if(args != null && args.length>0){
            Object obj = args[0];
            ParameterizedType pt = (ParameterizedType)obj.getClass().getGenericSuperclass();
            Class<?> classzz = (Class<?>) pt.getActualTypeArguments()[0];
            logger.info("【小X卡】-【請求實體入參】："+classzz.newInstance().toString());
        }
        
    }
    
    @Around("checkAspect()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable{
        //校驗引數
        Object[] args = joinPoint.getArgs();
        Object obj = null;
        if(args != null && args.length > 0){
            obj = args[0];
            Class classzz = obj.getClass();
            //沒有順序和秩序的陣列
            Field[] fieldArray = classzz.getDeclaredFields();
            ArrayList<Field> fieldList = new ArrayList<Field>(Arrays.asList(fieldArray));
            String res = checkParam(fieldList,obj);
            if(StringUtils.isNotNull(res)){
                return ResultDataUtil.result(ResultData.STATUS_PARAM_ERROR, res);
            }
        }
        
        return joinPoint.proceed();
    }

    private String checkParam(ArrayList<Field> fieldList, Object obj) throws Exception {
        
        for(Field field : fieldList){
            ValidateParam validateParam = field.getAnnotation(ValidateParam.class);
            logger.info("【小X卡】獲取註解值："+validateParam.isNotNull()+"min="+validateParam.min()+"max="+validateParam.max());
            Method method = obj.getClass().getMethod("get"+getMethodName(field.getName()));
            logger.info("【小X卡】入參實體方法名稱："+method.getName());
            if(method != null){
                Object val = method.invoke(obj);
                logger.info("【小x卡】回撥方法："+val);
                if(validateParam != null && validateParam.isNotNull() == true){
                    if(null == val || "".equals(val) ){
                        return field.getName()+"必填引數為空";
                    }
                }
                if(validateParam.min()==11 && validateParam.max() == 11){
                    if(val.toString().length() != 11){
                        return field.getName()+"請輸入引數正確的長度";
                    }
                }
                if(validateParam.regexp().equals(StringUtils.REGEXP_MOBILE)){
                    if(!Pattern.matches(StringUtils.REGEXP_MOBILE, val.toString())){
                        return field.getName()+"引數格式錯誤";
                    }
                }
            }
        }
        return null;
    }
    
    
     /**
     * 方法首字母大寫
     * @param fieldName
     * @return
     */
    private String getMethodName(String fieldName) {
        StringBuffer buffer = new StringBuffer();
        String firstLetter = fieldName.substring(0, 1).toUpperCase();
        return buffer.append(firstLetter).append(fieldName.substring(1, fieldName.length())).toString();

    }       
 }

定義一個切點 @Pointcut， 用execution 表示式，去獲取要校驗的 某個類 和某個方法， 也就是連線點，然後 用定義一個通知，上面程式碼中有2個通知，一個前置通知@Before，一個環繞通知@Around，我們使用功能最強大的環繞通知。

通過上面的程式碼可以看出  首先獲取引數，然後通過反射機制 獲取 入參物件中的全部欄位， 再去獲取 我們在欄位中加 我們自定義註解的欄位，通過反射方法的回撥，獲取欄位值，對值做判斷， 返回校驗結果。