@Valid注解使用说明及统一异常处理演示

蔚落 2024-04-03 08:13 21阅读 0赞

**目录**

@Valid注解

案例说明

之前的做法

现在的做法

总结

--------------------

## @Valid注解 ##

### 案例说明 ###

先来看一下数据库表，发现标签名称和操作者id都允许为空，其实这里正常来讲应该设置为非空的。

![123905b7886a4e4690d21bfdc9c3a9e5.png][]

> tips:当数据库表设置为非空的时候，如果我们没有添加相应的非空字段，就不会添加成功！

但是这里，数据库中没有进行非空约束。于是，我们尝试添加为空的数据，肯定是会添加成功的。

@PostMapping("insert")
    @ApiOperation(value = "新增行业标签",notes = "新增行业标签，这里是详细描述信息！",httpMethod = "POST")
    public Result insert(Industry industry){
        // todo 需要先校验对象
        industryService.save(industry);
        return Result.success();
    }

![8343b667acc04ed8b3d66ba0522f89a7.png][]

![4200c8c7a0324f2188fc5cda841bead7.png][]

![57604f4fc5174729b4ac0873d925ad3d.png][]

但是这是我们不希望看到的，我们希望看到的是name和operator\_id字段都有值。所以我们需要对入参进行校验。

其实，不管数据库有没有设置为空，我们都要进行入参的校验工作，加强保证数据的合理性。

### 之前的做法 ###

校验请求参数，我们之前的一般做法都是：

获取到当前参数，然后进行判断，如果不满足条件，我们返回错误提示。

@PostMapping("insert")
    @ApiOperation(value = "新增行业标签",notes = "新增行业标签，这里是详细描述信息！",httpMethod = "POST")
    public Result insert(Industry industry){
    
        String name = industry.getName();
        Integer operatorId = industry.getOperatorId();
        if (StringUtils.isEmpty(name)){
            return Result.fail("标签名称不能为空");
        }
        if (operatorId == null){
            return Result.fail("创建人不能为空");
        }
        
        industryService.save(industry);
        return Result.success();
    }

![700166ac06784af4b4f9fec28bcedc00.png][]

![ad2853bc603844a6a02f3e104fc2c8b1.png][]

![09d9c142448d462c8f9dca3821b30f4b.png][]

![3a07bd5b54244b3c8744c2b5422d6757.png][]

![69255a1c8e7a4ae3b15f12fd80d7a035.png][]

![b0a208c208c54debaaefbb60ee33f419.png][]

![1f9ddc727363438890c402dc2c5fee31.png][]

![e5dfc0ed8aff46efb314a8b12af2475d.png][]

### 现在的做法 ###

只需要在对应的形参添加@Valid注解，然后在对应的实体类属性添加对应约束的注解即可。

@PostMapping("insert")
    @ApiOperation(value = "新增行业标签",notes = "新增行业标签，这里是详细描述信息！",httpMethod = "POST")
    public Result insert(@Valid Industry industry){
        industryService.save(industry);
        return Result.success();
    }

@ApiModelProperty(value = "标签名称")
    @TableField("name")
    @NotBlank(message = "标签名称不能为空")
    private String name;
    
    @ApiModelProperty("操作用户id")
    @TableField("operator_id")
    @NotNull(message = "创建人不能为空")
    private Integer operatorId;

此时，我们测试一下

![845b9deed3a34010a54b9cd765ea5411.png][]

![19ec04e04c3947ff9d44bda740e29dce.png][]

我们发现，也是无法添加成功的。直接报异常了~

我们查看一下，控制台打印的信息：

2022-10-01 12:39:19.285  WARN 7736 --- [nio-8080-exec-1] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
    Field error in object 'industry' on field 'operatorId': rejected value [null]; codes [NotNull.industry.operatorId,NotNull.operatorId,NotNull.java.lang.Integer,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [industry.operatorId,operatorId]; arguments []; default message [operatorId]]; default message [创建人不能为空]]

但是我们希望按照之前一样的统一返回结果的格式进行返回。

我们可以做一个统一异常处理!

再执行发现返回的结构一致了。

但是返回的消息msg，并不是我们@NotNull注解中的message内容

![96a40dcd16f8416eaf6af7e78acd21b5.png][]

![1ef9af217e5f4ce7b7db7555f589181b.png][]

此时捕获的是全局异常类，那么针对这种特定的具体异常还可以进行单独处理！

所以我们需要针对特定异常，来单独处理！

我们通过控制台，可以看到异常的名称叫做BindException，那么我们就针对改异常进行处理~

@ControllerAdvice
    public class GlobalException {
        @ExceptionHandler(Exception.class)
        @ResponseBody
        public Result error(Exception e){
            e.printStackTrace();
            return Result.fail("执行了全局异常处理");
        }
    
        @ExceptionHandler(BindException.class)
        @ResponseBody
        public Result error(BindException e){
            e.printStackTrace();
            return Result.fail("特定异常被执行");
        }
    
    }

![41bff1dd3d754a229a71d3156b6f5e83.png][]

现在，如何能够获取到@NotNull注解中的message值返回呢？

@ExceptionHandler(BindException.class)
    @ResponseBody
    public Result error(BindException e){
        e.printStackTrace();
        String defaultMessage = e.getBindingResult().getAllErrors().get(0).getDefaultMessage();
        return Result.fail(defaultMessage);
    }

这样就可以了。

![fc642eb0eee94449b198829e999ff870.png][]

解析一下：

> BindException这个参数校验异常，会把所有的异常结果放到BindingResult接口中。我们可以通过当前异常调用它内部方法，拿到它当前的所有异常结果，然后获取到第一条异常的message消息。

网上很多人的做法：

> 网上很多教程都是把BindingResult放在接口的参数中，然后在接口里面处理。
> 
> 例如：
> 
>     @RequestMapping("/save")
>         public R save(@RequestBody @Valid BrandEntity brand, BindingResult result){
>             if (result.hasErrors()){
>                 Map<String, String> map = new HashMap<>();
>                 //1.获取校验的错误结果
>                 result.getFieldErrors().forEach(item -> {
>                     // FieldError 获取到错误提示
>                     String message = item.getDefaultMessage();
>                     // 获取错误的属性的名字
>                     String field = item.getField();
>                     map.put(field,message);
>                 });
>                 return R.error(400,"提交的数据不合法").put("data",map);
>             }else {
>                 brandService.save(brand);
>                 return R.ok();
>             }
>     }
> 
> 测试：
> 
>     {
>         "msg": "提交的数据不合法",
>         "code": 400,
>         "data": {
>             "name": "品牌名不能为空,或者空格,或者空串",
>             "logo": "品牌logo必须是一个合法的url",
>             "sort": "排序字段必须大于等于0"
>         }
>     }
> 
> 其实这样不是很好，但凡有校验的，每个接口都要传BindingResult，还要写处理逻辑。
> 
> 不过我们可以参考一下，进行更改。
> 
>     @ExceptionHandler(BindException.class)
>         @ResponseBody
>         public Result error(BindException e){
>     //        e.printStackTrace();
>     //        String defaultMessage = e.getBindingResult().getAllErrors().get(0).getDefaultMessage();
>             BindingResult result = e.getBindingResult();
>             Map<String, String> map = new HashMap<>();
>             //1.获取校验的错误结果
>             result.getFieldErrors().forEach(item -> {
>                 // FieldError 获取到错误提示
>                 String message = item.getDefaultMessage();
>                 // 获取错误的属性的名字
>                 String field = item.getField();
>                 map.put(field,message);
>             });
>             return Result.fail("参数类型异常",map);
>         }
> 
>     {
>         "code": 500,
>         "msg": "参数类型异常",
>         "data": {
>             "name": "标签名称不能为空",
>             "operatorId": "创建人不能为空"
>         }
>     }

### 总结 ###

@Valid注解主要用作就是**参数校验**。

对于简单的校验，省去了我们每次还得写大量重复代码的工作。

步骤：

1.  添加依赖
2.  添加注解@Valid到对应的控制器方法入参
3.  在对应的入参实体类属性上添加对应的功能注解，比如@NotNull，其中message属性添加不匹配时的提示信息。
4.  一旦不匹配会抛出异常，需设置统一异常处理。针对该参数校验的异常添加统一异常处理。

> tips:
> 
> javax.validation 是基于JSR-303标准开发出来的，使用注解方式实现，及其方便，但是这只是一个接口，没有具体实现。
> 
> Hibernate-Validator是一个hibernate独立的包，可以直接引用，他实现了javax.validation同时有做了扩展，比较强大。
> 
> 所以我们引入依赖需要这两个：
> 
>     
>     <dependency>
>         <groupId>javax.validation</groupId>
>         <artifactId>validation-api</artifactId>
>         <version>1.1.0.Final</version>
>     </dependency>
>     <dependency>
>         <groupId>org.hibernate</groupId>
>         <artifactId>hibernate-validator</artifactId>
>         <version>5.2.4.Final</version>
>     </dependency>
> 
> 当然，Spring有对该依赖进行整合，所以我们可以直接引入如下这个依赖即可。
> 
>     
>     <dependency>
>         <groupId>org.springframework.boot</groupId>
>         <artifactId>spring-boot-starter-validation</artifactId>
>         <version>2.7.3</version>
>     </dependency>

常用注解：

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td><strong>限制</strong></td> 
   <td><strong>说明</strong></td> 
  </tr> 
  <tr> 
   <td>@Null</td> 
   <td>用在基本类型上；限制只能为null</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>用在基本类型上；不能为null，但可以为empty</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td>用在集合类上面；不能为null，而且长度必须大于0&nbsp;</td> 
  </tr> 
  <tr> 
   <td>@NotBlank</td> 
   <td> <p>用在String上面；只能作用在String上，不能为null，而且调用trim()后，长度必须大于0&nbsp;</p> <p>ps:意味着不能为null，不能为空串，还不能是只有空格的</p> </td> 
  </tr> 
  <tr> 
   <td>@Max(value)</td> 
   <td>限制必须为一个不大于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@Min(value)</td> 
   <td>限制必须为一个不小于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@AssertFalse</td> 
   <td>限制必须为false</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td> <p>限制必须为true</p> </td> 
  </tr> 
  <tr> 
   <td>@Pattern</td> 
   <td>自定义规则，可以通过regexp属性传入正则表达式，例如regexp = "/^[a-zA-Z]$/"，意思是要求只传一个字母</td> 
  </tr> 
  <tr> 
   <td>@Url</td> 
   <td>这个注解是org.hibernate.validator.constraints下的，也可以使用，限制必须是一个合法的url地址</td> 
  </tr> 
 </tbody> 
</table>

统一异常处理：

@Slf4j
    @ControllerAdvice
    public class GulimallException {
    
        @ExceptionHandler(MethodArgumentNotValidException.class)
        @ResponseBody
        public R handleValidException(MethodArgumentNotValidException e){
            log.error("数据校验出现问题{},异常类型:{}",e.getMessage(),e.getClass());
            BindingResult bindingResult = e.getBindingResult();
            Map<String,String> errorMap = new HashMap<>();
            bindingResult.getFieldErrors().forEach((fieldError)->{
                errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
            });
            return R.error(400,"数据校验出现问题").put("data",errorMap);
        }
    
        @ExceptionHandler(Throwable.class)
        @ResponseBody
        public R handleException(Throwable throwable){
            return R.error(BizCodeEnum.UNKNOW_EXCEPTION.getCode(),BizCodeEnum.UNKNOW_EXCEPTION.getValue());
        }
    }

[123905b7886a4e4690d21bfdc9c3a9e5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/b56a3e5fb6714ea9a151a7c5540b6c8c.png
[8343b667acc04ed8b3d66ba0522f89a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/bc3c37daa9384be78349c26cf9db8622.png
[4200c8c7a0324f2188fc5cda841bead7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/6798a0f20b424208bfb06a56c6e55f45.png
[57604f4fc5174729b4ac0873d925ad3d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/8f5a5f96da4b4b57896ac3ce8046cc3b.png
[700166ac06784af4b4f9fec28bcedc00.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/d61cd276c6a14a5982fc02f324649a29.png
[ad2853bc603844a6a02f3e104fc2c8b1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/b4b33bca43be454fa74ad443d1b0fd79.png
[09d9c142448d462c8f9dca3821b30f4b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/bdfc6a9453d9452a9087188fd44be0c1.png
[3a07bd5b54244b3c8744c2b5422d6757.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/acabebd09ae34c778051a3ba80de4a26.png
[69255a1c8e7a4ae3b15f12fd80d7a035.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/342e8ff3aae3420faf478f610216d190.png
[b0a208c208c54debaaefbb60ee33f419.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/e13abc1884734c51a0fc0d6c34570fc0.png
[1f9ddc727363438890c402dc2c5fee31.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/7815696083f14fbb8f788053ca7ae291.png
[e5dfc0ed8aff46efb314a8b12af2475d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/c48ce4375edc4ce3ad8b0b5ce8e8c111.png
[845b9deed3a34010a54b9cd765ea5411.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/9ce0b782219a4894bd83aa86f10cfbf1.png
[19ec04e04c3947ff9d44bda740e29dce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/280092e4309d4e0f87b96027f6e30b7c.png
[96a40dcd16f8416eaf6af7e78acd21b5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/208f5ca74f41419dab1b263ba9bb25e2.png
[1ef9af217e5f4ce7b7db7555f589181b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/d7301fffd3484b94ba01e44a6d65508d.png
[41bff1dd3d754a229a71d3156b6f5e83.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/9d992062ed184f0eb32f830e202f83da.png
[fc642eb0eee94449b198829e999ff870.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/de2864f708924a9cad457ec34fe19742.png