java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > spring validation参数及全局异常检测

spring使用validation参数及全局异常检测方式

作者：jforgame

本文主要介绍了Java的数据校验规范validation-api,包括其定义的注解和HibernateValidator的实现,还介绍了spring-boot-starter-validation的使用,可以让开发者在SpringBoot应用中简化数据校验的功能

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用于校验字符串的值是否符合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.异常拦截方法有以下几个注意地方

2.3.使用案例

使用全局异常拦截器，重新发起请求，可以看到客户端输出：

{
  "success": false,
  "message": 1003, //I18nConstants.COMMON_ILLEGAL_PARAMS
  "data": null
}

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:
阅读全文