Spring校驗(yàn)器，參數(shù)校驗(yàn)從此簡(jiǎn)單腔稀。
應(yīng)用在執(zhí)行業(yè)務(wù)邏輯之前盆昙，必須通過(guò)校驗(yàn)保證接受到的輸入數(shù)據(jù)是合法正確的，但很多時(shí)候同樣的校驗(yàn)出現(xiàn)了多次焊虏，在不同的層弱左，不同的方法上，導(dǎo)致代碼冗余炕淮，浪費(fèi)時(shí)間拆火，違反DRY原則。
- 每一個(gè)控制器都要校驗(yàn)
- 過(guò)多的校驗(yàn)參數(shù)會(huì)導(dǎo)致代碼太長(zhǎng)
- 代碼的復(fù)用率太差，同樣的代碼如果出現(xiàn)多次们镜，在業(yè)務(wù)越來(lái)越復(fù)雜的情況下币叹，維護(hù)成本呈指數(shù)上升。
可以考慮把校驗(yàn)的代碼封裝起來(lái)模狭，來(lái)解決出現(xiàn)的這些問(wèn)題颈抚。
JSR-303
JSR-303是Java為Bean數(shù)據(jù)合法性校驗(yàn)提供的標(biāo)準(zhǔn)框架，它定義了一套可標(biāo)注在成員變量嚼鹉，屬性方法上的校驗(yàn)注解贩汉。
Hibernate Validation提供了這套標(biāo)準(zhǔn)的實(shí)現(xiàn)，在我們引入Spring Boot web starter或者Spring boot starter validation的時(shí)候锚赤，默認(rèn)會(huì)引入Hibernate Validation匹舞。
用法實(shí)例
說(shuō)了這么多廢話，上代碼线脚。
- 引入SpringBoot項(xiàng)目
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
<!-- 引入lomhok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
- 編寫(xiě)校驗(yàn)對(duì)象
@Data
public class User {
// 名字不允許為空赐稽，并且名字的長(zhǎng)度在2位到30位之間
// 如果名字的長(zhǎng)度校驗(yàn)不通過(guò)，那么提示錯(cuò)誤信息
@NotNull
@Size(min=2, max=30,message = "請(qǐng)檢查名字的長(zhǎng)度是否有問(wèn)題")
private String name;
// 不允許為空浑侥，并且年齡的最小值為18
@NotNull
@Min(18)
private Integer age;
}
- 創(chuàng)建控制器
@SpringBootApplication
@RestController
public class UserApplication{
public static void main(String[] args) {
SpringApplication.run(UserApplication.class,args);
}
// 1. 要校驗(yàn)的參數(shù)前姊舵，加上@Valid注解
// 2. 緊隨其后的，跟上一個(gè)BindingResult來(lái)存儲(chǔ)校驗(yàn)信息
@RequestMapping("/test1")
public Object test1(
@Valid User user,
BindingResult bindingResult
) {
//如果檢驗(yàn)出了問(wèn)題寓落，就返回錯(cuò)誤信息
// 這里我們返回的是全部的錯(cuò)誤信息括丁，實(shí)際中可根據(jù)bindingResult的方法根據(jù)需要返回自定義的信息。
// 通常的解決方案為：JSR-303 + 全局ExceptionHandler
if (bindingResult.hasErrors()){
return bindingResult.getAllErrors();
}
return "OK";
}
}
- 運(yùn)行應(yīng)用
稍作演示下運(yùn)行的結(jié)果伶选，可以看出校驗(yàn)框架已經(jīng)生效了躏将。
常見(jiàn)的校驗(yàn)注解
@Null 被注釋的元素必須為 null
@NotNull 被注釋的元素必須不為 null
@AssertTrue 被注釋的元素必須為 true
@AssertFalse 被注釋的元素必須為 false
@Min(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值
@Max(value) 被注釋的元素必須是一個(gè)數(shù)字考蕾，其值必須小于等于指定的最大值
@DecimalMin(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值
@DecimalMax(value) 被注釋的元素必須是一個(gè)數(shù)字会宪，其值必須小于等于指定的最大值
@Size(max=, min=) 被注釋的元素的大小必須在指定的范圍內(nèi)
@Digits (integer, fraction) 被注釋的元素必須是一個(gè)數(shù)字肖卧，其值必須在可接受的范圍內(nèi)
@Past 被注釋的元素必須是一個(gè)過(guò)去的日期
@Future 被注釋的元素必須是一個(gè)將來(lái)的日期
@Pattern(regex=,flag=) 被注釋的元素必須符合指定的正則表達(dá)式
Hibernate Validator提供的校驗(yàn)注解：
@NotBlank(message =) 驗(yàn)證字符串非null，且長(zhǎng)度必須大于0
@Email 被注釋的元素必須是電子郵箱地址
@Length(min=,max=) 被注釋的字符串的大小必須在指定的范圍內(nèi)
@NotEmpty 被注釋的字符串的必須非空
@Range(min=,max=,message=) 被注釋的元素必須在合適的范圍內(nèi)
自定義校驗(yàn)注解
有時(shí)候掸鹅，第三方庫(kù)中并沒(méi)有我們想要的校驗(yàn)類(lèi)型塞帐，好在系統(tǒng)提供了很好的擴(kuò)展能力巍沙，我們可以自定義檢驗(yàn)葵姥。
比如句携，我們想校驗(yàn)用戶(hù)的手機(jī)格式榔幸，寫(xiě)手機(jī)號(hào)碼校驗(yàn)器
- 編寫(xiě)校驗(yàn)注解
// 我們可以直接拷貝系統(tǒng)內(nèi)的注解如@Min，復(fù)制到我們新的注解中，然后根據(jù)需要修改鳞陨。
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
//注解的實(shí)現(xiàn)類(lèi)灰嫉。
@Constraint(validatedBy = {IsMobileValidator.class})
public @interface IsMobile {
//校驗(yàn)錯(cuò)誤的默認(rèn)信息
String message() default "手機(jī)號(hào)碼格式有問(wèn)題";
//是否強(qiáng)制校驗(yàn)
boolean isRequired() default false;
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
- 編寫(xiě)具體的實(shí)現(xiàn)類(lèi)
我們知道注解只是一個(gè)標(biāo)記奇适，真正的邏輯還要在特定的類(lèi)中實(shí)現(xiàn)号胚，上一步的注解指定了實(shí)現(xiàn)校驗(yàn)功能的類(lèi)為IsMobileValidator永高。
// 自定義注解一定要實(shí)現(xiàn)ConstraintValidator接口奧蔬胯，里面的兩個(gè)參數(shù)
// 第一個(gè)為 具體要校驗(yàn)的注解
// 第二個(gè)為 校驗(yàn)的參數(shù)類(lèi)型
public class IsMobileValidator implements ConstraintValidator<IsMobile, String> {
private boolean required = false;
private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");
//工具方法资盅，判斷是否是手機(jī)號(hào)
public static boolean isMobile(String src) {
if (StringUtils.isEmpty(src)) {
return false;
}
Matcher m = mobile_pattern.matcher(src);
return m.matches();
}
@Override
public void initialize(IsMobile constraintAnnotation) {
required = constraintAnnotation.isRequired();
}
@Override
public boolean isValid(String phone, ConstraintValidatorContext constraintValidatorContext) {
//是否為手機(jī)號(hào)的實(shí)現(xiàn)
if (required) {
return isMobile(phone);
} else {
if (StringUtils.isEmpty(phone)) {
return true;
} else {
return isMobile(phone);
}
}
}
}
- 測(cè)試自定義注解的功能
@Data
public class User {
@NotNull
@Size(min=2, max=30,message = "請(qǐng)檢查名字的長(zhǎng)度是否有問(wèn)題")
private String name;
@NotNull
@Min(18)
private Integer age;
//這里是新添加的注解奧
@IsMobile
private String phone;
}
-
測(cè)試
通過(guò)
可以看出自定義的注解已經(jīng)生效了狈邑。
我們還可以繼續(xù)優(yōu)化的地方蹂匹，新建一個(gè)全局的異常碘菜，如果校驗(yàn)失敗的話，拋出全局的業(yè)務(wù)異常限寞，捕獲業(yè)務(wù)異常忍啸，然后返回用戶(hù)友好的提示信息。
額外
也可以通過(guò)方法的校驗(yàn)履植。
- 控制器上添加@Validated注解
- 在控制器的方法上添加校驗(yàn)注解计雌，@Min，@Max等玫霎。
@Validated
@RestController
@SpringBootApplication
public class UserApplication{
public static void main(String[] args) {
SpringApplication.run(UserApplication.class,args);
}
@RequestMapping("/test2")
public String test2(
@IsMobile String phone
){
return phone + "ok";
}
@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
public Object handleConstraintViolationException(ConstraintViolationException cve){
HashSet<String> messageSet = new HashSet();
for (ConstraintViolation constraintViolation : cve.getConstraintViolations()) {
messageSet.add(constraintViolation.getMessage());
}
return messageSet;
}
}
最后
通過(guò)使用校驗(yàn)器凿滤，所有的控制器，我們都不用再去做校驗(yàn)啦庶近，代碼再回看是不是清爽很多翁脆。我們寫(xiě)代碼很簡(jiǎn)答，但是一定要想到如何把代碼寫(xiě)的更簡(jiǎn)單鼻种，更清晰反番，更利于維護(hù)，寫(xiě)重復(fù)的代碼是在浪費(fèi)自己的時(shí)間奧叉钥。
以后再碰到參數(shù)校驗(yàn)的情況罢缸，首先想到的不是直接就去校驗(yàn)，可以查找自己是否寫(xiě)過(guò)某一類(lèi)的驗(yàn)證器投队，可以直接拿來(lái)即用枫疆。
希望能幫助大家。
