@Validated注解不生效问题汇总

冷不防 2023-10-04 21:16 69阅读 0赞

## @Validated注解不生效问题汇总 ##

#### 文章目录 ####

*  @Validated注解不生效问题汇总
 *   *  背景：
     *  一：可能原因
     *   *  原因1：
         *  原因2：
         *  原因3：
         *  原因4：
     *  二：补充全局异常对validation的处理

### 背景： ###

项目框架应用的是validation进行检验的，但是最近一直不生效，然后排查了下问题，总结了失效的常见几个原因：

### 一：可能原因 ###

#### 原因1： ####

在2.3.0版本之前spring-boot-starter-web是集成了validation检验的 但是在2.3.0开始就去掉了该依赖，所以需要自己添加该依赖。

添加依赖为：

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-validation</artifactId>
    			<version>3.0.2</version>
    		</dependency>

#### 原因2： ####

参数如果是非对象格式，需要在controller类上面添加@[Validated][]注解

![image-20230213111337727][]

#### 原因3： ####

参数如果是对象的话，属性的前面的需要添加 @Valid注解

![image-20230213112536348][]

#### 原因4： ####

如果是嵌套对象的话，里面的对象还要添加 @Valid注解，截图如下：

![image-20230213112604322][]

![image-20230213112631498][]

这里要注意，如果是集合对象，同样需要添加@Valid注解，不然不生效的

![image-20230213112649877][]

### 二：补充全局异常对validation的处理 ###

/**
     * 处理 @Validated 异常信息
     *
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler
    public BaseResponse methodArgumentNotValidExceptionHandler(HttpServletRequest req, MethodArgumentNotValidException e) {
        
        log.warn("Url:{},Method:{} .\nController called error!Catch in ErrorHandler", req.getRequestURI(),
                req.getMethod(), e);
        String message = "";
        try {
        
            message = e.getMessage().substring(e.getMessage().lastIndexOf("[") + 1, e.getMessage().lastIndexOf("]") - 1);
        } catch (Exception ex) {
        
            log.error("@Validated截取异常信息失效,已重置,所有异常信息为:{}", e.getMessage());
            message = ErrorCodeEnum.PARAMETER_FORMAT_ERROR.getMessage();
        }
        return BaseResponse.error(ErrorCodeEnum.PARAMETER_FORMAT_ERROR.getCode(), message);
    }

[Validated]: https://so.csdn.net/so/search?q=Validated&spm=1001.2101.3001.7020
[image-20230213111337727]: https://img-blog.csdnimg.cn/img_convert/588a1292e78c630ecf15c9ab267f7440.png
[image-20230213112536348]: https://img-blog.csdnimg.cn/img_convert/c0fa163e12167aa5268187ad5b140e39.png
[image-20230213112604322]: https://img-blog.csdnimg.cn/img_convert/4c1e55687cad469a10c0091279a7beed.png
[image-20230213112631498]: https://img-blog.csdnimg.cn/img_convert/b1d5faf6ea45440dfae48d703e4c8e7f.png
[image-20230213112649877]: https://img-blog.csdnimg.cn/img_convert/cd349794cac93852362b7679925b692e.png