Spring Boot 使用validation校验参数
- 项目场景:
- 引入依赖
- 使用
- 校验代码
- 实体类
- 打完收工!
项目场景:
在看公司代码的时候,发现是用了Spring Boot Validation
去检验参数的,但是后面又在代码里去检验参数去了,而且这个Spring Boot Validation
校验好像并不生效。于是自己摸索研究了一下。
引入依赖
虽然项目使用的校验都是
javax.validation
,但是不引入这个依赖他是真的不生效。
gradle如下:
implementation 'org.springframework.boot:spring-boot-starter-validation'
使用
如上,只需要使用注解即可,不要怀疑,他就是
javax.validation
包里的
校验代码
代码如下:
@PostMapping("/test")public ResponseEntity<String> test(@RequestBody @Valid Request request){return ResponseEntity.ok("OK");}
实体类
@Data
public class PudaoCreditRequest {@NotNull(message = "id must be not empty")private Integer id;@NotNull(message = "id2must be not empty")private Integer id2;@Size(min = 1, max = 20)@Pattern(regexp = "^[a-zA-Z0-9_ ]*$", message = "pattern is not proper for channel data ")private String test1;
}
说明
:
- @NotNull就是判断不是Null
- @NotEmpty判断非空字符串
- @Size判断长度
- @Pattern 可以自定义校验,但是不能用于Integer
- @Valid开启校验
- 该校验会抛出org.springframework.web.bind.MethodArgumentNotValidException异常,可以自定义异常处理器进行捕获处理。
- 其他的需要自行探索