Spring Boot实现各种参数校验

在Spring Boot中，参数校验是一个非常重要的功能，它帮助我们确保前端请求的数据符合预期的格式和要求。Spring Boot提供了多种方式进行参数校验，以下是几种常见的实现方式：

1. 使用注解进行参数校验

Spring Boot内置了许多常用的校验注解，这些注解可以直接应用到Controller层的方法参数上，对参数进行基本的校验。例如：

@PostMapping("/createUser")
public ResponseEntity<String> createUser(@RequestBody @Valid User user) {
    // 执行创建用户逻辑
    return ResponseEntity.ok("用户创建成功");
}

在这个例子中，@Valid注解会触发对User对象进行校验，而User类中的字段可以使用其他的校验注解进行约束，比如@NotNull、@NotBlank、@Min等。具体示例如下：

public class User {
    @NotNull(message = "用户名不能为空")
    private String username;

    @NotBlank(message = "密码不能为空")
    private String password;

    @Min(value = 18, message = "年龄不能小于18")
    private int age;
}

• @NotNull：表示字段值不能为null。
• @NotBlank：表示字段值不能为空且不包含空格。
• @Min：表示数字字段的最小值要求。

当客户端发送一个包含无效数据的请求时，Spring Boot会自动返回错误信息，并且返回的HTTP状态码为400 Bad Request。

2. 自定义校验注解

对于更复杂的业务需求，Spring Boot允许我们自定义校验注解。例如，如果需要校验用户名是否唯一，我们可以创建一个自定义的注解@UniqueUsername，并结合一个校验器类来完成校验。自定义注解的定义如下：

@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = UniqueUsernameValidator.class)
public @interface UniqueUsername {
    String message() default "用户名已存在";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

该注解通过@Constraint指定了验证器类UniqueUsernameValidator，验证器类需要实现ConstraintValidator接口。在该接口中，我们编写校验逻辑来检查用户名是否唯一。示例如下：

public class UniqueUsernameValidator implements ConstraintValidator<UniqueUsername, String> {
    @Autowired
    private UserRepository userRepository;

    @Override
    public boolean isValid(String username, ConstraintValidatorContext context) {
        return userRepository.findByUsername(username) == null;
    }
}

3. 全局异常处理

在进行参数校验时，如果校验失败，Spring Boot会抛出MethodArgumentNotValidException异常。为了方便统一处理这些校验失败的错误，我们可以使用@ControllerAdvice来进行全局异常处理，并返回友好的错误信息给客户端。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationException(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getFieldErrors().forEach(error -> errors.put(error.getField(), error.getDefaultMessage()));
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errors);
    }
}

在这个例子中，@ExceptionHandler注解标注的方法会处理所有MethodArgumentNotValidException异常，方法体内会遍历所有字段的校验错误，并返回一个包含字段名和错误信息的Map。客户端接收到响应时会得到类似如下的JSON格式错误信息：

{
    "username": "用户名不能为空",
    "password": "密码不能为空"
}

4. 使用@Validated和@Valid的区别

在Spring Boot中，@Valid和@Validated都可以用来进行校验，但二者有些许不同。@Valid通常用于触发Bean的校验，而@Validated可以用于校验带有分组的约束。

• @Valid：是JSR303规范中的注解，通常用于对对象进行校验。
• @Validated：是Spring的扩展注解，除了可以触发对象校验，还支持校验分组。

例如：

public class User {
    @NotNull(groups = BasicInfo.class)
    private String username;

    @NotNull(groups = ExtendedInfo.class)
    private String password;
}

@PostMapping("/createUser")
public ResponseEntity<String> createUser(@RequestBody @Validated(BasicInfo.class) User user) {
    // 执行创建用户逻辑
    return ResponseEntity.ok("用户创建成功");
}

5. 参数校验原理解析

Spring Boot参数校验的核心原理是基于Java Bean Validation规范（JSR-303），通过注解方式在Java Bean类中标注校验规则，然后在Controller方法的参数中触发校验。Spring Boot集成了Hibernate Validator作为默认的校验实现，执行校验时会依赖javax.validation.Validator接口。

在请求到达Controller时，Spring Boot会自动使用Hibernate Validator对请求体（例如@RequestBody中的Java对象）进行校验，校验失败则抛出异常MethodArgumentNotValidException，最终通过异常处理机制返回错误信息。

小结

Spring Boot提供了强大的参数校验机制，能够帮助我们确保输入的数据符合预期，并且具有良好的异常处理机制。通过注解的方式，我们可以轻松实现常见的校验逻辑，还可以根据实际需求自定义校验注解和校验规则，从而使得应用的参数验证更加灵活和安全。