SpringBoot利用validation實現(xiàn)優(yōu)雅的校驗參數(shù)
1、前言
數(shù)據(jù)的校驗是交互式網(wǎng)站一個不可或缺的功能，前端的js校驗可以涵蓋大部分的校驗職責(zé)，如用戶名唯一性，生日格式，郵箱格式校驗等等常用的校驗。但是為了避免用戶繞過瀏覽器，使用http工具直接向后端請求一些違法數(shù)據(jù)，服務(wù)端的數(shù)據(jù)校驗也是必要的，可以防止臟數(shù)據(jù)落到數(shù)據(jù)庫中，如果數(shù)據(jù)庫中出現(xiàn)一個非法的郵箱格式，也會讓運維人員頭疼不已?？梢允褂帽疚膶⒁榻B的validation來對數(shù)據(jù)進(jìn)行校驗。
2、常用校驗
1.JSR303/JSR-349: JSR303是一項標(biāo)準(zhǔn),只提供規(guī)范不提供實現(xiàn)，規(guī)定一些校驗規(guī)范即校驗注解，如@Null，@NotNull，@Pattern，位于javax.validation.constraints包下。JSR-349是其的升級版本，添加了一些新特性。
- @Null 被注釋的元素必須為null
- @NotNull 被注釋的元素必須不為null
- @AssertTrue 被注釋的元素必須為true
- @AssertFalse 被注釋的元素必須為false
- @Min(value) 被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
- @Max(value) 被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
- @DecimalMin(value) 被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
- @DecimalMax(value) 被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
- @Size(max, min) 被注釋的元素的大小必須在指定的范圍內(nèi)
- @Digits (integer, fraction) 被注釋的元素必須是一個數(shù)字，其值必須在可接受的范圍內(nèi)
- @Past 被注釋的元素必須是一個過去的日期
- @Future 被注釋的元素必須是一個將來的日期
- @Pattern(value) 被注釋的元素必須符合指定的正則表達(dá)式
2.hibernate validation：hibernate validation是對這個規(guī)范的實現(xiàn)，并增加了一些其他校驗注解，如@Email，@Length，@Range等等
- @Email 被注釋的元素必須是電子郵箱地址
- @Length 被注釋的字符串的大小必須在指定的范圍內(nèi)
- @NotEmpty 被注釋的字符串的必須非空
- @Range 被注釋的元素必須在合適的范圍內(nèi)
3.spring validation：spring validation對hibernate validation進(jìn)行了二次封裝，在springmvc模塊中添加了自動校驗，并將校驗信息封裝進(jìn)了特定的類中
3、spring boot的數(shù)據(jù)自動校驗功能
3.1 引入依賴
spring-web模塊使用了hibernate-validation，并且databind模塊也提供了相應(yīng)的數(shù)據(jù)綁定功能。
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
我們只需要引入spring-boot-starter-web依賴即可，如果查看其子依賴，可以發(fā)現(xiàn)如下的依賴：
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
3.2 構(gòu)建啟動類
@SpringBootApplication
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
System.out.println("Start app success.");
}
}
3.3 創(chuàng)建需要被校驗的實體類
public class Person {
@NotEmpty(message = "name不能為空")
private String name;
@Range(min = 0, max = 100, message = "age不能大于100小于0")
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
3.4 在Controller中校驗數(shù)據(jù)
springmvc為我們提供了自動封裝表單參數(shù)的功能，一個添加了參數(shù)校驗的典型controller如下所示。
@RequestMapping("/test")
public String valid(@Validated Person person, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
for (FieldError fieldError : bindingResult.getFieldErrors()) {
System.out.println(fieldError);
}
return "fail";
}
return "success";
}
值得注意的地方：
- 參數(shù)Persison前需要加上@Validated注解，表明需要spring對其進(jìn)行校驗，而校驗的信息會存放到其后的BindingResult中。注意，必須相鄰，如果有多個參數(shù)需要校驗，形式可以如下。valid(@Validated Person person, BindingResult personBindingResult ，@Validated Person2 person2, BindingResult person2BindingResult);即一個校驗類對應(yīng)一個校驗結(jié)果。
- 校驗結(jié)果會被自動填充，在controller中可以根據(jù)業(yè)務(wù)邏輯來決定具體的操作，如跳轉(zhuǎn)到錯誤頁面。
一個最基本的校驗就完成了.
啟動容器測試結(jié)果如下：
Field error in object 'person' on field 'age': rejected value [105]; codes [Range.person.age,Range.age,Range.int,Range]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [person.age,age]; arguments []; default message [age],100,0]; default message [age不能大于100小于0]
3.5 統(tǒng)一異常處理
前面那種方式處理校驗錯誤，略顯復(fù)雜，而且一般網(wǎng)站都會對請求錯誤做統(tǒng)一的404頁面封裝，如果數(shù)據(jù)校驗不通過，則Spring boot會拋出BindException異常，我們可以捕獲這個異常并使用Result封裝返回結(jié)果。通過@RestControllerAdvice定義異常捕獲類。
Controller類：
@RequestMapping(value = "valid", method = RequestMethod.GET)
public String valid(@Validated Person person) {
System.out.println(person);
return "success";
}
統(tǒng)一異常處理類：
@RestControllerAdvice
public class BindExceptionHanlder {
@ExceptionHandler(BindException.class)
public String handleBindException(HttpServletRequest request, BindException exception) {
List<FieldError> allErrors = exception.getFieldErrors();
StringBuilder sb = new StringBuilder();
for (FieldError errorMessage : allErrors) {
sb.append(errorMessage.getField()).append(": ").append(errorMessage.getDefaultMessage()).append(", ");
}
System.out.println(sb.toString());
return sb.toString();
}
}
測試: http://localhost:8080/valid?age=105&name=steven
輸出：age: age不能大于100小于0,
4、自定義校驗注解
4.1 @NameValidation
@Documented
@Constraint(validatedBy = NameValidationValidator.class)
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RUNTIME)
public @interface NameValidation {
String message() default "不是合法的名字";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
@Target({PARAMETER, ANNOTATION_TYPE})
@Retention(RUNTIME)
@Documented
@interface List {
NameValidation[] value();
}
}
4.2 校驗類NameValidationValidator
public class NameValidationValidator implements ConstraintValidator<NameValidation, String> {
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if ("steven".equalsIgnoreCase(value)) {
return true;
}
String defaultConstraintMessageTemplate = context.getDefaultConstraintMessageTemplate();
System.out.println("default message :" + defaultConstraintMessageTemplate);
//禁用默認(rèn)提示信息
//context.disableDefaultConstraintViolation();
//設(shè)置提示語
//context.buildConstraintViolationWithTemplate("can not contains blank").addConstraintViolation();
return false;
}
}
4.3 在Person類增加新注解
@NotEmpty(message = "name不能為空") @NameValidation private String name;
測試: http://localhost:8080/valid?age=105&name=lxy
輸出：age: age不能大于100小于0, name: 不是合法的名字,
5、總結(jié)
通過上面的例子可以看出，其實使用很簡單，但是有沒有注意到一個問題，錯誤信息沒有實現(xiàn)國際化。hibernate-validator國際化還是比較繁瑣的，包含：
- SpringBoot場景國際化
- SpringMvc場景國際化
- Spring Jersey場景國際化
- 非Spring場景國際化
以上就是SpringBoot利用validation實現(xiàn)優(yōu)雅的校驗參數(shù)的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot validation校驗參數(shù)的資料請關(guān)注腳本之家其它相關(guān)文章！
- SpringBoot使用validation-api實現(xiàn)參數(shù)校驗的示例
- SpringBoot集成validation校驗參數(shù)遇到的坑
- SpringBoot集成Validation參數(shù)校驗
- SpringBoot使用validation做參數(shù)校驗說明
- SpringBoot?中使用?Validation?校驗參數(shù)的方法詳解
- SpringBoot?Validation提示信息國際化配置方式
- SpringBoot使用Validation進(jìn)行參數(shù)校驗的示例詳解
- springboot中使用Hibernate-Validation校驗參數(shù)詳解
- SpringBoot使用Validation校驗參數(shù)的詳細(xì)過程
- SpringBoot Validation入?yún)⑿ｒ瀲H化的項目實踐
相關(guān)文章
MyBatis 是一款優(yōu)秀的持久層框架，它支持定制化 SQL、存儲過程以及高級映射。本文重點給大家介紹Mybatis的環(huán)境搭建和使用實例代碼，需要的朋友參考下吧2017-12-12
相信很多人都接觸spring框架很長時間了，每次搭建spring框架的時候都需要配置好多的jar、xml，做很多繁瑣重復(fù)的配置，稍微不留神就會出現(xiàn)各種各樣的問題。今天給大家介紹一下如何利用Spring Boot快速的搭建一個簡單的web應(yīng)用2017-03-03
SpringBoot實現(xiàn)接口數(shù)據(jù)的加解密功能
這篇文章主要介紹了SpringBoot實現(xiàn)接口數(shù)據(jù)的加解密功能,對接口的加密解密操作主要有兩種實現(xiàn)方式，文中給大家詳細(xì)介紹，需要的朋友可以參考下2019-10-10
淺談SpringCloud的微服務(wù)架構(gòu)組件
這篇文章主要介紹了淺談SpringCloud的微服務(wù)架構(gòu)組件,Spring Cloud根據(jù)分布式服務(wù)協(xié)調(diào)治理的需求成立了許多子項目，每個項目通過特定的組件去實現(xiàn),需要的朋友可以參考下2023-04-04
這篇文章主要介紹了詳解Java Spring各種依賴注入注解的區(qū)別的相關(guān)資料,需要的朋友可以參考下2016-03-03
這篇文章主要為大家詳細(xì)介紹了如何利用Java讀取csv文件的兩種方式,文中的示例代碼講解詳細(xì),對大家的學(xué)習(xí)或工作有一定的幫助,感興趣的小伙伴可以了解一下2023-12-12
Java數(shù)據(jù)結(jié)構(gòu)與算法入門實例詳解
這篇文章主要介紹了Java數(shù)據(jù)結(jié)構(gòu)與算法入門實例詳解,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-03-03
Spring ApplicationContext接口功能詳細(xì)介紹
ApplicationContext是Spring應(yīng)用程序中的中央接口，由于繼承了多個組件，使得ApplicationContext擁有了許多Spring的核心功能，如獲取bean組件，注冊監(jiān)聽事件，加載資源文件等2023-02-02
在本篇文章里小編給大家整理的是一篇關(guān)于java中關(guān)于return返回值的用法詳解內(nèi)容，有興趣的朋友們可以學(xué)習(xí)參考下。2020-12-12
網(wǎng)絡(luò)編程是指編寫運行在多個設(shè)備（計算機(jī)）的程序，這些設(shè)備都通過網(wǎng)絡(luò)連接起來。本文介紹了一些網(wǎng)絡(luò)編程基礎(chǔ)的概念，并用Java來實現(xiàn)TCP和UDP的Socket的編程，來讓讀者更好的了解其原理2021-08-08