前言
??在日常的開(kāi)發(fā)中，參數(shù)校驗(yàn)是非常重要的一個(gè)環(huán)節(jié)，嚴(yán)格參數(shù)校驗(yàn)會(huì)減少很多出bug的概率，增加接口的安全性。也會(huì)減少對(duì)接時(shí)不必要的溝通。比如說(shuō)：在對(duì)接的時(shí)候前端動(dòng)不動(dòng)就甩個(gè)截圖過(guò)來(lái)說(shuō)接口有問(wèn)題，你檢查了半天發(fā)現(xiàn)前端傳遞的參數(shù)有問(wèn)題。針對(duì)以上：今天給大家分享一下SpringBoot如何實(shí)現(xiàn)統(tǒng)一參數(shù)校驗(yàn)。
實(shí)現(xiàn)方式
??使用 @Validated注解配合參數(shù)校驗(yàn)注解， 比如：@NotEmpty對(duì)參數(shù)進(jìn)行校驗(yàn)。然后對(duì)拋出的異常ControllerAdvice進(jìn)行捕獲然后調(diào)整輸出數(shù)據(jù)。
TestController
@RestController
public class TestController {
/**
* 表單請(qǐng)求
* @param form 請(qǐng)求參數(shù)
* @return 響應(yīng)數(shù)據(jù)
*/
@PostMapping("/formRequest")
public ResultVo formRequest(@Validated RequestForm form){
return ResultVoUtil.success(form);
}
/**
* JSON請(qǐng)求
* @param form 請(qǐng)求參數(shù)
* @return 響應(yīng)數(shù)據(jù)
*/
@PostMapping("/jsonRequest")
public ResultVo jsonRequest(@RequestBody @Validated RequestForm form){
return ResultVoUtil.success(form);
}
}
RequestForm
@Data
public class RequestForm {
@NotEmpty(message = "姓名不能為空")
private String name;
@Min(value = 1 , message = "年齡不能小于1歲")
private Integer age;
@NotEmpty(message = "性別不能為空")
private Integer sex;
}
測(cè)試結(jié)果
請(qǐng)求：http://localhost:8080/formRequest 不傳任何參數(shù)。
??這個(gè)時(shí)候SpringBoot已經(jīng)根據(jù)校驗(yàn)注解對(duì)參數(shù)進(jìn)行校驗(yàn)了。并且輸出了一大堆的錯(cuò)誤信息。這個(gè)時(shí)候前端在對(duì)接的時(shí)候看到這樣的錯(cuò)誤信息，反手就是給你截個(gè)圖告訴你接口有問(wèn)題。所以這個(gè)時(shí)候就該使用 ControllerAdvice規(guī)范異常返回信息了。
ControllerAdvice
@Slf4j
@RestControllerAdvice
public class ControllerAdvice {
/**
* 攔截表單參數(shù)校驗(yàn)
*/
@ResponseStatus(HttpStatus.OK)
@ExceptionHandler({BindException.class})
public ResultVo bindException(BindException e) {
BindingResult bindingResult = e.getBindingResult();
return ResultVoUtil.error(Objects.requireNonNull(bindingResult.getFieldError()).getDefaultMessage());
}
/**
* 攔截JSON參數(shù)校驗(yàn)
*/
@ResponseStatus(HttpStatus.OK)
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResultVo bindException(MethodArgumentNotValidException e) {
BindingResult bindingResult = e.getBindingResult();
return ResultVoUtil.error(Objects.requireNonNull(bindingResult.getFieldError()).getDefaultMessage());
}
}
@RestControllerAdvice會(huì)將返回的數(shù)據(jù)以json輸出，如果不需要可以使用@ControllerAdvice
以上代碼只返回了錯(cuò)誤信息?？梢愿鶕?jù)實(shí)際情況進(jìn)行調(diào)整。
這個(gè)時(shí)候的錯(cuò)誤信息就比較友好了，非常明確的指出了缺少參數(shù)。
常用校驗(yàn)注解
| 注解 | 運(yùn)行時(shí)檢查 |
|---|---|
| @AssertFalse | 被注解的元素必須為false |
| @AssertTrue | 被注解的元素必須為true |
| @DecimalMax(value) | 被注解的元素必須為一個(gè)數(shù)字，其值必須小于等于指定的最小值 |
| @DecimalMin(Value) | 被注解的元素必須為一個(gè)數(shù)字，其值必須大于等于指定的最小值 |
| @Digits(integer=, fraction=) | 被注解的元素必須為一個(gè)數(shù)字，其值必須在可接受的范圍內(nèi) |
| @Future | 被注解的元素必須是日期，檢查給定的日期是否比現(xiàn)在晚 |
| @Max(value) | 被注解的元素必須為一個(gè)數(shù)字，其值必須小于等于指定的最小值 |
| @Min(value) | 被注解的元素必須為一個(gè)數(shù)字，其值必須大于等于指定的最小值 |
| @NotNull | 被注解的元素必須不為null |
| @Null | 被注解的元素必須為null |
| @Past(java.util.Date/Calendar) | 被注解的元素必須過(guò)去的日期，檢查標(biāo)注對(duì)象中的值表示的日期比當(dāng)前早 |
| @Pattern(regex=, flag=) | 被注解的元素必須符合正則表達(dá)式，檢查該字符串是否能夠在match指定的情況下被regex定義的正則表達(dá)式匹配 |
| @Size(min=, max=) | 被注解的元素必須在制定的范圍(數(shù)據(jù)類(lèi)型:String, Collection, Map and arrays) |
| @Valid | 遞歸的對(duì)關(guān)聯(lián)對(duì)象進(jìn)行校驗(yàn), 如果關(guān)聯(lián)對(duì)象是個(gè)集合或者數(shù)組, 那么對(duì)其中的元素進(jìn)行遞歸校驗(yàn),如果是一個(gè)map,則對(duì)其中的值部分進(jìn)行校驗(yàn) |
| @CreditCardNumber | 對(duì)信用卡號(hào)進(jìn)行一個(gè)大致的驗(yàn)證 |
| 被注釋的元素必須是電子郵箱地址 | |
| @Length(min=, max=) | 被注解的對(duì)象必須是字符串的大小必須在制定的范圍內(nèi) |
| @NotBlank | 被注解的對(duì)象必須為字符串，不能為空，檢查時(shí)會(huì)將空格忽略 |
| @NotEmpty | 被注釋的對(duì)象必須為空(數(shù)據(jù):String,Collection,Map,arrays) |
| @Range(min=, max=) | 被注釋的元素必須在合適的范圍內(nèi) (數(shù)據(jù)：BigDecimal, BigInteger, String, byte, short, int, long and 原始類(lèi)型的包裝類(lèi) ) |
| @URL(protocol=, host=, port=, regexp=, flags=) | 被注解的對(duì)象必須是字符串，檢查是否是一個(gè)有效的URL，如果提供了protocol，host等，則該URL還需滿(mǎn)足提供的條件 |
案例
@Data
public class ExampleForm {
@NotEmpty(message = "姓名不能為空")
@Length(min = 1 , max = 10 , message = "名字長(zhǎng)度1~10")
private String name;
@Range(min = 1 , max = 99 , message = "年齡范圍在1~99歲")
private Integer age;
@Pattern(regexp = "^[1][3,4,5,7,8][0-9]{9}$" , message = "電話(huà)號(hào)碼有誤")
private String phone;
@Email(message = "郵箱格式有誤")
private String email;
@Valid
@Size(min = 1 ,max = 10 , message = "列表中的元素?cái)?shù)量為1~10")
private List<RequestForm> requestFormList;
@Future(message = "開(kāi)始時(shí)間必須大于當(dāng)前時(shí)間")
private Date beginTime;
}
實(shí)現(xiàn)嵌套驗(yàn)證
??在實(shí)際的開(kāi)發(fā)中，前臺(tái)會(huì)后臺(tái)傳遞一個(gè)list，我們不僅要限制每次請(qǐng)求list內(nèi)的個(gè)數(shù)，同時(shí)還要對(duì)list內(nèi)基本元素的屬性值進(jìn)行校驗(yàn)。這個(gè)時(shí)候就需要進(jìn)行嵌套驗(yàn)證了，實(shí)現(xiàn)的方式很簡(jiǎn)單。在list上添加@Vaild就可以實(shí)現(xiàn)了。
@Data
public class JsonRequestForm {
@Vaild
@Size(min = 1 ,max = 10 , message = "列表中的元素?cái)?shù)量為1~10")
private List<RequestForm> requestFormList;
}
代碼地址
結(jié)尾
??如果覺(jué)得對(duì)你有幫助，可以多多評(píng)論，多多點(diǎn)贊哦，也可以到我的主頁(yè)看看，說(shuō)不定有你喜歡的文章，也可以隨手點(diǎn)個(gè)關(guān)注哦，謝謝。
??我是不一樣的科技宅，每天進(jìn)步一點(diǎn)點(diǎn)，體驗(yàn)不一樣的生活。我們下期見(jiàn)！
