您好,登錄后才能下訂單哦!
這篇文章主要介紹“Java增加自定義注解進(jìn)行校驗入?yún)⒌姆椒ㄊ鞘裁础?,在日常操作中,相信很多人在Java增加自定義注解進(jìn)行校驗入?yún)⒌姆椒ㄊ鞘裁磫栴}上存在疑惑,小編查閱了各式資料,整理出簡單好用的操作方法,希望對大家解答”Java增加自定義注解進(jìn)行校驗入?yún)⒌姆椒ㄊ鞘裁础钡囊苫笥兴鶐椭?!接下來,請跟著小編一起來學(xué)習(xí)吧!
這里有三個參數(shù),分別是三個參數(shù)名稱,起始時間參數(shù)名稱,結(jié)束時間參數(shù)名稱,需要校驗的參數(shù)名稱
@Target({ElementType.PARAMETER, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface VerifyParameters { /** * 起始時間參數(shù)名稱 */ String startTimeParamName() default "startTime"; /** * 結(jié)束時間參數(shù)名稱 */ String endTimeParamName() default "endTime"; /** * 需要校驗的參數(shù)名稱 */ String paramName() default ""; }
這里貼一個完整的,目的是有的小伙伴想用的話,貼過去就能用。
@Component @Aspect public class VerifyParametersAspect { private static final Logger logger = LoggerFactory.getLogger(VerifyParametersAspect.class); /** * 切點(diǎn) */ @Pointcut("@annotation(com.guava.mall.app.annotation.VerifyParameters)") public void serviceAspect() { } /** * service 方法前調(diào)用 * * @param joinPoint */ @Before("serviceAspect()") public void doBeforeService(JoinPoint joinPoint) { try { //獲取方法參數(shù)名 MethodSignature signature = (MethodSignature) joinPoint.getSignature(); //獲取方法 Method method = signature.getMethod(); //獲取參數(shù)名 LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer(); String[] parameterNames = u.getParameterNames(method); Map<String, Object> params = new HashMap<>(8); params = getParamMap(joinPoint, method, parameterNames, params); //獲取注解 VerifyParameters verifyParameters = method.getAnnotation(VerifyParameters.class); //參數(shù)名 String paramName = verifyParameters.paramName(); Object o = params.get(paramName); ValidationUtils.validate(o == null, "參數(shù)不能為空"); ValidationUtils.validate(!atLeastOnePropertyNotNull(o), "請至少輸入一個查詢條件進(jìn)行查詢和導(dǎo)出"); //開始時間和結(jié)束時間的參數(shù)名 String s = verifyParameters.startTimeParamName(); String e = verifyParameters.endTimeParamName(); Map<?, ?> map = JSONUtils.bean2Map(o); Object startTime = map.get(s); Object endTime = map.get(e); if (startTime != null || endTime != null) { ValidationUtils.validate(startTime == null || endTime == null, "開始時間和結(jié)束時間必須同時存在"); ValidationUtils.validate(Integer.parseInt(String.valueOf(endTime)) - Integer.parseInt(String.valueOf(startTime)) > 30 * 24 * 60 * 60, "時間間隔不能超過一個月"); } } catch (NumberFormatException ex) { logger.error(ex.getMessage(), ex); } } private Map<String, Object> getParamMap(JoinPoint joinPoint, Method method, String[] parameterNames, Map<String, Object> params) { int i = 0; if (parameterNames != null && parameterNames.length > 0) { for (String parameterName : parameterNames) { params.put(parameterName, joinPoint.getArgs()[i]); i++; } } return params; } public static boolean atLeastOnePropertyNotNull(Object obj) { for (Field field : obj.getClass().getDeclaredFields()) { //忽略serialVersionUID if ("serialVersionUID".equals(field.getName())) { continue; } field.setAccessible(true); try { if (field.get(obj) != null && !field.get(obj).toString().isEmpty()) { return true; } } catch (IllegalAccessException e) { e.printStackTrace(); } } return false; } /** * 方法后調(diào)用 */ @After("serviceAspect()") public void doAfterInService(JoinPoint joinPoint) { } }
然后,解釋一下
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
這是我們的第一行代碼,這里的joinPoint對象表示應(yīng)用建議的程序執(zhí)行點(diǎn),getSignature()方法則會返回正在執(zhí)行的方法的方法簽名,簽名里就包含了該方法名稱、返回類型和參數(shù)類型。然后再強(qiáng)制轉(zhuǎn)換成MethodSignature
對象,便于訪問方法相關(guān)的信息。
MethodSignature是一個對象,它表示正在執(zhí)行的方法的簽名,包括方法名稱、返回類型和參數(shù)類型。它是Spring AOP框架中的一個類,用于在切面中獲取方法的信息。
Method method = signature.getMethod();獲取方法
這個則是從MethodSignature中獲取到了正在執(zhí)行的方法信息。
LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer();
LocalVariableTableParameterNameDiscoverer是一個類,它可以用于在運(yùn)行時獲取方法參數(shù)的名稱。它是Spring框架中的一個類,通常與反射一起使用,以便在運(yùn)行時獲取有關(guān)方法參數(shù)的信息。
通過 String[] parameterNames = u.getParameterNames(method);
可以獲取到目前方法的入?yún)⒚Q。
getParamMap();
方法則會返回一個key是參數(shù)名稱,value是參數(shù)本身的map對象。 我們可以從中取出我們需要的那個參數(shù)對象。
VerifyParameters verifyParameters = method.getAnnotation(VerifyParameters.class);
上邊這行代碼則會獲取到方法上注解的注解對象本身,和我們傳入的參數(shù)值,因為每個方法的入?yún)⒉槐M相同,里邊時間的字段也不盡相同,需要主動傳入來做處理。
這里再解釋下atLeastOnePropertyNotNull()
方法,這個方法的作用是判斷參數(shù)內(nèi)的屬性是否至少有一個不為空,這里我們忽略了serialVersionUID
。
serialVersionUID是Java中的一個序列化機(jī)制,用于在反序列化期間驗證發(fā)送方和接收方的對象是否具有兼容的序列化版本。如果發(fā)送方和接收方的serialVersionUID不同,則反序列化將失敗。如果未指定serialVersionUID,則Java運(yùn)行時將根據(jù)類的特定方面自動生成它。
之后的方法就很簡單了,拿出值根據(jù)我們的需要做處理即可
再看看是如何使用的吧,添加@VerifyParameters
注解,傳入時間的屬性名稱,和需要校驗的參數(shù)名稱,這里傳入?yún)?shù)名稱的原因是,可能和我這里一樣還有其他的參數(shù)影響,而我們只想校驗我們需要的參數(shù)。
@ApiOperation(value = "查詢列表") @GetMapping("/test") @VerifyParameters(startTimeParamName = "beginTime", endTimeParamName = "endTime",paramName = "orderRequest") public Page<Map<String, Object>> findOrderTestList(Pageable pageable, ERPOrderRequest orderRequest) { log.info("模擬邏輯處理"); return null; }
到此,關(guān)于“Java增加自定義注解進(jìn)行校驗入?yún)⒌姆椒ㄊ鞘裁础钡膶W(xué)習(xí)就結(jié)束了,希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí),快去試試吧!若想繼續(xù)學(xué)習(xí)更多相關(guān)知識,請繼續(xù)關(guān)注億速云網(wǎng)站,小編會繼續(xù)努力為大家?guī)砀鄬?shí)用的文章!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報,并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。