您好,登錄后才能下訂單哦!
最近公司重構項目,重構為最熱的微服務框架 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,我們使用功能最強大的環繞通知。
通過上面的代碼可以看出 首先獲取參數,然后通過反射機制 獲取 入參對象中的全部字段, 再去獲取 我們在字段中加 我們自定義注解的字段,通過反射方法的回調,獲取字段值,對值做判斷, 返回校驗結果。
總結
以上所述是小編給大家介紹的spring boot+自定義 AOP 實現全局校驗的實例代碼,希望對大家有所幫助,如果大家有任何疑問歡迎給我留言,小編會及時回復大家的!
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。