Hello Spring Validation, 我爱你不问归期

幸福就好，不要晒出来，因为晒多了，迟早有一天会晒干的，所以低调

Spring Validation（即Spring的数据验证组件）其实是一个抽象层，它为数据验证提供了统一的接口和基本的校验功能。实际上，Spring Validation默认使用了Hibernate Validator作为其具体的实现，但也可以通过适配器与其他数据验证框架（如Apache Commons Validator）一起工作。

您可以将Spring Validation视为一个门面（Facade），它提供了统一的验证API，而具体的验证实现则由底层的验证框架（如Hibernate Validator）负责。这种设计模式使得开发者可以在不改变应用程序代码的情况下，轻松地切换到其他验证框架。

类似地，SLF4J（Simple Logging Facade for Java）也是一个日志门面，它为各种日志框架（如Log4j、Logback和java.util.logging）提供了统一的API。通过使用SLF4J，开发者可以在不修改应用程序代码的情况下，轻松地切换到其他日志框架。

我们有一个UserController类，其中有一个方法getUserById，接收一个id参数，并返回该id对应的用户信息。为了确保id参数合法，我们需要对其进行校验，确保id是一个大于0的整数。

代码实现如下：

首先，我们需要在pom.xml文件中引入spring-boot-starter-validation依赖，如下所示：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

然后，在UserController类中，我们可以对getUserById方法的id参数添加校验注解，如@Min和@NotNull，如下所示：

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public User getUserById(@PathVariable @Min(value = 1, message = "id必须大于0") @NotNull(message = "id不能为空") Long id) {
        return userService.getUserById(id);
    }
}

这里我们使用了@Min注解和@NotNull注解，其中@Min注解用于校验id必须大于0，@NotNull注解用于校验id不能为空。这些注解都是Spring Validation提供的校验注解，可以方便地使用。同时，我们还可以通过message属性指定校验失败时的提示信息。

最后，在我们的应用启动类中，需要开启方法参数校验功能，如下所示：

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        return new MethodValidationPostProcessor();
    }
}

这里我们通过创建一个MethodValidationPostProcessor bean，开启方法参数校验功能。这样，当我们调用getUserById方法时，如果id参数不合法，就会抛出MethodArgumentNotValidException异常，我们可以在异常处理器中对其进行处理。

以上就是一个简单的入参校验实现示例，可以通过添加不同的校验注解来完成不同的校验逻辑。需要注意的是，校验注解的具体用法和属性会有所差异，可以参考Spring Validation的官方文档进行使用。

pojo类的校验

假设我们有一个User类，其中有name和age两个属性，我们需要对这两个属性进行校验。具体实现步骤如下：

1. 在User类中添加校验注解，如下所示：

public class User {
    @NotBlank(message = "姓名不能为空")
    private String name;
    @NotNull(message = "年龄不能为空")
    @Min(value = 0, message = "年龄必须大于等于0")
    private Integer age;

    // 省略getter和setter方法
}

在上面的代码中，我们为name属性添加了@NotBlank注解，表示该属性不能为空。为age属性添加了@NotNull和@Min注解，表示该属性不能为空且必须大于等于0。

2. 在UserController类中，我们可以接收一个User对象作为参数，并在其上添加@Valid注解，如下所示：

@RestController
@RequestMapping("/user")
public class UserController {

    @PostMapping("/")
    public User addUser(@RequestBody @Valid User user) {
        // 省略业务逻辑
        return user;
    }
}

在上面的代码中，我们使用了@Valid注解，表示对user对象进行校验。此时如果校验不通过，就会抛出MethodArgumentNotValidException异常。

3. 在我们的应用启动类中，需要开启方法参数校验功能，如下所示：

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        return new MethodValidationPostProcessor();
    }
}

这里同样需要创建一个MethodValidationPostProcessor bean，开启方法参数校验功能。

以上就是一个简单的POJO类入参校验实现示例。需要注意的是，在实际应用中，我们可能需要对不同的属性添加不同的校验规则，这时需要使用不同的校验注解，并且根据实际情况进行组合。同时，Spring Validation还支持自定义校验注解和校验器，可以满足更加复杂的校验需求。

自定义校验注解和校验器

1. 创建自定义注解

首先我们需要创建一个自定义的注解，用于标注需要进行校验的字段。这里我们以校验邮政编码为例，创建一个注解@ZipCode：

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = ZipCodeValidator.class)
public @interface ZipCode {
    String message() default "邮政编码格式不正确";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

在上面的代码中，我们使用了@Constraint注解指定了该注解对应的校验器是ZipCodeValidator。

2. 创建自定义校验器

接下来我们需要创建ZipCodeValidator类，实现对邮政编码的校验：

public class ZipCodeValidator implements ConstraintValidator<ZipCode, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return true; // 如果值为null，则跳过校验
        }
        String pattern = "^\\d{6}$"; // 邮政编码正则表达式
        return Pattern.matches(pattern, value);
    }
}

在上面的代码中，我们实现了ConstraintValidator接口，并重写了其中的isValid方法，用于校验邮政编码。如果邮政编码格式不正确，则返回false，否则返回true。

3. 在需要校验的字段上使用自定义注解

最后，在需要校验的字段上使用自定义注解@ZipCode即可：

public class Address {
    @NotBlank(message = "收件人不能为空")
    private String recipient;
    @NotBlank(message = "详细地址不能为空")
    private String detail;
    @ZipCode // 自定义注解
    private String zipCode;

    // 省略getter和setter方法
}

以上就是一个简单的自定义注解和校验器的示例。在实际应用中，我们可以根据需要创建不同的自定义注解和校验器，以满足更加复杂的校验需求。同时，Spring Validation还支持自定义校验器的多个配置参数，例如@ScriptAssert注解可以支持使用JSR 223脚本语言进行校验。