SpringBoot接口怎么對參數進行校驗

今天小編給大家分享一下SpringBoot接口怎么對參數進行校驗的相關知識點，內容詳細，邏輯清晰，相信大部分人都還太了解這方面的知識，所以分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后有所收獲，下面我們一起來了解一下吧。

什么是不優雅的參數校驗

后端對前端傳過來的參數也是需要進行校驗的，如果在controller中直接校驗需要用大量的if else做判斷

以添加用戶的接口為例，需要對前端傳過來的參數進行校驗， 如下的校驗就是不優雅的：

@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規范 (JSR303) 定義了Bean校驗的標準validation-api，但沒有提供實現。

hibernate validation是對這個規范的實現，并增加了校驗注解如@Email、@Length等。

Spring Validation是對hibernate validation的二次封裝，用于支持spring mvc參數自動校驗。

接下來，我們以springboot項目為例，介紹Spring Validation的使用。

實現案例

本例子采用 spring validation 對參數綁定進行校驗，主要給你提供參數校驗的思路。針對接口統一的錯誤信息（比如綁定參數檢查的錯誤）封裝請看SpringBoot接口如何統一異常處理

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>

請求參數封裝

單一職責，所以將查詢用戶的參數封裝到UserParam中， 而不是User（數據庫實體）本身。

對每個參數字段添加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中獲取參數綁定結果

使用@Valid或者@Validate注解，參數校驗的值放在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");
}
}

校驗結果

POST訪問添加User的請求

后臺輸出參數綁定錯誤信息：（包含哪個對象，哪個字段，什么樣的錯誤描述）

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的簡單用例，針對接口統一的錯誤信息封裝請看SpringBoot接口如何統一異常處理

進一步理解

我們再通過一些問題來幫助你更深入理解validation校驗。@pdai

Validation分組校驗？

上面的例子中，其實存在一個問題，UserParam既可以作為addUser的參數（id為空），又可以作為updateUser的參數（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分組

• 先定義分組（無需實現接口）

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什么區別？

細心的你會發現，上個例子中用的是@Validate, 而不是@Valid，那它們之間的區別是什么呢？

在檢驗Controller的入參是否符合規范時，使用@Validated或者@Valid在基本驗證功能上沒有太多區別。但是在分組、注解地方、嵌套驗證等功能上兩個有所不同：

• 分組

@Validated：提供了一個分組功能，可以在入參驗證時，根據不同的分組采用不同的驗證機制，這個網上也有資料，不詳述。@Valid：作為標準JSR-303規范，還沒有吸收分組的功能。

• 注解地方

@Validated：可以用在類型、方法和方法參數上。但是不能用在成員屬性（字段）上

@Valid：可以用在方法、構造函數、方法參數和成員屬性（字段）上

• 嵌套類型

比如本文例子中的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是一項標準,只提供規范不提供實現，規定一些校驗規范即校驗注解，如@Null，@NotNull，@Pattern，位于javax.validation.constraints包下。JSR-349是其的升級版本，添加了一些新特性。

@AssertFalse 被注釋的元素只能為false
@AssertTrue 被注釋的元素只能為true
@DecimalMax 被注釋的元素必須小于或等于{value}
@DecimalMin 被注釋的元素必須大于或等于{value}
@Digits 被注釋的元素數字的值超出了允許范圍(只允許在{integer}位整數和{fraction}位小數范圍內)
@Email 被注釋的元素不是一個合法的電子郵件地址
@Future 被注釋的元素需要是一個將來的時間
@FutureOrPresent 被注釋的元素需要是一個將來或現在的時間
@Max 被注釋的元素最大不能超過{value}
@Min 被注釋的元素最小不能小于{value}
@Negative 被注釋的元素必須是負數
@NegativeOrZero 被注釋的元素必須是負數或零
@NotBlank 被注釋的元素不能為空
@NotEmpty 被注釋的元素不能為空
@NotNull 被注釋的元素不能為null
@Null 被注釋的元素必須為null
@Past 被注釋的元素需要是一個過去的時間
@PastOrPresent 被注釋的元素需要是一個過去或現在的時間
@Pattern 被注釋的元素需要匹配正則表達式"{regexp}"
@Positive 被注釋的元素必須是正數
@PositiveOrZero 被注釋的元素必須是正數或零
@Size 被注釋的元素個數必須在{min}和{max}之間

• hibernate validation：hibernate validation是對這個規范的實現，并增加了一些其他校驗注解，如@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 被注釋的元素執行腳本表達式"{script}"沒有返回期望結果
@Range 被注釋的元素需要在{min}和{max}之間
@SafeHtml 被注釋的元素可能有不安全的HTML內容
@ScriptAssert 被注釋的元素執行腳本表達式"{script}"沒有返回期望結果
@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？

如果上面的注解不能滿足我們檢驗參數的要求，我們能不能自定義校驗規則呢？ 可以。

• 定義注解

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;
}

以上就是“SpringBoot接口怎么對參數進行校驗”這篇文章的所有內容，感謝各位的閱讀！相信大家閱讀完這篇文章都有很大的收獲，小編每天都會為大家更新不同的知識，如果還想學習更多的知識，請關注億速云行業資訊頻道。