spring spring-boot @valid @NotNull @NotEmpty 基本校验使用以及 全局异常优化集成
创始人
2024-05-27 13:24:36
0

@valid @NotNull @NotEmpty

一套标准的基础校验,可以将校验注解和附带错误信息添加到请求入参上即可完成校验,可以去除简单的校验代码,节省一定的时间和代码量

Maven 依赖

  1. spring-boot
org.springframework.bootspring-boot-starter-validation

或直接使用以下即可,web 已包含

org.springframework.bootspring-boot-starter-web2.0.5.RELEASE

都有也无所谓 只有一个第一个加载的生效

  1. spring
javax.validationvalidation-api1.1.0.Final
org.hibernatehibernate-validator5.4.1.Final

实际使用

定义示例 controller
在这里插入图片描述
这里的 @valid 说明后面定义的实体需要进入校验,必须要加,否则实体内定义了校验注解不会生效

实体定义

import org.hibernate.validator.constraints.Range;import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;@Data
public class TestParams {@NotNull(message = "名称不能为空")private String name;@NotEmpty(message = "id 不能为空")private String idCard;@Min(value = 10, message = "最低不能低于10")private Integer number;@Max(value = 20, message = "最高不能高于20")private int maxNum;@Range(message = "区间只能位于{min}到{max}", min = 2, max = 12)private int rangeArea;}

@NotNull 不能为null但是可以为空
@NotEmpty 不能为空也不能为null
@Min 最小值
@Max 最大值
@Range 区间

通过上面的配置可以省去类似如下代码:
在这里插入图片描述

实际请求测试

{"name":"nnnnmamim","number":10,"maxNum":10,"rangeArea":3
}

返回的错误内容:
在这里插入图片描述
显然这样的内容是不可读的,需要整理

第一步可以如下修改添加
在这里插入图片描述
来源包
import org.springframework.validation.BindingResult;

结果如下:(这里我直接把错误返回了 实际应该将错误信息放到我们的返回体里面)
在这里插入图片描述
显然完成了校验

但是这样的处理未免太过麻烦,可以做全局异常捕获处理,但是我们要先知道这一类异常的类型才行

这种异常的异常类型如下:
MethodArgumentNotValidException
来源包:
import org.springframework.web.bind.MethodArgumentNotValidException;

具体捕捉可以如下:
spring-boot 中的全局异常处理:

import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {@ResponseBody@ExceptionHandler(value = MethodArgumentNotValidException.class)public Response handleValidException(HttpServletRequest request, MethodArgumentNotValidException e) {BindingResult bindingResult = e.getBindingResult();StringBuilder message = new StringBuilder();if (bindingResult.hasErrors()) {List allErrors = bindingResult.getAllErrors();for (ObjectError allError : allErrors) {message.append(allError.getDefaultMessage()).append(", ");}}return Response.failMessage(message.toString());}}

@ControllerAdvice
为对controller 的增强代码
@ResponseBody
json 返回体
@ExceptionHandler
指定不同异常类型的处理方式 针对不同的异常上面的特殊处理可以有多个

其中的 Response 为我自己定义的接口返回对象,Response.failMessage 会将失败信息放到的对象 message 属性中一并返回

最终测试结果:
在这里插入图片描述
此时在 Controller 中如下,其他不变 入参将不再需要 BindingResult
在这里插入图片描述

在 spring 以及 springMVC 中的另一种全局异常可以如下参考:
定义某一个类 实现接口 HandlerExceptionResolver 方法 resolveException

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;@Slf4j
@Component
public class MyGlobalExceptionResolver implements HandlerExceptionResolver {@Overridepublic ModelAndView resolveException(HttpServletRequest request,HttpServletResponse response, Object handler, Exception ex) {log.error("全局异常", ex);ModelAndView modelAndView = new ModelAndView();// 转换异常if(ex instanceof MethodArgumentNotValidException) {modelAndView.setStatus(HttpStatus.OK);modelAndView.addObject("message", ex.getMessage());} else {// 其他所有异常modelAndView.setStatus(HttpStatus.INTERNAL_SERVER_ERROR);modelAndView.addObject("code", HttpStatus.INTERNAL_SERVER_ERROR);modelAndView.addObject("message", ex.getMessage());}response.setHeader("content-type", "application/json;charset=UTF-8");return modelAndView;}
}

相关内容

热门资讯

【NI Multisim 14...   目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
AWSECS:访问外部网络时出... 如果您在AWS ECS中部署了应用程序,并且该应用程序需要访问外部网络,但是无法正常访问,可能是因为...
Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限:此外...
北信源内网安全管理卸载 北信源内网安全管理是一款网络安全管理软件,主要用于保护内网安全。在日常使用过程中,卸载该软件是一种常...
AWSElasticBeans... 在Dockerfile中手动配置nginx反向代理。例如,在Dockerfile中添加以下代码:FR...
AsusVivobook无法开... 首先,我们可以尝试重置BIOS(Basic Input/Output System)来解决这个问题。...
ASM贪吃蛇游戏-解决错误的问... 要解决ASM贪吃蛇游戏中的错误问题,你可以按照以下步骤进行:首先,确定错误的具体表现和问题所在。在贪...
月入8000+的steam搬砖... 大家好,我是阿阳 今天要给大家介绍的是 steam 游戏搬砖项目,目前...