SpringBoot表单验证（注解验证）@Validated使用

怼烎@ 2023-10-10 16:11 71阅读 0赞

#### SpringBoot注解验证参数 ####

***导入包***：  
import javax.validation.constraints  
import org.[springframework][].validation.annotation

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>作用类型</th> 
   <th>解释</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@NotNull</td> 
   <td>任何类型</td> 
   <td>属性不能为null</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td>集合</td> 
   <td>集合不能为null，且size大于0</td> 
  </tr> 
  <tr> 
   <td>@NotBlank</td> 
   <td>字符串、字符</td> 
   <td>字符类不能为null，且去掉空格之后长度大于0</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td>Boolean、boolean</td> 
   <td>布尔属性必须是true</td> 
  </tr> 
  <tr> 
   <td>@Min</td> 
   <td>数字类型（原子和包装）</td> 
   <td>限定数字的最小值（整型）</td> 
  </tr> 
  <tr> 
   <td>@Max</td> 
   <td>同@Min</td> 
   <td>限定数字的最大值（整型）</td> 
  </tr> 
  <tr> 
   <td>@DecimalMin</td> 
   <td>同@Min</td> 
   <td>限定数字的最小值（字符串，可以是小数）</td> 
  </tr> 
  <tr> 
   <td>@DecimalMax</td> 
   <td>同@Min</td> 
   <td>限定数字的最大值（字符串，可以是小数）</td> 
  </tr> 
  <tr> 
   <td>@Range</td> 
   <td>数字类型（原子和包装）</td> 
   <td>限定数字范围（长整型）</td> 
  </tr> 
  <tr> 
   <td>@Length</td> 
   <td>字符串</td> 
   <td>限定字符串长度</td> 
  </tr> 
  <tr> 
   <td>@Size</td> 
   <td>集合</td> 
   <td>限定集合大小</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>时间、日期</td> 
   <td>必须是一个过去的时间或日期</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td>时期、时间</td> 
   <td>必须是一个未来的时间或日期</td> 
  </tr> 
  <tr> 
   <td>@Email</td> 
   <td>字符串</td> 
   <td>必须是一个邮箱格式</td> 
  </tr> 
  <tr> 
   <td>@Pattern</td> 
   <td>字符串、字符</td> 
   <td>正则匹配字符串</td> 
  </tr> 
 </tbody> 
</table>

**以上注解用到要验证参数的封装类(实体类)中的属性上**

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("参数验证通过");
        }

[springframework]: https://so.csdn.net/so/search?q=springframework&spm=1001.2101.3001.7020