Spring Boot Validation

Spring Boot Validation是Spring Boot整合了Hibernate Validation的一个框架，其核心是Hibernate Validation，此框架的作用是检验客户端向服务器端提交的请求参数的基本格式是否合法。

1.创建一个Spring Boot工程。

勾选依赖项

2.创建一个UserController类作为控制器类，添加处理登录的方法。

@RestController
public class UserController {

    @RequestMapping("/login")
    public String login(String username, String password){
        System.out.println("username = " + username + ", password = " + password);
        return "OK";
    }
}

启动项目测试

打开浏览器

观察控制台

3.如果使用Spring Boot Validation验证请求参数的基本格式，应将以上方法接收到的数据封装起来。创建一个UserLoginDTO类。

public class UserLoginDTO {
    private String username;
    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "UserLoginDTO{" +
                "username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

将UserController类原本请求方法的参数改成一个类的对象。

并在参数前添加@Valid或@Validated

@RequestMapping("/login")
    public String login(@Valid UserLoginDTO userLoginDTO){
        System.out.println("userLoginDTO = " + userLoginDTO);
        return "OK";
    }

 4.在UserLoginDTO类属性上添加注解来配置验证规则。

import javax.validation.constraints.NotNull;

public class UserLoginDTO {

    @NotNull(message = "登录失败，用户名不能为空！")
    @Pattern(regexp = "[a-zA-Z0-9_]{4,16}",message = "登录失败，用户名格式错误！")
    private String username;

    @NotNull(message = "登录失败，密码不能为空！")
    private String password;

    // 省略后面代码
}

 运行测试

将用户名删除。

控制台信息。

 与@NotNull相似的注解还有@NotBlank、@NotEmpty

• @NotNull：不允许为null值，如果客户端提交的参数中没有这一项，则视为null。
• @NotBlank：不允许为空白值，空白值包括若干个空格、TAB符等组成的字符。
• @NotEmpty：不允许为空字符串，即不允许长度为0的字符串。

 5.在UserController控制器中，获取验证失败提示文本，需要在验证右侧添加BindingResult参数，必须添加在被验证对象的右侧并且中间不能有其他参数。

@RequestMapping("/login")
    public String login(@Valid UserLoginDTO userLoginDTO, BindingResult bindingResult){
        
}

BindingResult常用方法

// 判断验证是否存在错误
boolean hasError = bindingResult.hasErrors();
// 获取验证失败提示文本
String errorMessage = bindingResult.getFieldError().getDefaultMessage();