@NotEmpty、@NotBlank等注解的正确使用 @Validated和@Valid的区别 解决@NotBlank等注解不生效的问题 使用BindingResult进行接口请求参数的统一校验

服务端通常将controller层作为调用的第一层，因而参数校验常常在这里完成，比如非空校验、类型校验等，如下登录接口代码所示：

 /**    * 登录接口    *    * @author 念兮为美    * @datetime 2022/8/11:13:41    */   @PostMapping("/login")   public JSONObject login(@RequestBody UserLoginDto userLogin) {     String password = userLogin.getPassword();     JSONObject jsonObject=new JSONObject();     if (null == password || "".equals(password)) {       jsonObject.put("success",false);       jsonObject.put("message","密码不能为空");       return  jsonObject;     }     ...   } 

假如在controller层的某个方法中，有很多个需要校验的请求参数，这样写无疑会有多条if判断语句，因而，我们需要使用优雅的方式处理接口请求参数。

前提是需要在pom文件中增加如下依赖：

<dependency>     <groupId>javax</groupId>     <artifactId>javaee-api</artifactId>     <version>8.0.1</version> </dependency> 

依赖配置好后，编写需要注解的bean，如下代码所示：

package com.superjson.superjsonmanager.dto;  import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor;  import javax.validation.constraints.NotBlank;   /**  * @author 念兮为美  * @datetime 2022/8/5 21:34  * @desc 用户登录请求参数  */ @AllArgsConstructor @NoArgsConstructor @Data public class UserLoginDto {   /** 密码 */   @NotBlank(message = "密码不能为空")   private String password;    /** 类型 */   @NotBlank(message = "登录类型不能为空")   private String type;    /** 用户名 */   @NotBlank(message = "账号不能为空")   private String username; }  

我们常用的注解有@NotBlank 、@NotEmpty、@NotNull 等，当然，我们也有可能用到其他注解来检查属性。

4.1 空检查

4.2 布尔检查

4.3 长度检查

4.4 日期检查

4.5 数值检查

建议在Stirng和Integer类型使用，不建议在int类型上使用。因为表单值为“”时无法转换为int，但可以转换为Stirng为""，Integer为null。

我们在bean中通过注解定义好类之后，需要在controller层加上@Validated和BindingResult参数，如下代码所示：

 package com.superjson.superjsonmanager.controller;  import com.alibaba.fastjson.JSONObject; import com.superjson.superjsonmanager.dto.UserLoginDto; import com.superjson.superjsonmanager.service.UserService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.validation.BindingResult; import org.springframework.validation.FieldError; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController;  /**  * @author 念兮为美  * @datetime 2022/8/5 21:30  * @desc 用户登录控制器  */ @RestController @RequestMapping("/user") public class UserController {    @Autowired private UserService userService;    @PostMapping("/login")   public JSONObject login(       @Validated @RequestBody UserLoginDto userLogin, BindingResult bindingResult) {     if (bindingResult.hasErrors()) {       JSONObject jsonObject = new JSONObject();       FieldError fieldError = bindingResult.getFieldError();       //获取出错的属性       jsonObject.put("field", fieldError.getField());       //获取出错的注解名字，比如notBlank，notNull等       jsonObject.put("code", fieldError.getCode());       //获取出错的对象名称       jsonObject.put("objectName", fieldError.getObjectName());       //获取错误的信息       jsonObject.put("message", fieldError.getDefaultMessage());       throw new 你自定义的异常("参数请求异常：" + fieldError.getDefaultMessage());     }     return userService.getByUsernameAndPassword(             userLogin.getUsername(), userLogin.getPassword(), userLogin.getType());   } } 

5.1 @Validated和@Valid区别

1. @Valid 和 @Validated 两者都可以对数据进行校验，待校验字段上打的规则注解（@NotNull, @NotEmpty等）都可以对 @Valid 和 @Validated 生效；

2. @Valid 进行校验的时候，需要用 BindingResult 来做一个校验结果接收。当校验不通过的时候，如果手动不 return ，则并不会阻止程序的执行；

3. @Validated 进行校验的时候，当校验不通过的时候，程序会抛出400异常，阻止方法中的代码执行，这时需要再写一个全局校验异常捕获处理类，然后返回校验提示。

4. 总体来说，@Validated 使用起来要比 @Valid 方便一些，它可以帮我们节省一定的代码，并且使得方法看上去更加的简洁。

在如上postman中，password和username都为空，按道理说，应该是报错的，但执行后并没有报错，如下图所示：

根据上述3. 编写需要注解的bean可以看到，password和username都不为空，实际上应该有两个error，但现在是0 error，就不正常。

实际上，我们少引用hibernate-validator这个依赖，只需要增加如下依赖即可：

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

增加如下依赖之后，重启服务后运行。不仅能让@NotBlank注解生效，也可以让@NotBlank等注解生效，如下图所示：