Spring中校驗(yàn)器(Validator)的深入講解
前言
Spring框架的 validator 組件,是個(gè)輔助組件,在進(jìn)行數(shù)據(jù)的完整性和有效性非常有用,通過定義一個(gè)某個(gè)驗(yàn)證器,即可在其它需要的地方,使用即可,非常通用。
應(yīng)用在執(zhí)行業(yè)務(wù)邏輯之前,必須通過校驗(yàn)保證接受到的輸入數(shù)據(jù)是合法正確的,但很多時(shí)候同樣的校驗(yàn)出現(xiàn)了多次,在不同的層,不同的方法上,導(dǎo)致代碼冗余,浪費(fèi)時(shí)間,違反DRY原則。
- 每一個(gè)控制器都要校驗(yàn)
- 過多的校驗(yàn)參數(shù)會(huì)導(dǎo)致代碼太長(zhǎng)
- 代碼的復(fù)用率太差,同樣的代碼如果出現(xiàn)多次,在業(yè)務(wù)越來越復(fù)雜的情況下,維護(hù)成本呈指數(shù)上升。
可以考慮把校驗(yàn)的代碼封裝起來,來解決出現(xià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í)例
說了這么多廢話,上代碼。
1、引入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>
2、編寫校驗(yàn)對(duì)象
@Data public class User { // 名字不允許為空,并且名字的長(zhǎng)度在2位到30位之間 // 如果名字的長(zhǎng)度校驗(yàn)不通過,那么提示錯(cuò)誤信息 @NotNull @Size(min=2, max=30,message = "請(qǐng)檢查名字的長(zhǎng)度是否有問題") private String name; // 不允許為空,并且年齡的最小值為18 @NotNull @Min(18) private Integer age; }
3、創(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來存儲(chǔ)校驗(yàn)信息 @RequestMapping("/test1") public Object test1( @Valid User user, BindingResult bindingResult ) { //如果檢驗(yàn)出了問題,就返回錯(cuò)誤信息 // 這里我們返回的是全部的錯(cuò)誤信息,實(shí)際中可根據(jù)bindingResult的方法根據(jù)需要返回自定義的信息。 // 通常的解決方案為:JSR-303 + 全局ExceptionHandler if (bindingResult.hasErrors()){ return bindingResult.getAllErrors(); } return "OK"; } }
4、運(yùn)行應(yīng)用
稍作演示下運(yùn)行的結(jié)果,可以看出校驗(yàn)框架已經(jīng)生效了。
校驗(yàn)?zāi)挲g
校驗(yàn)名稱
校驗(yà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è)過去的日期
@Future 被注釋的元素必須是一個(gè)將來的日期
@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í)候,第三方庫中并沒有我們想要的校驗(yàn)類型,好在系統(tǒng)提供了很好的擴(kuò)展能力,我們可以自定義檢驗(yàn)。
比如,我們想校驗(yàn)用戶的手機(jī)格式,寫手機(jī)號(hào)碼校驗(yàn)器
1、編寫校驗(yàn)注解
// 我們可以直接拷貝系統(tǒng)內(nèi)的注解如@Min,復(fù)制到我們新的注解中,然后根據(jù)需要修改。 @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER}) @Retention(RUNTIME) @Documented //注解的實(shí)現(xiàn)類。 @Constraint(validatedBy = {IsMobileValidator.class}) public @interface IsMobile { //校驗(yàn)錯(cuò)誤的默認(rèn)信息 String message() default "手機(jī)號(hào)碼格式有問題"; //是否強(qiáng)制校驗(yàn) boolean isRequired() default false; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
2、編寫具體的實(shí)現(xiàn)類
我們知道注解只是一個(gè)標(biāo)記,真正的邏輯還要在特定的類中實(shí)現(xiàn),上一步的注解指定了實(shí)現(xiàn)校驗(yàn)功能的類為IsMobileValidator。
// 自定義注解一定要實(shí)現(xiàn)ConstraintValidator接口奧,里面的兩個(gè)參數(shù) // 第一個(gè)為 具體要校驗(yàn)的注解 // 第二個(gè)為 校驗(yàn)的參數(shù)類型 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); } } } }
3、測(cè)試自定義注解的功能
@Data public class User { @NotNull @Size(min=2, max=30,message = "請(qǐng)檢查名字的長(zhǎng)度是否有問題") private String name; @NotNull @Min(18) private Integer age; //這里是新添加的注解奧 @IsMobile private String phone; }
4、測(cè)試
通過
手機(jī)號(hào)有問題
可以看出自定義的注解已經(jīng)生效了。
我們還可以繼續(xù)優(yōu)化的地方,新建一個(gè)全局的異常,如果校驗(yàn)失敗的話,拋出全局的業(yè)務(wù)異常,捕獲業(yè)務(wù)異常,然后返回用戶友好的提示信息。
額外
也可以通過方法的校驗(yàn)。
1、控制器上添加@Validated注解
2、在控制器的方法上添加校驗(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; } }
類的校驗(yàn)規(guī)則
最后
通過使用校驗(yàn)器,所有的控制器,我們都不用再去做校驗(yàn)啦,代碼再回看是不是清爽很多。我們寫代碼很簡(jiǎn)答,但是一定要想到如何把代碼寫的更簡(jiǎn)單,更清晰,更利于維護(hù),寫重復(fù)的代碼是在浪費(fèi)自己的時(shí)間奧。
以后再碰到參數(shù)校驗(yàn)的情況,首先想到的不是直接就去校驗(yàn),可以查找自己是否寫過某一類的驗(yàn)證器,可以直接拿來即用。
總結(jié)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對(duì)腳本之家的支持。
- SpringBoot使用Validator進(jìn)行參數(shù)校驗(yàn)實(shí)戰(zhàn)教程(自定義校驗(yàn),分組校驗(yàn))
- 如何通過自定義spring?invalidator注解校驗(yàn)數(shù)據(jù)合法性
- Spring 校驗(yàn)(validator,JSR-303)簡(jiǎn)單實(shí)現(xiàn)方式
- springboot validator枚舉值校驗(yàn)功能實(shí)現(xiàn)
- SpringBoot 使用hibernate validator校驗(yàn)
- springboot使用Validator校驗(yàn)方式
- springboot使用hibernate validator校驗(yàn)方式
- Spring Validator從零掌握對(duì)象校驗(yàn)的詳細(xì)過程
相關(guān)文章
Spring與Mybatis相結(jié)合實(shí)現(xiàn)多數(shù)據(jù)源切換功能
這篇文章主要介紹了Spring與Mybatis相結(jié)合實(shí)現(xiàn)多數(shù)據(jù)源切換功能的相關(guān)資料,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-06-06關(guān)于重寫equals()方法和hashCode()方法及其簡(jiǎn)單的應(yīng)用
這篇文章主要介紹了關(guān)于重寫equals()方法和hashCode()方法及其簡(jiǎn)單的應(yīng)用,網(wǎng)上的知識(shí)有些可能是錯(cuò)誤的,關(guān)于?equals()?方法的理解,大家討論不一樣,需要的朋友可以參考下2023-04-04Java網(wǎng)絡(luò)通信中ServerSocket的設(shè)計(jì)優(yōu)化方案
今天小編就為大家分享一篇關(guān)于Java網(wǎng)絡(luò)通信中ServerSocket的設(shè)計(jì)優(yōu)化方案,小編覺得內(nèi)容挺不錯(cuò)的,現(xiàn)在分享給大家,具有很好的參考價(jià)值,需要的朋友一起跟隨小編來看看吧2019-04-04一文搞懂Java中對(duì)象池的實(shí)現(xiàn)
池化并不是什么新鮮的技術(shù),它更像一種軟件設(shè)計(jì)模式,主要功能是緩存一組已經(jīng)初始化的對(duì)象,以供隨時(shí)可以使用。本文將為大家詳細(xì)講講Java中對(duì)象池的實(shí)現(xiàn),需要的可以參考一下2022-07-07