spring使用validation参数及全局异常检测方式
1.validation参数验证工具
1.1.validation-api技术链
validation-api是一个Java的数据校验规范，它定义了一套用于校验Java Bean的API。它是JSR 303规范的一部分，也被称为Bean Validation。validation-api提供了一系列的注解，用于在Java类的字段、方法参数和方法返回值上添加校验规则。这些注解包括@NotNull、@Size、@Min、@Max等等，每个注解都有特定的校验规则，用于验证数据是否满足特定的条件。
Hibernate Validator是validation-api的唯一实现。除了提供注解和校验规则，Hibernate Validator还提供了一系列的工具类和接口，用于处理校验结果和错误信息。它可以将校验结果封装为一个Validator对象，并提供了各种方法来获取校验结果、错误信息和错误类型。Hibernate Validator还支持国际化，可以根据不同的语言环境显示相应的错误信息。它还提供了可自定义的错误消息模板，可以根据实际需求来设置错误消息的格式和内容。
spring-boot-starter-validation是一个Spring Boot的starter，用于集成和简化Spring框架中的数据校验功能。spring-boot-starter-validation通过自动配置的方式，将Hibernate Validator集成到了Spring Boot的应用中，从而简化了数据校验的配置过程。通过引入这个starter，我们可以在应用中使用标准的注解来进行数据校验，而不需要手动配置和引入相关的依赖项。
1.2.validation常用注解
validation-api提供了一些常用的注解
| @NotNull | 用于校验字段或方法参数的值不能为空 |
| @NotEmpty | 用于校验字符串、集合或数组的值不能为空，且长度不能为0 |
| @NotBlank | 用于校验字符串的值不能为空或只包含空格 |
| @Size | 用于校验字符串、集合或数组的长度是否在指定范围内 |
| @Min | 用于校验数字的值是否大于等于指定的最小值 |
| @Pattern | 用于校验字符串的值是否匹配指定的正则表达式 |
| 用于校验字符串的值是否符合Email格式 | |
| @DecimalMin | 用于校验数字的值是否大于等于指定的最小值，可以指定最小值的精度 |
Hibernate Validator 提供了一些拓展注解，用于在 validation-api 注解基础上实现更复杂的数据校验。
以下是一些常见的 Hibernate Validator 拓展注解（部分）
| @URL | 用于校验字符串的值是否符合 URL 地址格式 |
| @CreditCardNumber | 用于校验信用卡号的格式是否正确 |
| @Currency | 用于校验货币代码是否正确 |
| @ISBN | 用于校验国际标准书号（ISBN）是否正确 |
| @Range | 用于校验数字的值是否在指定范围内 |
1.3.代码示例
对于一个请求参数，根据需求进行注解申明
import jakarta.validation.constraints.DecimalMax;
import jakarta.validation.constraints.DecimalMin;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.Size;
import lombok.Data;
@Data
public class ReqCreateCatalog {
@NotEmpty
private String gameId;
@DecimalMin(value = "1")
@DecimalMax(value = "2")
private int type;
//目标目录
@Size(max = 50, message = "名称长度不能超过{max}个字符")
private String catalog;
}controller方法参数增加@Valid注解
@PostMapping(value = "/createCatalog")
public Response create(@Valid @RequestBody ReqCreateCatalog req) {
}如果请求故意把gameId参数设为空，
则程序输出异常日志
2. 全局异常处理器
2.1.使用@RestControllerAdvice拦截异常
上面的例子可以看出，当验证器抛出MethodArgumentNotValidException异常，如果没有一个全局异常捕获器对其进行捕获并进行转义，前端得到的响应很奇怪。
SpringMVC使用@RestControllerAdvice注解对全局异常进行拦截，例如下面的代码
（也可以使用@ControllerAdvice注解，但每个方法还需要添加@ResponseBody注解）
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
public Response<Object> handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址'{}',参数校验失败'{}'", requestURI, e.getMessage());
return Response.fail(I18nConstants.COMMON_ILLEGAL_PARAMS);
}
@ExceptionHandler(BusinessRequestException.class)
public Response<Object> handleBusinessRequestException(BusinessRequestException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址'{}',权限码校验失败'{}'", requestURI, e.getMessage());
return Response.fail(e.getErrorCode());
}
@ExceptionHandler(value = Exception.class)
public Response<Object> handleException(Exception e, HttpServletRequest request) {
LoggerUtil.error("", e);
return Response.fail(I18nConstants.COMMON_INTERNAL_ERROR);
}
}2.2.异常拦截方法有以下几个注意地方
- 方法名必须以handle开头；
- 需要添加@ExceptionHandler注解，注解的值是一个异常类数组，当value为空，则默认取方法的异常参数类型；
- 当程序触发了一个异常，如果在全局异常拦截器找不到映射，则会递归找它的父异常，则到父类Throwalbe为止；
- 如果多个@RestControllerAdvice示例绑定了同一个异常，程序不会报错，但只有一个拦截器起作用。
2.3.使用案例
使用全局异常拦截器，重新发起请求，可以看到客户端输出：
{
"success": false,
"message": 1003, //I18nConstants.COMMON_ILLEGAL_PARAMS
"data": null
}总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
对主表（采购申请表）和明细表（申请物资表）同时进行插入操作insert，怎么实现呢，下面给大家分享mybatis主表与明细表一对多的同时插入操作方法，感兴趣的朋友一起看看吧2023-02-02
这篇文章主要介绍了SpringBoot实现发送邮件、发送微信公众号推送功能,这里对成员变量JavaMailSender使用了@Resource注解，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2022-03-03
IDEA导入Springboot项目,注解和pom文件不识别的解决
这篇文章主要介绍了IDEA导入Springboot项目,注解和pom文件不识别的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-04-04
springboot后端配置多个数据源、Mysql数据库的便捷方法
实现springboot 后端配置多个数据源、Mysql数据库，只需要新建 Mapper、实体类 相应的文件夹，将不同数据源的文件保存到对应的文件夹下，添加绑定数据库配置Config，就可以轻松完成2021-08-08
这篇文章主要介绍了使用Zookeeper实现分布式锁，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-10-10
本文介绍了Spring事务的基础概念、实现方式、核心注解配置、隔离级别和传播机制,并通过实际场景详细解析了事务传播机制的7种行为,感兴趣的朋友跟随小编一起看看吧2026-04-04
为了更好地组织类，Java 提供了包机制，用于区别类名的命名空间，一个包（package）可以定义为一组相互联系的类型（类、接口、枚举和注释），为这些类型提供访问保护和命名空间管理的功能2022-03-03
Springboot @Value注入boolean设置默认值方式
这篇文章主要介绍了Springboot @Value注入boolean设置默认值方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-03-03
本篇文章是关于ava构造方法Vector源码分析系列文章，本文主要介绍了Vector遍历元素的源码分析，有需要的朋友可以借鉴参考下，希望可以有所帮助2021-09-09
这篇文章主要介绍了Android 资源 id详解及的动态获取的相关资料,需要的朋友可以参考下2016-12-12
最新评论