前言
在前后端分離開發(fā)的時(shí)候我們需要用到參數(shù)校驗(yàn),前端需要進(jìn)行參數(shù)校驗(yàn),后端接口同樣的也需要,以防傳入不合法的數(shù)據(jù)。
1、首先還是先導(dǎo)包,導(dǎo)入pom文件。
1
2
3
4
|
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> |
2、解釋一下注解的作用
@Null 限制只能為null
@NotNull 限制必須不為null
@NotEmpty 只作用于字符串類型,字符串不為空,并且長(zhǎng)度不為0
@NotBlank 只作用于字符串類型,字符串不為空,并且trim()后不為空串
@AssertFalse 限制必須為false
@AssertTrue 限制必須為true
@DecimalMax(value) 限制必須為一個(gè)不大于指定值的數(shù)字
@DecimalMin(value) 限制必須為一個(gè)不小于指定值的數(shù)字
@Digits(integer,fraction) 限制必須為一個(gè)小數(shù),且整數(shù)部分的位數(shù)不能超過integer,小數(shù)部分的位
數(shù)不能超過fraction
@Future 限制必須是一個(gè)將來的日期
@Past 驗(yàn)證注解的元素值(日期類型)比當(dāng)前時(shí)間早
@Max(value) 限制必須為一個(gè)不大于指定值的數(shù)字
@Min(value) 限制必須為一個(gè)不小于指定值的數(shù)字
@Pattern(value) 限制必須符合指定的正則表達(dá)式
@Size(max,min) 限制字符長(zhǎng)度必須在min到max之間
@Email 驗(yàn)證注解的元素值是Email,也可以通過正則表達(dá)式和flag指定自定義的email格式
3、在實(shí)體類加上要驗(yàn)證的字段。(我這里隨便寫下)
標(biāo)注的地方就是用來分組校驗(yàn)的,下下面會(huì)解釋。
1
2
3
4
5
6
7
8
9
10
11
12
13
|
@Data public class LoginVo { @ApiModelProperty (value = "用戶名稱" ) @NotEmpty (message = "用戶名不能為空!" ,groups = LoginModel. class ) @NotEmpty (message = "添加時(shí)用戶名不能為空!" ,groups = SaveModel. class ) private String userName; @ApiModelProperty (value = "密碼" ) @Size (min = 2 ,message = "密碼最少為2位" ,groups = LoginModel. class ) @Size (min = 6 ,message = "密碼最少為6位" ,groups = SaveModel. class ) private String password; } |
通過groups的屬性來分組,假設(shè)我在使用登錄分組校驗(yàn)的時(shí)候,設(shè)定用戶名不能為空和密碼最少為2位的驗(yàn)證。而在添加分組設(shè)定添加時(shí)用戶名不能為空和密碼最少為6位的驗(yàn)證。
4、在來解釋下上面標(biāo)注的分組接口。
LoginModel
1
2
3
|
import javax.validation.groups.Default; public interface LoginModel extends Default { } |
必須繼承默認(rèn)的Defaut接口不然后拋出異常。
SaveModel
1
2
3
|
import javax.validation.groups.Default; public interface SaveModel extends Default{ } |
5、在controller的接口上加上@Validated注解,參數(shù)就加上你需要根據(jù)那種規(guī)則來校驗(yàn)。
1
2
3
4
5
6
|
@ApiOperation (value = "登錄以后返回token" ) @PostMapping (value = "/login" ) public Result login( @RequestBody @Validated (LoginModel. class ) LoginVo loginVo) { String token = userService.login(loginVo.getUserName(), loginVo.getPassword()); return Result.success(token); } |
運(yùn)行后只能在控制臺(tái)顯示錯(cuò)誤的結(jié)果,新的問題又來了怎么把錯(cuò)誤的結(jié)果通過自己的result類返回給前端。這就需要對(duì)錯(cuò)誤全局捕捉了。
6、寫一個(gè)對(duì)Response換回結(jié)果的處理。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
@RestControllerAdvice @Slf4j public class ParameterCalibration { @ExceptionHandler ({MethodArgumentNotValidException. class , BindException. class }) @ResponseStatus (HttpStatus.OK) @ResponseBody public Result handleMethodArgumentNotValidException(Exception exception) { StringBuilder errorInfo = new StringBuilder(); BindingResult bindingResult= null ; if (exception instanceof MethodArgumentNotValidException){ bindingResult= ((MethodArgumentNotValidException)exception).getBindingResult(); } if (exception instanceof BindException){ bindingResult= ((BindException)exception).getBindingResult(); } for ( int i = 0 ; i < bindingResult.getFieldErrors().size(); i++){ if (i > 0 ){ errorInfo.append( "," ); } FieldError fieldError = bindingResult.getFieldErrors().get(i); errorInfo.append(fieldError.getField()).append( " :" ).append(fieldError.getDefaultMessage()); } log.error(errorInfo.toString()); //這里返回自己的Result的結(jié)果類。 return Result.validateFailed(errorInfo.toString()); } @ExceptionHandler (Exception. class ) @ResponseStatus (HttpStatus.BAD_REQUEST) @ResponseBody public Result handleDefaultException(Exception exception) { log.error(exception.toString()); //這里返回自己的Result的結(jié)果類。 return Result.validateFailed( "服務(wù)器錯(cuò)誤" ,exception); } } |
``
7. 先測(cè)試LoginModel的校驗(yàn)規(guī)則
控制臺(tái)打印的數(shù)據(jù)
前端收到的數(shù)據(jù)
切換成SaveModel控制臺(tái)打印的數(shù)據(jù)
切換成SaveModel前端收到的數(shù)據(jù)
可以看到兩次的驗(yàn)證規(guī)則時(shí)不同的,完成了簡(jiǎn)易的分組操作。
8 、總結(jié),就是在添加驗(yàn)證規(guī)則的時(shí)候指定對(duì)應(yīng)的分組,在使用時(shí)傳入需要的分組??赡芾斫庥姓`,發(fā)現(xiàn)請(qǐng)指導(dǎo)。
總結(jié)
到此這篇關(guān)于SpringBoot @Validated注解實(shí)現(xiàn)參數(shù)分組校驗(yàn)的文章就介紹到這了,更多相關(guān)SpringBoot @Validated注解實(shí)現(xiàn)參數(shù)分組校驗(yàn)內(nèi)容請(qǐng)搜索服務(wù)器之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持服務(wù)器之家!
原文鏈接:https://blog.csdn.net/weixin_43671737/article/details/108578122