情景：需要對string類型的屬性比如description進行驗證，驗證規則是當description為空時不進行正則校驗，description不為空時進行正則校驗。上述需求hibernate validation沒有可用于上述需求的注解，故自定義一個注解并自定義校驗規則。
自定義注解進行校驗的步驟
- 寫一個校驗注解，在注解中指定校驗器類，校驗注解與校驗器一般一一對應。
- 寫一個校驗器類并在校驗器類中寫校驗邏輯，校驗器必須實現constraintvalidator<?, ?>接口，第一個參數是對應的注解，第二個參數是要校驗的屬性的類型
代碼示例
校驗注解
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
package com.kunlun.validation.annotation;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;import javax.validation.constraint;import javax.validation.payload;import com.kunlun.validation.validator.klpatternvalidator;/** * 自定義的校驗注解 * 規則： * 1.如果字符串為空串或者為null，則不進行正則校驗 * 2.如果字符串不為空串，則必須進行正則校驗 * @author xc * @date 2018年1月19日上午11:38:02 */@documented// 指定該注解可以使用的地方@target(value= {elementtype.field})@retention(retentionpolicy.runtime)// 指定實際進行校驗的校驗器，該校驗器是自己寫的且必須實現constraintvalidator接口@constraint(validatedby=klpatternvalidator.class)public @interface klpattern { /* * 用于驗證的注解下列這三個方法必須要，這是hibernate validation框架要求的，否則程序再在調用的時候會報錯 * default用于對屬性給定默認值 * 如果不給定默認值，則在使用注解的時候必須給屬性指定屬性值，否則報錯 * 給定默認值時，在使用注解的時候可以不用指定屬性值 */ string message() default "不符合正則！"; class<?>[] groups() default {}; class<? extends payload>[] payload() default {}; // 沒加default給定默認值，使用注解的時候該屬性必須賦值，否則報錯 string regex(); // value屬性，加上了default "mercy" 使得該屬性在使用注解的時候可以不用輸入也不會報錯 string value() default "mercy";} |
與上面校驗注解對應的校驗器類
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
package com.kunlun.validation.validator;import javax.validation.constraintvalidator;import javax.validation.constraintvalidatorcontext;import com.kunlun.validation.annotation.klpattern;/** * klpatternvalidator是klpattern注解實際調用的驗證器 * 在klpatternvalidator中完成校驗邏輯 * * @author xc * @date 2018年1月19日上午11:44:38 */public class klpatternvalidator implements constraintvalidator<klpattern, string> { private string regex; /** * 通過initialize()可以獲取注解里的屬性值 */ @override public void initialize(klpattern constraintannotation) { constraintvalidator.super.initialize(constraintannotation); regex = constraintannotation.regex(); } /** * 實際驗證邏輯 * 返回值為true表示驗證通過， * 返回值為false表示驗證未通過 */ @override public boolean isvalid(string s, constraintvalidatorcontext ctx) { // 當前前端傳過來的請求參數是空串，或者沒傳的時候，不進行后續正則校驗 if ("".equals(s) || s == null) { return true; } // 進行正則校驗 if(s.matches(regex)) { return true; } return false; }} |
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：https://blog.csdn.net/cccmercy/article/details/79105624
