如何使用Bean Validation 解决业务中参数校验

当我们在开发业务应用时，通常需要对参数进行校验，以防止错误的输入或不合法的操作。而Bean Validation是Java EE的一项规范，可以帮助我们在业务中进行参数校验。下面是使用Bean Validation解决业务中参数校验的完整攻略：

第一步：引入Bean Validation依赖

在maven中，我们可以在pom.xml文件中添加以下依赖：

<!-- Bean Validation -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>

<dependency>
   <groupId>org.hibernate.validator</groupId>
   <artifactId>hibernate-validator</artifactId>
   <version>6.0.17.Final</version>
</dependency>

第二步：定义需要校验的参数对象

在业务中，我们通常需要对参数进行校验。为方便校验，我们可以定义一个参数对象，并在该对象的属性上使用注解标识需要校验的规则。例如，在Controller中的接口方法中，我们可以定义如下示例的参数对象：

public class UserRequest {
    @NotNull(message = "用户名不能为空")
    private String username;
    @Size(min = 6, max = 12, message = "密码长度必须在6~12位之间")
    private String password;
    @Email(message = "邮箱格式不合法")
    private String email;
    // 省略Getter和Setter方法
}

在上述代码中，我们使用了javax.validation.constraints包中的注解来标识需要校验的规则，例如@NotNull、@Size和@Email等。

第三步：进行参数校验

在接收到请求参数后，我们可以使用Bean Validation提供的Validator类，对参数进行校验。示例代码如下：

@RestController
public class UserController {

    @PostMapping("/user")
    public Object addUser(@RequestBody @Valid UserRequest userRequest) {
        //TODO 业务逻辑处理
        return "Success";
    }

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Map<String, Object> handle(MethodArgumentNotValidException exception) {
        Map<String, Object> errorMap = new HashMap<>();
        List<FieldError> errors = exception.getBindingResult().getFieldErrors();
        errors.forEach(error -> {
            errorMap.put(error.getField(), error.getDefaultMessage());
        });
        return errorMap;
    }
}

在上述代码中，我们在Controller的addUser方法上使用了@Valid注解，告诉Spring MVC对参数进行校验，并在Controller中编写handle方法，用于处理校验结果。

示例1：密码长度校验不合法

如果我们使用如下请求体进行测试：

{
    "username": "user",
    "password": "123",
    "email": "user@example.com"
}

则会返回如下错误信息：

{
    "password": "密码长度必须在6~12位之间"
}

示例2：用户名为空