SpringBoot參數(shù)校驗Validator框架詳解
SpringBoot 如何進(jìn)行參數(shù)校驗
在日常的接口開發(fā)中,為了防止非法參數(shù)對業(yè)務(wù)造成影響,經(jīng)常需要對接口的參數(shù)做校驗,例如登錄的時候需要校驗用戶名密碼是否為空,創(chuàng)建用戶的時候需要校驗郵件、手機(jī)號碼格式是否準(zhǔn)確??看a對接口參數(shù)一個個校驗的話就太繁瑣了,代碼可讀性極差。
Validator框架就是為了解決開發(fā)人員在開發(fā)的時候少寫代碼,提升開發(fā)效率;Validator專門用來進(jìn)行接口參數(shù)校驗,例如常見的必填校驗,email格式校驗,用戶名必須位于6到12之間 等等…
Validator校驗框架遵循了JSR-303驗證規(guī)范(參數(shù)校驗規(guī)范), JSR是
Java Specification Requests的縮寫。
1.集成Validator校驗框架
1.1. 引入依賴包
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency>
注:從
springboot-2.3開始,校驗包被獨(dú)立成了一個starter組件,所以需要引入validation和web,而springboot-2.3之前的版本只需要引入 web 依賴就可以了。
| 注解 | 功能 |
|---|---|
| @AssertFalse | 可以為null,如果不為null的話必須為false |
| @AssertTrue | 可以為null,如果不為null的話必須為true |
| @DecimalMax | 設(shè)置不能超過最大值 |
| @DecimalMin | 設(shè)置不能超過最小值 |
| @Digits | 設(shè)置必須是數(shù)字且數(shù)字整數(shù)的位數(shù)和小數(shù)的位數(shù)必須在指定范圍內(nèi) |
| @Future | 日期必須在當(dāng)前日期的未來 |
| @Past | 日期必須在當(dāng)前日期的過去 |
| @Max | 最大不得超過此最大值 |
| @Min | 最大不得小于此最小值 |
| @NotNull | 不能為null,可以是空 |
| @Null | 必須為null |
| @Pattern | 必須滿足指定的正則表達(dá)式 |
| @Size | 集合、數(shù)組、map等的size()值必須在指定范圍內(nèi) |
| 必須是email格式 | |
| @Length | 長度必須在指定范圍內(nèi) |
| @NotBlank | 字符串不能為null,字符串trim()后也不能等于“” |
| @NotEmpty | 不能為null,集合、數(shù)組、map等size()不能為0;字符串trim()后可以等于“” |
| @Range | 值必須在指定范圍內(nèi) |
| @URL | 必須是一個URL |
注:此表格只是簡單的對注解功能的說明,并沒有對每一個注解的屬性進(jìn)行說明;可詳見源碼。
1.2. 定義要參數(shù)校驗的實體類
@Data
public class ValidVO {
private String id;
@Length(min = 6,max = 12,message = "appId長度必須位于6到12之間")
private String appId;
@NotBlank(message = "名字為必填項")
private String name;
@Email(message = "請?zhí)顚懻_的郵箱地址")
private String email;
private String sex;
@NotEmpty(message = "級別不能為空")
private String level;
}在實際開發(fā)中對于需要校驗的字段都需要設(shè)置對應(yīng)的業(yè)務(wù)提示,即message屬性。
1.3. 定義校驗類進(jìn)行測試
@RestController
@Slf4j
@Validated
public class ValidController {
@ApiOperation("RequestBody校驗")
@PostMapping("/valid/test1")
public String test1(@Validated @RequestBody ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test1 valid success";
}
@ApiOperation("Form校驗")
@PostMapping(value = "/valid/test2")
public String test2(@Validated ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test2 valid success";
}
@ApiOperation("單參數(shù)校驗")
@PostMapping(value = "/valid/test3")
public String test3(@Email String email){
log.info("email is {}", email);
return "email valid success";
}
}這里我們先定義三個方法test1,test2,test3,
test1使用了
@RequestBody注解,用于接受前端發(fā)送的json數(shù)據(jù),test2模擬表單提交,
test3模擬單參數(shù)提交。
注意,當(dāng)使用單參數(shù)校驗時需要在Controller上加上@Validated注解,否則不生效。
1.4. 測試結(jié)果1
test1的測試結(jié)果
發(fā)送值
POST http://localhost:8080/valid/test1
Content-Type: application/json
{
"id": 1,
"level": "12",
"email": "47693899",
"appId": "ab1c"
}返回值
提示的是
org.springframework.web.bind.MethodArgumentNotValidException異常
{
"status": 500,
"message": "Validation failed for argument [0] in public java.lang.String com.jianzh5.blog.valid.ValidController.test1(com.jianzh5.blog.valid.ValidVO) with 3 errors: [Field error in object 'validVO' on field 'email': rejected value [47693899]; codes [Email.validVO.email,Email.email,Email.java.lang.String,Email]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.email,email]; arguments []; default message [email],[Ljavax.validation.constraints.Pattern$Flag;@26139123,.*]; default message [不是一個合法的電子郵件地址]]...",
"data": null,
"timestamp": 1628239624332
}test2的測試結(jié)果
發(fā)送值
POST http://localhost:8080/valid/test2 Content-Type: application/x-www-form-urlencoded id=1&level=12&email=476938977&appId=ab1c
返回值
提示的是
org.springframework.validation.BindException異常
{
"status": 500,
"message": "org.springframework.validation.BeanPropertyBindingResult: 3 errors\nField error in object 'validVO' on field 'name': rejected value [null]; codes [NotBlank.validVO.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.name,name]; arguments []; default message [name]]; default message [名字為必填項]...",
"data": null,
"timestamp": 1628239301951
}test3的測試結(jié)果
發(fā)送值
POST http://localhost:8080/valid/test3 Content-Type: application/x-www-form-urlencoded email=476938977
返回值
提示的是
javax.validation.ConstraintViolationException異常
{
"status": 500,
"message": "test3.email: 不是一個合法的電子郵件地址",
"data": null,
"timestamp": 1628239281022
}1.5. 問題
雖然我們之前定義了全局異常攔截器,也看到了攔截器確實生效了,但是Validator校驗框架返回的錯誤提示太臃腫了,不便于閱讀,為了方便前端提示,我們需要將其簡化一下。
通過將參數(shù)異常加入全局異常來解決
1.6. 將參數(shù)異常加入全局異常
直接修改之前定義的RestExceptionHandler,單獨(dú)攔截參數(shù)校驗的三個異常:
javax.validation.ConstraintViolationException,
org.springframework.validation.BindException,
org.springframework.web.bind.MethodArgumentNotValidException,
@Slf4j
@RestControllerAdvice
public class RestExceptionHandler {
/**
* 默認(rèn)全局異常處理。
* @param e the e
* @return ResultData
*/
@ExceptionHandler(Exception.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public ResultData<String> exception(Exception e) {
log.error("全局異常信息 ex={}", e.getMessage(), e);
return ResultData.fail(ReturnCode.RC500.getCode(),e.getMessage());
}
@ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
public ResponseEntity<ResultData<String>> handleValidatedException(Exception e) {
ResultData<String> resp = null;
if (e instanceof MethodArgumentNotValidException) {
// BeanValidation exception
MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e;
resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
ex.getBindingResult().getAllErrors().stream()
.map(ObjectError::getDefaultMessage)
.collect(Collectors.joining("; "))
);
} else if (e instanceof ConstraintViolationException) {
// BeanValidation GET simple param
ConstraintViolationException ex = (ConstraintViolationException) e;
resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
ex.getConstraintViolations().stream()
.map(ConstraintViolation::getMessage)
.collect(Collectors.joining("; "))
);
} else if (e instanceof BindException) {
// BeanValidation GET object param
BindException ex = (BindException) e;
resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
ex.getAllErrors().stream()
.map(ObjectError::getDefaultMessage)
.collect(Collectors.joining("; "))
);
}
return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST);
}
}1.7. 測試結(jié)果2
test1測試結(jié)果
發(fā)送值
POST http://localhost:8080/valid/test1
Content-Type: application/json
{
"id": 1,
"level": "12",
"email": "47693899",
"appId": "ab1c"
}接收值
{
"status": 400,
"message": "名字為必填項; 不是一個合法的電子郵件地址; appId長度必須位于6到12之間",
"data": null,
"timestamp": 1628435116680
}2. 自定義注解
雖然Spring Validation 提供的注解基本上夠用,但是面對復(fù)雜的定義,我們還是需要自己定義相關(guān)注解來實現(xiàn)自動校驗。
比如上面實體類中的sex性別屬性,只允許前端傳遞傳 M,F(xiàn) 這2個枚舉值,如何實現(xiàn)呢?
2.1. 第一步,創(chuàng)建自定義注解
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(EnumString.List.class)
@Documented
@Constraint(validatedBy = EnumStringValidator.class)//標(biāo)明由哪個類執(zhí)行校驗邏輯
public @interface EnumString {
String message() default "value not in enum values.";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
/**
* @return date must in this value array
*/
String[] value();
/**
* Defines several {@link EnumString} annotations on the same element.
*
* @see EnumString
*/
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Documented
@interface List {
EnumString[] value();
}
}可以根據(jù)Validator框架定義好的注解來仿寫,基本上一致
2.2. 第二步,自定義校驗邏輯
public class EnumStringValidator implements ConstraintValidator<EnumString, String> {
private List<String> enumStringList;
@Override
public void initialize(EnumString constraintAnnotation) {
enumStringList = Arrays.asList(constraintAnnotation.value());
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if(value == null){
return true;
}
return enumStringList.contains(value);
}
}2.3. 第三步,在字段上增加注解
@ApiModelProperty(value = "性別")
@EnumString(value = {"F","M"}, message="性別只允許為F或M")
private String sex;2.4. 第四步,體驗效果
POST http://localhost:8080/valid/test2 Content-Type: application/x-www-form-urlencoded id=1&name=javadaily&level=12&email=476938977@qq.com&appId=ab1cdddd&sex=N
{
"status": 400,
"message": "性別只允許為F或M",
"data": null,
"timestamp": 1628435243723
}3. 分組校驗
一個VO對象在新增的時候某些字段為必填,在更新的時候又非必填。如上面的ValidVO中 id 和 appId 屬性在新增操作時都是非必填,而在編輯操作時都為必填,name在新增操作時為必填,面對這種場景你會怎么處理呢?
在實際開發(fā)中我見到很多同學(xué)都是建立兩個VO對象,ValidCreateVO,ValidEditVO來處理這種場景,這樣確實也能實現(xiàn)效果,但是會造成類膨脹。
其實
Validator校驗框架已經(jīng)考慮到了這種場景并且提供了解決方案,就是分組校驗,只不過很多同學(xué)不知道而已。
要使用分組校驗,只需要三個步驟
3.1. 第一步,定義分組接口
public interface ValidGroup extends Default {
interface Crud extends ValidGroup{
interface Create extends Crud{
}
interface Update extends Crud{
}
interface Query extends Crud{
}
interface Delete extends Crud{
}
}
}這里我們定義一個分組接口ValidGroup讓其繼承
javax.validation.groups.Default,再在分組接口中定義出多個不同的操作類型,Create,Update,Query,Delete。
3.2. 第二步,在模型中給參數(shù)分配分組
@Data
public class ValidVO {
@Null(groups = ValidGroup.Crud.Create.class)
@NotNull(groups = ValidGroup.Crud.Update.class, message = "應(yīng)用ID不能為空")
private String id;
@Length(min = 6,max = 12,message = "appId長度必須位于6到12之間")
@Null(groups = ValidGroup.Crud.Create.class)
@NotNull(groups = ValidGroup.Crud.Update.class, message = "應(yīng)用ID不能為空")
private String appId;
@NotBlank(message = "名字為必填項")
@NotBlank(groups = ValidGroup.Crud.Create.class,message = "名字為必填項")
private String name;
@Email(message = "請?zhí)顚懻_的郵箱地址")
private String email;
@EnumString(value = {"F","M"}, message="性別只允許為F或M")
private String sex;
@NotEmpty(message = "級別不能為空")
private String level;
}給參數(shù)指定分組,對于未指定分組的則使用的是默認(rèn)分組。
3.3. 第三步,給需要參數(shù)校驗的方法指定分組
@PostMapping(value = "/valid/add")
public String add(@Validated(value = ValidGroup.Crud.Create.class) ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test3 valid success";
}
@PostMapping(value = "/valid/update")
public String update(@Validated(value = ValidGroup.Crud.Update.class) ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test4 valid success";
}這里我們通過
value屬性給add()和update()方法分別指定Create和Update分組
3.4. 測試
POST http://localhost:8080/valid/add Content-Type: application/x-www-form-urlencoded name=javadaily&level=12&email=476938977@qq.com&sex=F
Create操作
在Create時我們沒有傳遞id和appId參數(shù),校驗通過。
{
"status": 100,
"message": "操作成功",
"data": "test3 valid success",
"timestamp": 1652186105359
}update操作
使用同樣的參數(shù)調(diào)用update方法時則提示參數(shù)校驗錯誤
{
"status": 400,
"message": "ID不能為空; 應(yīng)用ID不能為空",
"data": null,
"timestamp": 1652186962377
}默認(rèn)校驗生效操作
由于email屬于默認(rèn)分組,而我們的分組接口
ValidGroup已經(jīng)繼承了Default分組,所以也是可以對email字段作參數(shù)校驗的。
故意寫錯email格式
POST http://localhost:8080/valid/add Content-Type: application/x-www-form-urlencoded /valid/update?name=javadaily&level=12&email=476938977&sex=F
{
"status": 400,
"message": "請?zhí)顚懻_的郵箱地址; ID不能為空; 應(yīng)用ID不能為空",
"data": null,
"timestamp": 1652187273865
}4. 業(yè)務(wù)規(guī)則校驗
http://www.dbjr.com.cn/article/235644.htm
業(yè)務(wù)規(guī)則校驗指接口需要滿足某些特定的業(yè)務(wù)規(guī)則,舉個例子:業(yè)務(wù)系統(tǒng)的用戶需要保證其唯一性,用戶屬性不能與其他用戶產(chǎn)生沖突,不允許與數(shù)據(jù)庫中任何已有用戶的用戶名稱、手機(jī)號碼、郵箱產(chǎn)生重復(fù)。
這就要求在創(chuàng)建用戶時需要校驗用戶名稱、手機(jī)號碼、郵箱是否被注冊;編輯用戶時不能將信息修改成已有用戶的屬性。
最優(yōu)雅的實現(xiàn)方法應(yīng)該是參考 Bean Validation 的標(biāo)準(zhǔn)方式,借助自定義校驗注解完成業(yè)務(wù)規(guī)則校驗。
4.1. 自定義注解
首先我們需要創(chuàng)建兩個自定義注解,用于業(yè)務(wù)規(guī)則校驗:
UniqueUser:表示一個用戶是唯一的,唯一性包含:用戶名,手機(jī)號碼、郵箱@Documented @Retention(RUNTIME) @Target({FIELD, METHOD, PARAMETER, TYPE}) @Constraint(validatedBy = UserValidation.UniqueUserValidator.class) public @interface UniqueUser { String message() default "用戶名、手機(jī)號碼、郵箱不允許與現(xiàn)存用戶重復(fù)"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }NotConflictUser:表示一個用戶的信息是無沖突的,無沖突是指該用戶的敏感信息與其他用戶不重合@Documented @Retention(RUNTIME) @Target({FIELD, METHOD, PARAMETER, TYPE}) @Constraint(validatedBy = UserValidation.NotConflictUserValidator.class) public @interface NotConflictUser { String message() default "用戶名稱、郵箱、手機(jī)號碼與現(xiàn)存用戶產(chǎn)生重復(fù)"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
4.2. 實現(xiàn)業(yè)務(wù)校驗規(guī)則
想讓自定義驗證注解生效,需要實現(xiàn)
ConstraintValidator接口。
接口的第一個參數(shù)是 自定義注解類型,第二個參數(shù)是 被注解字段的類,因為需要校驗多個參數(shù),我們直接傳入用戶對象。需要提到的一點是 ConstraintValidator 接口的實現(xiàn)類無需添加 @Component 它在啟動的時候就已經(jīng)被加載到容器中了。
@Slf4j
public class UserValidation<T extends Annotation> implements ConstraintValidator<T, User> {
protected Predicate<User> predicate = c -> true;
@Resource
protected UserRepository userRepository;
@Override
public boolean isValid(User user, ConstraintValidatorContext constraintValidatorContext) {
return userRepository == null || predicate.test(user);
}
/**
* 校驗用戶是否唯一
* 即判斷數(shù)據(jù)庫是否存在當(dāng)前新用戶的信息,如用戶名,手機(jī),郵箱
*/
public static class UniqueUserValidator extends UserValidation<UniqueUser>{
@Override
public void initialize(UniqueUser uniqueUser) {
predicate = c -> !userRepository.existsByUserNameOrEmailOrTelphone(c.getUserName(),c.getEmail(),c.getTelphone());
}
}
/**
* 校驗是否與其他用戶沖突
* 將用戶名、郵件、電話改成與現(xiàn)有完全不重復(fù)的,或者只與自己重復(fù)的,就不算沖突
*/
public static class NotConflictUserValidator extends UserValidation<NotConflictUser>{
@Override
public void initialize(NotConflictUser notConflictUser) {
predicate = c -> {
log.info("user detail is {}",c);
Collection<User> collection = userRepository.findByUserNameOrEmailOrTelphone(c.getUserName(), c.getEmail(), c.getTelphone());
// 將用戶名、郵件、電話改成與現(xiàn)有完全不重復(fù)的,或者只與自己重復(fù)的,就不算沖突
return collection.isEmpty() || (collection.size() == 1 && collection.iterator().next().getId().equals(c.getId()));
};
}
}
}這里使用Predicate函數(shù)式接口對業(yè)務(wù)規(guī)則進(jìn)行判斷。
4.3. 測試代碼
@RestController
@RequestMapping("/senior/user")
@Slf4j
@Validated
public class UserController {
@Autowired
private UserRepository userRepository;
@PostMapping
public User createUser(@UniqueUser @Valid User user){
User savedUser = userRepository.save(user);
log.info("save user id is {}",savedUser.getId());
return savedUser;
}
@SneakyThrows
@PutMapping
public User updateUser(@NotConflictUser @Valid @RequestBody User user){
User editUser = userRepository.save(user);
log.info("update user is {}",editUser);
return editUser;
}
}使用很簡單,只需要在方法上加入自定義注解即可,業(yè)務(wù)邏輯中不需要添加任何業(yè)務(wù)規(guī)則的代碼。
POST http://localhost:8080/valid/add
Content-Type: application/json
/senior/user
{
"userName" : "100001"
}{
"status": 400,
"message": "用戶名、手機(jī)號碼、郵箱不允許與現(xiàn)存用戶重復(fù)",
"data": null,
"timestamp": 1652196524725
}總結(jié)
通過上面幾步操作,業(yè)務(wù)校驗便和業(yè)務(wù)邏輯就完全分離開來,在需要校驗時用@Validated注解自動觸發(fā),或者通過代碼手動觸發(fā)執(zhí)行,可根據(jù)你們項目的要求,將這些注解應(yīng)用于控制器、服務(wù)層、持久層等任何層次的代碼之中。
這種方式比任何業(yè)務(wù)規(guī)則校驗的方法都優(yōu)雅,推薦大家在項目中使用。在開發(fā)時可以將不帶業(yè)務(wù)含義的格式校驗注解放到 Bean 的類定義之上,將帶業(yè)務(wù)邏輯的校驗放到 Bean 的類定義的外面。這兩者的區(qū)別是放在類定義中的注解能夠自動運(yùn)行,而放到類外面則需要像前面代碼那樣,明確標(biāo)出注解時才會運(yùn)行。
到此這篇關(guān)于SpringBoot參數(shù)校驗Validator框架的文章就介紹到這了,更多相關(guān)SpringBoot參數(shù)校驗內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring 應(yīng)用上下文獲取 Bean 的常用姿勢實例總結(jié)
這篇文章主要介紹了Spring 應(yīng)用上下文獲取 Bean,結(jié)合實例形式總結(jié)分析了Spring 應(yīng)用上下文獲取 Bean的實現(xiàn)方法與操作注意事項,需要的朋友可以參考下2020-05-05
Spring?Boot整合Log4j2.xml的問題及解決方法
這篇文章主要介紹了Spring?Boot整合Log4j2.xml的問題,本文給大家分享解決方案,需要的朋友可以參考下2023-09-09
關(guān)于Idea使用git時commit特別慢的問題及解決方法
這篇文章主要介紹了關(guān)于Idea使用git時commit特別慢的問題及解決方法,本文通過圖文并茂的形式給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-10-10

