本篇介绍spring boot如何验证传入的参数,是否合法。
pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
独立参数验证
此时,如果请求没有传参,abc为空,就会报500验证异常。
@RestController
@Validated //开启验证
public class HelloController {
@GetMapping(value="hello")
public void hello( @NotNull String abc) {//验证规则,参数不能为空
类参数验证
验证规则定义在参数上面,而不再是方法中。
public class User {
@NotNull
private Integer id;
@NotNull
@Size(max = 10,message = "name最长不能超过10个字符")
private String name;
@Validated写在方法参数前面,而不再是类上面。
@RestController
public class HelloController {
@GetMapping(value="hello")
public void hello(@Validated User user) {
常用规则?
主要在javax.validation.constraints包下
- @AssertFalse:必须是布尔型,且值为false
- @AssertTrue:必须是布尔型,且值为true
- @DecimalMax:数字型最大值。
- @DecimalMin:数字型最小值
- @Digits:数字型,指定整数和小数的长度。
- @Email:电子邮箱格式
- @Future:未来的时间类型,即大于当前时间。
- @FutureOrPresent:当前或未来的时间类型,比如时间是当前年或月等。
- @Past:过去的时间类型。
- @PastOrPresent:过去或现在的时间。
- @Max:整数型最大值
- @Min:整数型最小值
- @NotNull:不能为null
- @NotBlank:不能为空字符串。
- @NotEmpty:不能为空集合,空map等
- @Size:集合或字符串、数组等,指定最大最小长度
- @Null:必须为null
- @Negative:必须是负数?
- @NegativeOrZero:必须是负数或0
- @Positive:必须是正数
- @PositiveOrZero:正数或0
- @Pattern:正则表达式
分组验证
不同的方法,对同一个参数所作的验证,可能是不同的逻辑,通过分组来加以区别。如下,只有参数和方法中指定的group是一致的,才会进行验证
public interface Group1 {}
public class User {
@NotNull(groups = {Group1.class})//只有标识了groups中的class,才验证
private Integer id;
@GetMapping(value="hello")
public void hello(@Validated(Group1.class) User user) {//Group1在groups中
自定义验证
根据自己编写的逻辑代码,进行验证。以下自定义一个Tom注解,用于验证参数值是否是Tom
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {TomValidator.class}) //指定验证类
public @interface Tom { //自定义验证注解
String message() default "验证失败消息";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
public class TomValidator implements ConstraintValidator<Tom, String> {
@Override
public void initialize(Tom constraintAnnotation) {
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
//自定义验证逻辑
if (value.equals("Tom")) {
return true;
} else return false;
}
@Tom
public String name; //只有name为Tom时,才能通过验证
|