SpringBoot参数校验的最佳实战教程

下面我将为您讲解“SpringBoot参数校验的最佳实战教程”的完整攻略。

1. 什么是参数校验

在实际开发中，我们需要对从前端或其他业务处理层传递进来的参数进行验证。参数校验是为了确保参数的类型、长度、范围、格式等是否符合项目需求的一项重要功能。参数校验可以避免因为参数错误引起的系统异常和数据错误，保证系统的安全性和合法性。

2. 参数校验的实现方式

SpringBoot提供了多种参数校验的实现方式：

2.1 JSR-303 标准注解实现

Java官方提供了JSR-303规范，定义了一套校验注解。使用这些注解可以在实体类中标注各个属性应该满足的验证条件。在Spring中，可以通过使用@Valid注解进行验证。

示例：

public class User {
    @NotNull
    private String name;
    @Min(0)
    @Max(100)
    private int age;
    ...
}

@PostMapping("/user")
public ResponseEntity addUser(@Valid @RequestBody User user) {
    userService.addUser(user);
    return ResponseEntity.ok().build();
}

2.2 自定义校验注解实现

JSR-303虽然提供了一系列标准注解，但是仍然满足不了各种复杂验证场景的需求。因此，我们需要自己定义校验注解来实现更加灵活的验证。

示例：

新建注解：

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Phone {

    String message() default "手机号格式错误";

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

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

在实体类中使用自定义注解：

public class User {
    ....

    @Phone
    private String phone;
    ...
}

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

    @PostMapping
    public void addUser(@Valid User user) {
        // user的phone属性会被@Phone注解校验
        userService.addUser(user);
    }
}

2.3 其他校验方式

除了以上两种校验方式，还可以使用其他校验方式，如：

• 使用Spring提供的BindingResult来实现验证结果的处理；
• 使用Spring提供的校验器Validator来实现自定义校验规则。

3. 参数校验的异常处理

在上述校验注解使用中，如果参数校验失败，会抛出MethodArgumentNotValidException异常。因此，需要在控制层对该异常进行统一处理。

示例：

@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 处理参数校验异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResultVO handleParameterException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        StringBuilder message = new StringBuilder();
        if (bindingResult.hasErrors()) {
            List<ObjectError> errorList = bindingResult.getAllErrors();
            for (ObjectError error : errorList) {
                message.append(error.getDefaultMessage()).append(",");
            }
            message.deleteCharAt(message.length() - 1);
        }
        return ResultVO.error(ResultCode.PARAM_ERROR, message.toString());
    }
}

4. 总结

以上就是SpringBoot参数校验的最佳实战教程的详细攻略，包括了参数校验的实现方式和异常处理的配置。您可以根据实际业务需求选取不同的实现方式，在保证数据安全的基础上，使用更加方便的方式完成参数校验。