Spring Boot参数校验

Spring Boot是一个快速开发框架，它提供了很多便利的功能来简化开发人员的工作。其中之一就是参数校验。参数校验是一个非常重要的功能，可以保证应用程序接收到的数据是有效的，从而避免因为无效数据导致的各种问题。本文将介绍Spring Boot的参数校验功能，包括校验注解、校验器等。

校验注解

Spring Boot提供了很多校验注解，用于校验参数。下面是一些常用的校验注解：

• @NotNull：检查参数不为null
• @NotEmpty：检查参数不为空（字符串、集合、数组）
• @NotBlank：检查参数不为空（字符串）
• @Min(value)：检查参数值大于等于value
• @Max(value)：检查参数值小于等于value
• @Size(min,max)：检查参数长度在min和max之间
• @Email：检查参数是合法的Email地址
• @Pattern(regex)：检查参数符合指定的正则表达式

使用这些注解非常简单，只需要在参数上加上相应的注解即可：

public void foo(@NotNull String name, @Max(100) int age) {
  // ...
}

上面的例子中，@NotNull用于检查name不为null，@Max(100)用于检查age小于等于100。

校验器

如果需要更灵活的校验，可以使用自定义校验器。自定义校验器需要实现ConstraintValidator接口，并用@Constraint(validatedBy = MyValidator.class)注解指定校验器类。下面是一个例子：

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = MyValidator.class)
public @interface MyAnnotation {
  String message() default "invalid value";
  Class<?>[] groups() default {};
  Class<? extends Payload>[] payload() default {};
}

public class MyValidator implements ConstraintValidator<MyAnnotation, String> {
  public void initialize(MyAnnotation constraint) {
  }

  public boolean isValid(String value, ConstraintValidatorContext context) {
    return value != null && value.length() > 0;
  }
}

public class Foo {
  @MyAnnotation
  private String bar;

  // ...
}

上面的例子中，定义了一个@MyAnnotation注解和对应的校验器MyValidator，用于检查Foo类中的bar字段不为空。在Foo类中使用了@MyAnnotation注解，表示bar字段需要进行校验。

常见问题

1. 参数校验失败会发生什么？

如果参数校验失败，Spring Boot会抛出MethodArgumentNotValidException异常。可以通过@ExceptionHandler注解来处理这个异常。

2. 如何进行分组校验？

分组校验可以根据不同的场景进行不同的校验。例如，有些校验只需要在新增时进行，有些校验只需要在更新时进行。可以使用@GroupSequence注解来指定分组顺序。

3. 如何进行参数校验的国际化？

Spring Boot支持参数校验的国际化，可以使用ValidationMessages.properties文件来定义校验错误消息。在文件中，可以使用{0}和{1}等占位符来引用校验注解中的参数。

4. 如何在Swagger中显示参数校验的注解？

Swagger可以自动解析参数校验的注解，并在API文档中显示。只需要在SwaggerConfiguration中添加@EnableSwagger2注解，并使用@ApiImplicitParam注解来添加参数。