SpringBoot注解驗證參數
廢話不多說,直接上表格說明:
| 注解 | 作用類型 | 解釋 |
| @NotNull | 任何類型 | 屬性不能為null |
| @NotEmpty | 集合 | 集合不能為null,且size大於0 |
| @NotBlanck | 字符串、字符 | 字符類不能為null,且去掉空格之后長度大於0 |
| @AssertTrue | Boolean、boolean | 布爾屬性必須是true |
| @Min | 數字類型(原子和包裝) | 限定數字的最小值(整型) |
| @Max | 同@Min | 限定數字的最大值(整型) |
| @DecimalMin | 同@Min | 限定數字的最小值(字符串,可以是小數) |
| @DecimalMax | 同@Min | 限定數字的最大值(字符串,可以是小數) |
| @Range | 數字類型(原子和包裝) | 限定數字范圍(長整型) |
| @Length | 字符串 | 限定字符串長度 |
| @Size | 集合 | 限定集合大小 |
| @Past | 時間、日期 | 必須是一個過去的時間或日期 |
| @Future | 時期、時間 | 必須是一個未來的時間或日期 |
| 字符串 | 必須是一個郵箱格式 | |
| @Pattern | 字符串、字符 | 正則匹配字符串 |
以上注解用到要驗證參數的封裝類中的屬性上:
public class Test {
@NotNull(message = "ID不能為空")
@Range(min = 1, max = 100, message = "ID必須在1到100之間")
private Integer id;
@NotBlank(message = "姓名不能為空")
@Length(min = 2, max = 6, message = "姓名必須在2到6位之間")
private String name;
@NotNull(message = "余額不能為空")
@DecimalMax(value = "30.50", message = "余額不能超過30.5")
@DecimalMin(value = "1.50", message = "余額不能低於1.5")
private BigDecimal amount;
@NotNull(message = "生日不能為空")
@Past(message = "生日必須是過去")
private Date birthday;
@NotBlank(message = "郵箱不能為空")
@Email(message = "郵箱格式不正確")
private String email;
@NotBlank(message = "手機號不能為空")
@Pattern(regexp = "^(((13[0-9])|(14[579])|(15([0-3]|[5-9]))|(16[6])|(17[0135678])|(18[0-9])|(19[89]))\\d{8})$", message = "手機號格式錯誤")
private String phone;
}
然后在controller的每個接口中使用@Validated和BindingResult類
@Validated注解用於驗證一個入參,驗證之后的消息綁定到BindingResult類中:
@PostMapping("/test")
@ApiOperation(value = "測試", notes = "", response = Result.class)
public Result test(@ApiParam(name = "test", value = "參數", required = true) @Validated @RequestBody Test test, BindingResult bindingResult) {
if(bindingResult.hasErrors()){
String errorMsg = bindingResult.getFieldError().getDefaultMessage();
return Result.error(errorMsg);
}
return Result.ok("參數驗證通過");
}

