Spring Boot电商项目24：商品分类模块三：使用【@Valid注解】校验入参；（重点是：处理MethodArgumentNotValidException异常的信息，构建API统一返回对象）

最新推荐文章于 2024-07-20 11:29:20 发布
最新推荐文章于 2024-07-20 11:29:20 发布
阅读量2.9k 收藏 14
点赞数 10
分类专栏： （19）Spring Boot电商项目 文章标签： spring boot 分类 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/csucsgoat/article/details/123081711
版权

说明：

（1）本篇博客的逻辑：

          ● 为什么写本篇博客？：在【Spring Boot电商项目23：商品分类模块二：【增加目录分类】接口；（接收请求中的、放在body中的参数时候，使用了@RequestBody；）】中，Controller处接收参数的时候，当我们通过AddCategoryReq这个bean接收到参数后，我们需要校验下参数是否为空；在这篇博客中，我们采用笨笨的方式去校验；

显然，在多时候我们都需要进行参数校验；比如上面的非空检验等；而，为了能够更加优雅的实现参数校验，于是就引出了本篇博客介绍的@Valid注解；

          ● 但是，在使用@Valid注解时候，引入的一个新问题：但是，在使用@Valid参数校验时候，如果校验失败，其引发的异常是【MethodArgumentNotValidException异常】；但是，我们在GlobalExceptionHandler中并没有特别处理这种异常（而是用Exception这种粗粒度的方式，去处理了），所以就出现了返回信息太宽泛，没有反映出具体错误信息的情况；

          ● 解决策略（这也是本篇博客重难点）：在GlobalExceptionHandler编写对应的方法去处理【MethodArgumentNotValidException异常】，以能根据【MethodArgumentNotValidException异常的具体错误信息】去构建对应的APIRestResponse统一返回对象 ；（这其中涉及到了如【getBindingResult()】、【BindingResult.hasErrors()】、【BindingResult.getAllErrors()】、【objectError.getDefaultMessage()】等与Validation校验异常相关的方法）

目录

一：参数校验的注解：【@Valid】，【@NotNull，@Max(value)，@Size(max,min)】：简述；

二：参数校验的注解：【@Valid】，【@NotNULL，@Max(value)，@Size(max,min)】：案例演示；

1.【@Valid】，【@NotNULL，@Max(value)，@Size(max,min)】：使用案例；

2.启动项目，实测；以及引出新的问题（参数校验引发的【MethodArgumentNotValidException异常】没有去单独处理）；

（1）测试结果：参数校验生效了；

（2）仍存问题：系统异常处理粒度太大：没有去单独处理参数校验引发的【MethodArgumentNotValidException异常】；

三：在【GlobalExceptionHandler】中，去处理【MethodArgumentNotValidException异常】：根据该异常的具体信息，去构建ApiRestResponse统一返回对象；

1.思路梳理；

2.在【GlobalExceptionHandler】中，去处理【MethodArgumentNotValidException异常】：根据该异常的具体信息，去构建ApiRestResponse统一返回对象；（重难点！）

（1）方法说明：拦截【MethodArgumentNotValidException异常】，打印日志，去构建ApiRestResponse统一返回对象；

（2）【getBindingResult()】说明（不准确，可能存在错误）；

（3）【BindingResult】：这是个接口；

（4）【BindingResult.hasErrors()】：bindingResult.hasErrors()是为了验证@Validated后面bean 里是否有不符合校验条件的错误信息；

（5）【BindingResult.getAllErrors()】（方法返回值类型是【List】）：获取参数校验时的，所有错误；

（6）【ObjectError】：可以理解为是一个【封装了Validation校验错误】的对象；（理解，可能不准确……） 

（7）【getDefaultMessage()】：获取错误的具体信息；

（8）方法说明：提取错误信息，将其添加到一个List集合中；

（9）方法说明：根据从【MethodArgumentNotValidException异常】中，提取的具体错误信息，构建ApiRestResponse统一返回对象； 

3.启动项目，观察效果；

（1）效果；

（2）完善：设置为空时，具体的信息：@NotNull(message="***不能为空")；

四：Summary：

1.当我们在GlobalExceptionHandler中，书写了这个【处理MethodArgumentNotValidException异常的逻辑】后；；；；我们在需要参数校验的地方，就可以放心大胆的去使用Validation参数校验去校验参数了；

2.额外的补充说明： （这儿的总结还是比较重要的）

一：参数校验的注解：【@Valid】，【@NotNull，@Max(value)，@Size(max,min)】：简述；

说明：

（1）如果我们在Controller处，给某个入参添加上@Valid注解，就表示这个入参需要校验；@Valid注解就像一个开关一样，用了这个注解就表示开启校验，不用这个注解就表示不用校验；

（2）@NotNULL，@Max(value)，@Size(max,min)表示了校验规则；可以根据校验需求，在对应的属性上，使用这些注解；

（3）单纯看这些描述，可能云里雾里；具体，看下下面的案例；

 

二：参数校验的注解：【@Valid】，【@NotNULL，@Max(value)，@Size(max,min)】：案例演示；

1.【@Valid】，【@NotNULL，@Max(value)，@Size(max,min)】：使用案例；

说明：

（1）Spring Boot2.3版本将不再内部依赖validator；所以对于2.3以后的版本，如果还想使用@Valid参数校验，需要自己先手动引入validator依赖。

2.启动项目，实测；以及引出新的问题（参数校验引发的【MethodArgumentNotValidException异常】没有去单独处理）；

（1）测试结果：参数校验生效了；

看下控制台的异常日志信息：

org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [1] in public com.imooc.mall.common.ApiRestResponse com.imooc.mall.controller.CategoryController.addCategory(javax.servlet.http.HttpSession,com.imooc.mall.model.request.AddCategoryReq): [Field error in object 'addCategoryReq' on field 'name': rejected value [测试类别1额方法地方]; codes [Size.addCategoryReq.name,Size.name,Size.java.lang.String,Size]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [addCategoryReq.name,name]; arguments []; default message [name],5,2]; default message [个数必须在2和5之间]] 
	at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.resolveArgument(RequestResponseBodyMethodProcessor.java:139) ~[spring-webmvc-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:121) ~[spring-web-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:167) ~[spring-web-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:134) ~[spring-web-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:106) ~[spring-webmvc-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:888) ~[spring-webmvc-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:793) ~[spring-webmvc-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87) ~[spring-webmvc-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1040) [spring-webmvc-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:943) [spring-webmvc-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006) [spring-webmvc-5.2.1.RELEASE.jar:5.2.1.RELEASE]
	at org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909) [spring-webmvc-5.2.1.RELEASE.jar:5.2.1.RELEASE]

日志信息，很明确：

至此，说明参数校验已经生效了；

……………………………………………………

（2）仍存问题：系统异常处理粒度太大：没有去单独处理参数校验引发的【MethodArgumentNotValidException异常】；

但是，还有个问题：上面出现了错误后，详细的提示信息只出现在了日志中，我们程序员是可以看到的；但是，我们这个商城的用户却不能知道具体的错误原因，商城的用户只能得到“系统异常”这个笼统的错误信息；

最低0.47元/天 解锁文章
小懒羊爱吃草
关注
  • 10
    点赞
  • 踩
  • 14
    收藏
    觉得还不错? 一键收藏
  • 9
    评论
专栏目录
项目经验：org.springframework.web.bind.MethodArgumentNotValidException，因版本升级导致Hibernate-validation校验出现报错
m0_37354578的博客
02-04 1623
项目背景：因客户需求，公司产品需要升级Springboot版本。项目在未执行maven clean install之前，Eclipse启动项目插入数据时不报错。执行maven clean install后，启动项目插入数据时报错。 错误信息如下： org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public T org.gocom.coframe.co
没想到你是这样的MethodArgumentNotValidException
热门推荐
chengliqu4475的博客
05-20 2万+
事情要从校验入参属性说起，如果入参有几十个需要校验非空，如果写一堆的ifelse岂不难受，这时候我们就可以借鉴hibernate-validatorhibernate-validator框架来校验参数的非空性。 首先我们添加如下依赖： <!-- https://mvnreposito...
MethodArgumentNotValidException（方法参数验证异常）可能的原因和解决方法
Java开源程序猿
12-30 5101
进行方法参数验证时，参数验证失败。在使用 Spring Boot 时，可能由于自动配置或者属性配置的问题导致验证失败。如果使用了特定版本的验证框架，可能会存在与其他组件不兼容的问题。使用自定义验证注解时，自定义验证逻辑未通过导致验证失败。当验证日期类型的参数时，传递的日期字符串格式不符合预期。当传递的参数是一个对象时，对象的属性未通过验证。当使用分组验证时，传递的参数未指定正确的验证组。如果选择的验证注解不符合验证的需求，可能导致。传递的数据结构与方法参数的期望结构不匹配。如果方法参数有多个验证失败，
【前后端联调】MethodArgumentNotValidException
最新发布
无人罪的博客
07-20 411
【代码】【前后端联调】MethodArgumentNotValidException。
Springboot捕获全局异常：MethodArgumentNotValidException
weixin_44021888的博客
12-30 1万+
Springboot捕获全局异常：MethodArgumentNotValidException 控制器 方法上添加@Valid注解 @PostMapping("/update") @RequiresPermissions("user:update") public R update(@RequestBody @Valid UserEntity user) { userService.update(user); return R.ok(); }
MethodArgumentNotValidException 与 ConstraintViolationException
weixin_42206151的博客
11-22 1692
当使用注解进行参数校验时，如果参数违反了约束条件（例如，@NotNull、@Size、@Pattern等），就会抛出 ConstraintViolationException 异常。MethodArgumentNotValidException 和ConstraintViolationException 都是用于处理参数校验异常的异常类，但它们在不同的上下文中使用。- 通常，该异常是在控制器（Controller）中接收到请求参数后发生的，它包含了关于哪个参数违反了约束条件以及相应的错误消息。
MethodArgumentNotValidException
weixin_45822542的博客
06-24 503
通过使用验证注解、控制器中的异常处理方法或全局异常处理器，有效地捕获和处理验证错误，并向客户端返回友好的错误信息。通常在使用 Spring MVC 或 Spring Boot 时，当请求体中的数据未通过验证注解（如。假设你有一个 REST 控制器，它接收一个包含验证注解的对象作为请求体。等）的检查时，会抛出此异常。字段的长度小于 2 个字符，是 Spring 框架中。
Spring Boot技术知识点：如何使用@Valid注解来对邮箱字段进行数据校验
07-04
总结来说，`@Valid`注解在Spring Boot中的作用是帮助我们进行数据校验，确保入参的正确性。结合其他验证注解，如`@Email`，可以有效地防止非法数据进入系统，提高应用的健壮性和用户体验。同时，我们还可以通过...
springboot @Valid注解对嵌套类型的校验功能
08-27
1. @Valid 注解的使用：@Valid 注解可以实现数据的验证，你可以定义实体，在实体的属性上添加校验规则，而在 API 接收数据时添加 @Valid 关键字，这时你的实体将会开启一个校验的功能。 2. 嵌套类型的校验：在嵌套...
Spring Boot电商项目23：商品分类模块二：【增加目录分类】接口；（接收请求中的、放在body中的参数时候，使用了@RequestBody；）
小枯林的博客
02-23 1585
说明： （1）本篇博客需要注意的点： ●对于SpringBoot来说，POST请求时，更建议使用【@RequestBody实体类】的方式，去接收参数；（这一点还有不清晰的地方，需要回来修正）；（是不是如果请求参数很多的时候，参数就尽量不要放在url后面，否则的话会很长；更好的做法就是，把参数通过JSON的方式，放在body中；；；那么，与此对应，Controller就需要使用@RequestBody来接收参数） ● 【承接数据表的实体类】和【接收参数的实...
Spring Boot电商项目33：商品模块二：【增加商品】接口；
小枯林的博客
03-04 2178
说明： （1）
springboot 之 BindException、MethodArgumentNotValidException和ConstraintViolationException
enjoy.day
03-01 693
BindException、MethodArgumentNotValidException、ConstraintViolationExceptio
已解决Customize the response for MethodArgumentNotValidException方法参数无效异常的正确解决方法，亲测有效！！！
小明的Java问道之路
03-02 1554
已解决Customize the response for MethodArgumentNotValidException方法参数无效异常的正确解决方法，亲测有效！！！
BindException、ConstraintViolationException、MethodArgumentNotValidException入参验证异常分析和全局异常处理解决方法
qq_43409401的博客
04-22 1万+
Spring validation验证框架注解 Spring validation验证框架提供了大量接口入参检验注解，注意三个非空注解： @NotNull：验证对象是否不为null, 无法查检长度为0的字符串 @NotBlank：检查约束 (字符串) 是不是Null还有被Trim的长度是否大于0，只对字符串,且会去掉前后空格 @NotEmpty：检查(集合)约束元素是否为NULL或者是EMPTY @Size(min=,max=)：验证对象（Array,Collection,Map,String）长度是否在
自定义MethodArgumentNotValidException报错返回信息
Ambi的博客
08-29 2768
自定义MethodArgumentNotValidException报错返回信息
Spring Boot 统一处理参数校验结果异常@Valid BindException MethodArgumentNotValidException
weixin_40924420的博客
08-31 2972
Spring Boot 统一处理参数校验结果异常@Valid BindException MethodArgumentNotValidException 使用@ControllerAdvice统一处理参数校验的结果 如果你使用了@RequestBody @Valid 来封装参数并校验，这个时候这个异常处理器又不起作用了，需要再添加一个异常处理器 import lombok.extern.slf4j.Slf4j; import org.springframework.validation.BindExcept
org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in
扎哇太枣糕的笔记博客
12-14 2341
🌆 内容速览🌕 问题分析🌕 我的代码🌕 解决办法 🌕 问题分析   在开发的过程中需要对前端传过来的值进行各种校验，为了简单操作选择了spring自带的@Validated配合其他规则校验注解，但是在运行的时候却报了MethodArgumentNotValidException异常。   下面的报错信息的大致意思就是，参数接收类中的参数校验失败，按理说我们在参数接收类的参数字段上使用规则校验注解，然后在controller的接口参数上使用@Validated的话，这些不符合校验条件的失败message就
ConstraintValidator自定义校验注解+MethodArgumentNotValidException异常全局捕获
varersat的博客
09-20 727
重要参数：@Constraint(validatedBy = {EmailValidator.class })：表示检验逻辑使用EmailValidator这个类，下面会放这个类代码@Target({FIELD, PARAMETER})：表明此注解可以用在属性和参数上String message() ：校验生效时，返回的错误信息Class<?>[] groups() ：可以指定在哪个环境下注解生效（一般不填）注意：缺少这三个属性会报错。
spring boot3 @Valid注解失效
06-11
@Valid注解是用于数据校验的，可以在Spring Boot中轻松地进行数据校验。如果@Valid注解失效，可能是以下原因之一： 1. 未在启动类中添加@Validated注解 在Spring Boot中，需要在启动类上添加@Validated注解以启用参数校验。如果未添加该注解，则@Valid注解将无法生效。 2. 未在Controller的方法中添加@Valid注解 在Controller中的方法参数上添加@Valid注解以启用参数校验。如果未添加该注解，则@Valid注解将无法生效。 3. 未在实体类的字段上添加校验注解 @Valid注解只是一个容器，需要在实体类的字段上添加校验注解才能真正进行数据校验。 4. 未正确引入相关依赖 如果未正确引入相关依赖，如hibernate-validator，则@Valid注解将无法生效。 希望这些解决方法能帮助你解决@Valid注解失效的问题。
评论 9
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值