Validation failed for argument [0] 参数校验失败的解决办法

港控/mmm° 2023-01-16 09:49 310阅读 0赞

> ### 问题概述 ###

关于这个问题，是在接口参数校验的时候遇到的，使用Spring Boot下spring-boot-starter-validation进行接口参数校验时出现 “  Validation failed for argument \[0\] in public ... ”

如下图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hlbGxvX1dvcmxkX1FXUA_size_16_color_FFFFFF_t_70][]

具体信息如下：

org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public ... arguments []; default message [remark],500,0]; default message [备注内容过长]] 
    	at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.resolveArgument(RequestResponseBodyMethodProcessor.java:139)
    	at org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:121)
    	at org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:170)
    	at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:137)
    	at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:106)
    	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:894)
    	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808)
    	at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
    	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1060)
    	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:962)
    	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
    	at org.springframework.web.servlet.FrameworkServlet.doPut(FrameworkServlet.java:920)
    	at javax.servlet.http.HttpServlet.service(HttpServlet.java:655)
    	at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)
    	at javax.servlet.http.HttpServlet.service(HttpServlet.java:733)
    	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:227)
    	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    	at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)
    	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
    	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    	at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
    	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
    	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
    	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    	at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
    	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
    	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
    	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    	at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
    	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
    	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
    	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    	at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:202)
    	at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:97)
    	at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:542)
    	at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:143)
    	at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)
    	at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:78)
    	at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:346)
    	at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:374)
    	at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)
    	at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:887)
    	at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1684)
    	at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
    	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
    	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
    	at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
    	at java.lang.Thread.run(Thread.java:748)

> ### 解决办法 ###

经过排查，发现是validation使用不当导致的，  
先看错误的写法：

/**
         * Description:[通过实体添加新的员工数据]
         *
         * @param EmployeeDTO [员工实体信息]
         * @return JSONResult
         * @date 2021-04-22
         * @author huazai
         */
        @PostMapping("/addEmployee")
        @ApiOperation(value = "/addEmployee", notes = "通过实体添加新的员工数据")
        public JSONResult addEmployee(@Valid @RequestBody @ApiParam(name = "EmployeeDTO", value = "EmployeeDTO 实体类") EmployeeDTO employeeDTO) {
            try {
                // 验证员工信息是否重复
                if (EmployeeService.validateInsertEmployeeRepeat(employeeDTO)) {
    
                    return JSONResult.failure(ResultCodeEnum.Failure.getCode(), Constant.MESSAGE_REPEAT_VALIDATE);
                }
                this.EmployeeService.insertEmployee(employeeDTO);
            } catch (AppException e) {
                log.info("异常信息:{}", e);
                return JSONResult.failure(ResultCodeEnum.Failure.getCode(), e.getMessage());
            }
            return JSONResult.success();
        }

在Controller控制层进行入参校验时，需要注意的是@Valid 和 BindingResult 是一一对应的，

如果有多个 @Valid，那么每个 @Valid 后面都必须添加一个 BindingResult 对象用来接收Bean中校验返回的消息，  
只有@Valid，而没有BindingResult来接受实体Bean校验完成后的消息，按正常情况下Bean中的字段完全校验通过，则不会出现程序错误，否则就会程序报错 “ Validation failed for argument \[0\]  ”，

修改正确后：

/**
         * Description:[通过实体添加新的员工数据]
         *
         * @param EmployeeDTO [员工实体信息]
         * @return JSONResult
         * @date 2021-04-22
         * @author huazai
         */
        @PostMapping("/addEmployee")
        @ApiOperation(value = "/addEmployee", notes = "通过实体添加新的员工数据")
        public JSONResult addEmployee(@Valid @RequestBody @ApiParam(name = "EmployeeDTO", value = "EmployeeDTO 实体类") EmployeeDTO employeeDTO, BindingResult bindingResult ) {
            try {
                // 字段校验
                if (bindingResult.hasErrors()) {
    
                    return JSONResult.failure(bindingResult);
                }
                // 验证员工信息是否重复
                if (EmployeeService.validateInsertEmployeeRepeat(employeeDTO)) {
    
                    return JSONResult.failure(ResultCodeEnum.Failure.getCode(), Constant.MESSAGE_REPEAT_VALIDATE);
                }
                this.EmployeeService.insertEmployee(employeeDTO);
            } catch (AppException e) {
                log.info("异常信息:{}", e);
                return JSONResult.failure(ResultCodeEnum.Failure.getCode(), e.getMessage());
            }
            return JSONResult.success();
        }

关于这个问题，除了开发人员自身的测试外，还需要测试人员的边界值测试就起到了格外重要的作用咯，如果等到上线后才发现这种问题，那你的体制就真的太弱鸡了！所以我们需要细心！细心！细心！再细心！！！

关于详细Spring Boot的实体字段校验请查看：

【[Java实体字段校验，@Valid BindingResult实现接口入参自动检验，Spring Boot中validation.constraints注解详解及快速应用实践][Java_Valid BindingResult_Spring Boot_validation.constraints]】

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

好了，关于 Validation failed for argument \[0\] 参数校验失败的解决办法  就写到这儿了，如果还有什么疑问或遇到什么问题欢迎扫码提问，也可以给我留言哦，我会一一详细的解答的。   
歇后语：“ 共同学习，共同进步 ”，也希望大家多多关注CSND的IT社区。

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

<table> 
 <tbody> 
  <tr> 
   <td>作&nbsp; &nbsp; &nbsp; &nbsp;者：</td> 
   <td>华 &nbsp; &nbsp;仔</td> 
  </tr> 
  <tr> 
   <td>联系作者：</td> 
   <td>who.seek.me@java98k.vip</td> 
  </tr> 
  <tr> 
   <td>来&nbsp; &nbsp; &nbsp; &nbsp; 源：</td> 
   <td>CSDN (Chinese Software Developer Network)</td> 
  </tr> 
  <tr> 
   <td>原&nbsp; &nbsp; &nbsp; &nbsp; 文：</td> 
   <td><a href="https://blog.csdn.net/Hello_World_QWP/article/details/116119817" rel="nofollow">https://blog.csdn.net/Hello_World_QWP/article/details/116119817</a></td> 
  </tr> 
  <tr> 
   <td>版权声明：</td> 
   <td>本文为博主原创文章，请在转载时务必注明博文出处！</td> 
  </tr> 
 </tbody> 
</table>

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hlbGxvX1dvcmxkX1FXUA_size_16_color_FFFFFF_t_70]: /images/20221022/03ae1c2373c744b6a9e31a577f819c5e.png
[Java_Valid BindingResult_Spring Boot_validation.constraints]: https://blog.csdn.net/Hello_World_QWP/article/details/116129788