Java后端参数校验SpringBoot+Hibernate Validator

开发中遇到参数需要校验，可以在处理逻辑中进行if判断，但如果校验项较多的话，会增加很多例如if-else的代码：

if(StringUtils.isBlank(req.getUserName())){
    System.out.println("用户名不能为空");
}
if(StringUtils.isBlank(req.getValue())){
    System.out.println("密码不能为空");
}

这时，我们可以借助Hibernate Validator来进行参数的校验。
如果项目中依赖添加了spring-boot-starter-web的话，hibernate-validator依赖已经包含，就不需要单独引入额外的依赖：

如果项目pom.xml中没有这个依赖的话，需要引入hibernate-validator的依赖：

	<!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
	 <dependency>
	     <groupId>org.hibernate.validator</groupId>
	     <artifactId>hibernate-validator</artifactId>
	     <version>6.1.6.Final</version>
	 </dependency>

之后在实体类中要校验的项上加上注解：

@Data
public class UserReq {
    @NotBlank(message = "登录用户名不能为空")
    private String userName;
    @NotBlank(message = "用户密码不能为空")
    @Length(min = 6, message = "密码长度至少6位" )
    private String value;
}

@NotEmpty 不能为 null，且长度必须大于 0，一般用在集合类上或者数组上
@NotNull 不能为 null，但可以为 empty，一般用在 Integer 类型的基本数据类型的非空校验上，而且被其标注的字段可以使用 @size、@Max、@Min 对字段数值进行大小的控制
@NotBlank 只能作用在接收的 String 类型上，注意是只能，不能为 null，而且调用 trim() 后，长度必须大于 0，即：必须有实际字符

• 其他校验规则还有很多，也可以自定义校验规则，大家自行查阅。
  最后在方法中加入@Validated

@PostMapping("/getUser")
public void getUser(@Validated @RequestBody UserReq req, BindingResult bindingResult){
	//参数校验处理
     if(bindingResult.hasErrors()){
          StringBuilder errorMsg = new StringBuilder();
          for (ObjectError error : bindingResult.getAllErrors()){
              errorMsg.append(error.getDefaultMessage()).append(",");
          }
          //删除末尾逗号
          errorMsg.delete(errorMsg.length()-1,errorMsg.length());
          System.out.println(errorMsg.toString);
      }
	System.out.println(req.toString);
}

这里使用了 BindingResult 对象,这个对象主要是封装了上面的返回信息。
也可以进行通过异常处理的方式来处理错误信息。
注意 如果是post请求，需要在参数前加上@RequestBody注解，可以将传入的参数通过get,set方法赋值到实体对象中。

• 进行测试：
  
  
  实际开发中，将结果进行返回就好啦。

本文地址：https://blog.csdn.net/qq_43948440/article/details/110479177