Spring Boot中@Valid方法常用注解

使用背景

请求数据校验(目前我只在这块使用过)

使用方式

  • 在请求实体中加上注解,示例:(注意内部类的校验需要额外加上@Valid注解)
@Data
public class Demo1 extends BaseReq {

    @NotBlank(message = "名称不能为空")
    @Length(min = 1, max = 25, message = "名称只能有1-25个字符!")
    private String name;

    @Valid  // 重点在这里,一定要加上@Valid,Demo2中的校验才会生效,否则不会生效
    @NotNull(message = "列表不能为空")
    private List demo2List;

    @Data
    public static class Demo2{

        @NotNull(message = "id不能为空")
        private Integer id;

        @NotNull(message = "sortNum不能为空")
        @Range(min = 0, max = 100, message = "排序值需要介于0 - 100之间")
        private Integer sortNum;
    }
}
  • Controller层获取的请求实体需要加上@Valid
	// 如果请求类型是json类型(即下面的produces对应的值),则需要在请求实体前加上@RequestBody,就会自动转成实体对应的属性值,否则会无法识别类型从而报错
	@PostMapping(value = "/add", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    public CommonResult add(@RequestBody @Valid Demo1 demo1Req) { // 重点在这里,需要加上@Valid才会去校验
        log.info("xxx操作:{}", demo1Req);
       // ... service对请求做的处理省略
        return CommonResult.asSuccess(); // 返回结果
    }

你可能感兴趣的:(java)