SpringBoot接口如何對參數(shù)進行校驗
前言
在以SpringBoot開發(fā)Restful接口時, 對于接口的查詢參數(shù)后臺也是要進行校驗的，同時還需要給出校驗的返回信息放到上文我們統(tǒng)一封裝的結(jié)構(gòu)中。那么如何優(yōu)雅的進行參數(shù)的統(tǒng)一校驗?zāi)兀?/p>
什么是不優(yōu)雅的參數(shù)校驗
后端對前端傳過來的參數(shù)也是需要進行校驗的，如果在controller中直接校驗需要用大量的if else做判斷
以添加用戶的接口為例，需要對前端傳過來的參數(shù)進行校驗， 如下的校驗就是不優(yōu)雅的：
@RestController
@RequestMapping("/user")
public class UserController {
@PostMapping("add")
public ResponseEntity<String> add(User user){
if(user.getName()==null) {
return ResponseResult.fail("user name should not be empty");
} else if(user.getName().length()<5 || user.getName().length()>50){
return ResponseResult.fail("user name length should between 5-50");
}
if(user.getAge()< 1 || user.getAge()> 150) {
return ResponseResult.fail("invalid age");
}
// ...
return ResponseEntity.ok("success");
}
}針對這個普遍的問題，Java開者在Java API規(guī)范 (JSR303) 定義了Bean校驗的標準validation-api，但沒有提供實現(xiàn)。
hibernate validation是對這個規(guī)范的實現(xiàn)，并增加了校驗注解如@Email、@Length等。
Spring Validation是對hibernate validation的二次封裝，用于支持spring mvc參數(shù)自動校驗。
接下來，我們以springboot項目為例，介紹Spring Validation的使用。
實現(xiàn)案例
本例子采用 spring validation 對參數(shù)綁定進行校驗，主要給你提供參數(shù)校驗的思路。針對接口統(tǒng)一的錯誤信息（比如綁定參數(shù)檢查的錯誤）封裝請看?SpringBoot接口如何統(tǒng)一異常處理
POM
添加pom依賴:
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-validation --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency>
請求參數(shù)封裝
單一職責(zé)，所以將查詢用戶的參數(shù)封裝到UserParam中， 而不是User（數(shù)據(jù)庫實體）本身。
對每個參數(shù)字段添加validation注解約束和message。
/**
* user.
*
* @author pdai
*/
@Data
@Builder
@ApiModel(value = "User", subTypes = {AddressParam.class})
public class UserParam implements Serializable {
private static final long serialVersionUID = 1L;
@NotEmpty(message = "could not be empty")
private String userId;
@NotEmpty(message = "could not be empty")
@Email(message = "invalid email")
private String email;
@NotEmpty(message = "could not be empty")
@Pattern(regexp = "^(\\d{6})(\\d{4})(\\d{2})(\\d{2})(\\d{3})([0-9]|X)$", message = "invalid ID")
private String cardNo;
@NotEmpty(message = "could not be empty")
@Length(min = 1, max = 10, message = "nick name should be 1-10")
private String nickName;
@NotEmpty(message = "could not be empty")
@Range(min = 0, max = 1, message = "sex should be 0-1")
private int sex;
@Max(value = 100, message = "Please input valid age")
private int age;
@Valid
private AddressParam address;
}Controller中獲取參數(shù)綁定結(jié)果
使用@Valid或者@Validate注解，參數(shù)校驗的值放在BindingResult中
/**
* @author pdai
*/
@Slf4j
@Api(value = "User Interfaces", tags = "User Interfaces")
@RestController
@RequestMapping("/user")
public class UserController {
/**
* http://localhost:8080/user/add .
*
* @param userParam user param
* @return user
*/
@ApiOperation("Add User")
@ApiImplicitParam(name = "userParam", type = "body", dataTypeClass = UserParam.class, required = true)
@PostMapping("add")
public ResponseEntity<String> add(@Valid @RequestBody UserParam userParam, BindingResult bindingResult){
if (bindingResult.hasErrors()) {
List<ObjectError> errors = bindingResult.getAllErrors();
errors.forEach(p -> {
FieldError fieldError = (FieldError) p;
log.error("Invalid Parameter : object - {},field - {},errorMessage - {}", fieldError.getObjectName(), fieldError.getField(), fieldError.getDefaultMessage());
});
return ResponseEntity.badRequest().body("invalid parameter");
}
return ResponseEntity.ok("success");
}
}校驗結(jié)果
POST訪問添加User的請求
后臺輸出參數(shù)綁定錯誤信息：（包含哪個對象，哪個字段，什么樣的錯誤描述）
2021-09-16 10:37:05.173 ERROR 21216 --- [nio-8080-exec-8] t.p.s.v.controller.UserController : Invalid Parameter : object - userParam,field - nickName,errorMessage - could not be empty
2021-09-16 10:37:05.176 ERROR 21216 --- [nio-8080-exec-8] t.p.s.v.controller.UserController : Invalid Parameter : object - userParam,field - email,errorMessage - could not be empty
2021-09-16 10:37:05.176 ERROR 21216 --- [nio-8080-exec-8] t.p.s.v.controller.UserController : Invalid Parameter : object - userParam,field - cardNo,errorMessage - could not be empty
（本例只是springboot-validation的簡單用例，針對接口統(tǒng)一的錯誤信息封裝請看?SpringBoot接口如何統(tǒng)一異常處理
進一步理解
我們再通過一些問題來幫助你更深入理解validation校驗。@pdai
Validation分組校驗？
上面的例子中，其實存在一個問題，UserParam既可以作為addUser的參數(shù)（id為空），又可以作為updateUser的參數(shù)（id不能為空），這時候怎么辦呢？分組校驗登場。
@Data
@Builder
@ApiModel(value = "User", subTypes = {AddressParam.class})
public class UserParam implements Serializable {
private static final long serialVersionUID = 1L;
@NotEmpty(message = "could not be empty") // 這里定為空，對于addUser時是不合適的
private String userId;
}這時候可以使用Validation分組
- 先定義分組（無需實現(xiàn)接口）
public interface AddValidationGroup {
}
public interface EditValidationGroup {
}- 在UserParam的userId字段添加分組
@Data
@Builder
@ApiModel(value = "User", subTypes = {AddressParam.class})
public class UserParam implements Serializable {
private static final long serialVersionUID = 1L;
@NotEmpty(message = "{user.msg.userId.notEmpty}", groups = {EditValidationGroup.class}) // 這里
private String userId;
}- controller中的接口使用校驗時使用分組
PS: 需要使用@Validated注解
@Slf4j
@Api(value = "User Interfaces", tags = "User Interfaces")
@RestController
@RequestMapping("/user")
public class UserController {
/**
* http://localhost:8080/user/add .
*
* @param userParam user param
* @return user
*/
@ApiOperation("Add User")
@ApiImplicitParam(name = "userParam", type = "body", dataTypeClass = UserParam.class, required = true)
@PostMapping("add")
public ResponseEntity<UserParam> add(@Validated(AddValidationGroup.class){
return ResponseEntity.ok(userParam);
}
/**
* http://localhost:8080/user/add .
*
* @param userParam user param
* @return user
*/
@ApiOperation("Edit User")
@ApiImplicitParam(name = "userParam", type = "body", dataTypeClass = UserParam.class, required = true)
@PostMapping("edit")
public ResponseEntity<UserParam> edit(@Validated(EditValidationGroup.class){
return ResponseEntity.ok(userParam);
}
}- 測試
@Validate和@Valid什么區(qū)別？
細心的你會發(fā)現(xiàn)，上個例子中用的是@Validate, 而不是@Valid，那它們之間的區(qū)別是什么呢？
在檢驗Controller的入?yún)⑹欠穹弦?guī)范時，使用@Validated或者@Valid在基本驗證功能上沒有太多區(qū)別。但是在分組、注解地方、嵌套驗證等功能上兩個有所不同：
- 分組
@Validated：提供了一個分組功能，可以在入?yún)Ⅱ炞C時，根據(jù)不同的分組采用不同的驗證機制，這個網(wǎng)上也有資料，不詳述。@Valid：作為標準JSR-303規(guī)范，還沒有吸收分組的功能。
- 注解地方
@Validated：可以用在類型、方法和方法參數(shù)上。但是不能用在成員屬性（字段）上
@Valid：可以用在方法、構(gòu)造函數(shù)、方法參數(shù)和成員屬性（字段）上
- 嵌套類型
比如本文例子中的address是user的一個嵌套屬性, 只能用@Valid
@Data
@Builder
@ApiModel(value = "User", subTypes = {AddressParam.class})
public class UserParam implements Serializable {
private static final long serialVersionUID = 1L;
@Valid // 這里只能用@Valid
private AddressParam address;
}有哪些常用的校驗？
從以下三類理解。
- JSR303/JSR-349: JSR303是一項標準,只提供規(guī)范不提供實現(xiàn)，規(guī)定一些校驗規(guī)范即校驗注解，如@Null，@NotNull，@Pattern，位于javax.validation.constraints包下。JSR-349是其的升級版本，添加了一些新特性。
@AssertFalse 被注釋的元素只能為false
@AssertTrue 被注釋的元素只能為true
@DecimalMax 被注釋的元素必須小于或等于{value}
@DecimalMin 被注釋的元素必須大于或等于{value}
@Digits 被注釋的元素數(shù)字的值超出了允許范圍(只允許在{integer}位整數(shù)和{fraction}位小數(shù)范圍內(nèi))
@Email 被注釋的元素不是一個合法的電子郵件地址
@Future 被注釋的元素需要是一個將來的時間
@FutureOrPresent 被注釋的元素需要是一個將來或現(xiàn)在的時間
@Max 被注釋的元素最大不能超過{value}
@Min 被注釋的元素最小不能小于{value}
@Negative 被注釋的元素必須是負數(shù)
@NegativeOrZero 被注釋的元素必須是負數(shù)或零
@NotBlank 被注釋的元素不能為空
@NotEmpty 被注釋的元素不能為空
@NotNull 被注釋的元素不能為null
@Null 被注釋的元素必須為null
@Past 被注釋的元素需要是一個過去的時間
@PastOrPresent 被注釋的元素需要是一個過去或現(xiàn)在的時間
@Pattern 被注釋的元素需要匹配正則表達式"{regexp}"
@Positive 被注釋的元素必須是正數(shù)
@PositiveOrZero 被注釋的元素必須是正數(shù)或零
@Size 被注釋的元素個數(shù)必須在{min}和{max}之間- hibernate validation：hibernate validation是對這個規(guī)范的實現(xiàn)，并增加了一些其他校驗注解，如@Email，@Length，@Range等等
@CreditCardNumber 被注釋的元素不合法的信用卡號碼
@Currency 被注釋的元素不合法的貨幣 (必須是{value}其中之一)
@EAN 被注釋的元素不合法的{type}條形碼
@Email 被注釋的元素不是一個合法的電子郵件地址 (已過期)
@Length 被注釋的元素長度需要在{min}和{max}之間
@CodePointLength 被注釋的元素長度需要在{min}和{max}之間
@LuhnCheck 被注釋的元素${validatedValue}的校驗碼不合法, Luhn模10校驗和不匹配
@Mod10Check 被注釋的元素${validatedValue}的校驗碼不合法, 模10校驗和不匹配
@Mod11Check 被注釋的元素${validatedValue}的校驗碼不合法, 模11校驗和不匹配
@ModCheck 被注釋的元素${validatedValue}的校驗碼不合法, ${modType}校驗和不匹配 (已過期)
@NotBlank 被注釋的元素不能為空 (已過期)
@NotEmpty 被注釋的元素不能為空 (已過期)
@ParametersScriptAssert 被注釋的元素執(zhí)行腳本表達式"{script}"沒有返回期望結(jié)果
@Range 被注釋的元素需要在{min}和{max}之間
@SafeHtml 被注釋的元素可能有不安全的HTML內(nèi)容
@ScriptAssert 被注釋的元素執(zhí)行腳本表達式"{script}"沒有返回期望結(jié)果
@URL 被注釋的元素需要是一個合法的URL
@DurationMax 被注釋的元素必須小于${inclusive == true ? '或等于' : ''}${days == 0 ? '' : days += '天'}${hours == 0 ? '' : hours += '小時'}${minutes == 0 ? '' : minutes += '分鐘'}${seconds == 0 ? '' : seconds += '秒'}${millis == 0 ? '' : millis += '毫秒'}${nanos == 0 ? '' : nanos += '納秒'}
@DurationMin 被注釋的元素必須大于${inclusive == true ? '或等于' : ''}${days == 0 ? '' : days += '天'}${hours == 0 ? '' : hours += '小時'}${minutes == 0 ? '' : minutes += '分鐘'}${seconds == 0 ? '' : seconds += '秒'}${millis == 0 ? '' : millis += '毫秒'}${nanos == 0 ? '' : nanos += '納秒'}- spring validation：spring validation對hibernate validation進行了二次封裝，在springmvc模塊中添加了自動校驗，并將校驗信息封裝進了特定的類中
自定義validation？
如果上面的注解不能滿足我們檢驗參數(shù)的要求，我們能不能自定義校驗規(guī)則呢？ 可以。
- 定義注解
package tech.pdai.springboot.validation.group.validation.custom;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {TelephoneNumberValidator.class}) // 指定校驗器
public @interface TelephoneNumber {
String message() default "Invalid telephone number";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
}- 定義校驗器
public class TelephoneNumberValidator implements ConstraintValidator<TelephoneNumber, String> {
private static final String REGEX_TEL = "0\\d{2,3}[-]?\\d{7,8}|0\\d{2,3}\\s?\\d{7,8}|13[0-9]\\d{8}|15[1089]\\d{8}";
@Override
public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext){
try {
return Pattern.matches(REGEX_TEL, s);
} catch (Exception e) {
return false;
}
}
}使用
@Data
@Builder
@ApiModel(value = "User", subTypes = {AddressParam.class})
public class UserParam implements Serializable {
private static final long serialVersionUID = 1L;
@NotEmpty(message = "{user.msg.userId.notEmpty}", groups = {EditValidationGroup.class})
private String userId;
@TelephoneNumber(message = "invalid telephone number") // 這里
private String telephone;
}到此這篇關(guān)于SpringBoot接口如何對參數(shù)進行校驗的文章就介紹到這了,更多相關(guān)SpringBoot接口校驗內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
java中hasNextInt判斷后無限循環(huán)輸出else項的解決方法
這篇文章主要介紹了java中hasNextInt判斷后無限循環(huán)輸出else項的解決方法的相關(guān)資料,需要的朋友可以參考下2016-10-10
在 Java 8 中,函數(shù)式接口是一個關(guān)鍵的特性,它們允許將方法作為參數(shù)傳遞或返回類型,本文為大家整理了一些常見的函數(shù)式接口的使用,希望對大家有所幫助2023-12-12
這篇文章主要介紹了Java調(diào)用Oracle存儲過程詳解的相關(guān)資料,需要的朋友可以參考下2017-02-02
springcloud Zuul動態(tài)路由的實現(xiàn)
這篇文章主要介紹了springcloud Zuul動態(tài)路由的實現(xiàn)，詳細的介紹了什么是Zuu及其動態(tài)路由的實現(xiàn)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-11-11
SpringBoot?+?layui?框架實現(xiàn)一周免登陸功能示例詳解
這篇文章主要介紹了SpringBoot+layui框架實現(xiàn)一周免登陸功能,本文通過示例代碼給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-08-08
這篇文章主要為大家詳細介紹了java實現(xiàn)酒店管理系統(tǒng)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-02-02
這篇文章主要給大家介紹了關(guān)于JAVA為什么要使用封裝及如何封裝的相關(guān)資料,封裝就是將屬性私有化,提供公有的方法訪問私有屬性,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2023-10-10
詳解springMVC之與json數(shù)據(jù)交互方法
本篇文章主要介紹了詳解springMVC之與json數(shù)據(jù)交互方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-05-05
kafka topic 權(quán)限控制(設(shè)置刪除權(quán)限)
大家都知道Kafka是一個消息隊列，把消息放到隊列里邊的叫生產(chǎn)者，從隊列里邊消費的叫消費者。今天通過本文給大家介紹kafka topic 權(quán)限控制的相關(guān)知識，感興趣的朋友一起看看吧2021-11-11
這篇文章主要介紹了java擴展Hibernate注解支持java8新時間類型,需要的朋友可以參考下2014-04-04