java开发SpringBoot参数校验过程示例教程

下面我来详细讲解“Java开发Spring Boot参数校验过程示例教程”的完整攻略。

什么是参数校验

在Web开发中，为了保证数据的准确性和完整性，在接口中进行参数校验是一个很重要的环节。参数校验通常包括验证参数的格式、数据类型、取值范围等。

使用Spring Boot进行参数校验

Spring Boot提供了一种方便快捷的方式来进行参数校验。使用Spring Boot的参数校验，只需要在Controller的方法中添加注解@Validated和@RequestBody，并在参数前添加注解@Valid，就可以实现对参数的校验。

例如，对于以下的Controller方法：

@RestController
@RequestMapping("/user")
@Validated
public class UserController {
    @PostMapping
    public User saveUser(@Valid @RequestBody User user) {
        return userService.saveUser(user);
    }
}

其中，@Validated注解用来启用Spring Boot校验功能，@Valid注解用来声明参数需要校验，@RequestBody注解用来绑定请求体中的参数。

对于参数User的校验规则，需要在User类中定义。例如：

public class User {
    @NotBlank
    private String name;
    @Min(1)
    private int age;
    // getters and setters
}

其中，@NotBlank注解表示参数不能为空，@Min注解表示参数的最小值为1。同样，Spring Boot提供了很多类型的校验注解，可以根据具体需求选择不同的注解进行校验。

实例1：参数校验失败的处理方式

接下来，我们来看一个校验失败的处理方式。当请求参数不符合校验规则时，Spring Boot会抛出MethodArgumentNotValidException异常。我们可以通过一个@ControllerAdvice来捕获这个异常并做出相应的处理。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public Result<Object> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> errors = bindingResult.getAllErrors();
        ObjectError error = errors.get(0);
        String message = error.getDefaultMessage();
        return Result.failure(ResultCode.PARAM_IS_INVALID, message);
    }
}

其中，@ControllerAdvice注解表示这是一个全局异常处理类，@ExceptionHandler注解表示该方法处理MethodArgumentNotValidException异常，@ResponseBody注解表示返回值为JSON格式。

实例2：分组校验

有时候，我们需要根据业务需求对参数进行分组校验。Spring Boot也提供了相应的注解@NotNull、@NotBlank、@Max等进行校验分组。

例如，一个User有创建和更新两种场景，校验规则也会不同。此时就需要使用到分组校验。示例代码如下：

public interface CreateGroup {};
public interface UpdateGroup {};

public class User {
    @NotBlank(groups = CreateGroup.class)
    private String name;
    @NotNull(groups = {CreateGroup.class,UpdateGroup.class})
    @Min(value = 1,groups = CreateGroup.class)
    @Max(value = 150,groups = UpdateGroup.class)
    private int age;
}

@RestController
@RequestMapping("/user")
@Validated
public class UserController {
    @PostMapping("/create")
    public User createUser(@Validated(CreateGroup.class) @RequestBody User user) {
        return userService.saveUser(user);
    }

    @PostMapping("/update")
    public User updateUser(@Validated(UpdateGroup.class) @RequestBody User user) {
        return userService.updateUser(user);
    }
}

在User类的属性上，通过groups为属性分组。在Controller的方法参数上使用@Validated注解，指定需要校验的分组。这样，在不同的场景下就可以进行不同的参数校验。

希望以上内容对您有所帮助。