springboot validation参数校验

最新推荐文章于 2024-08-05 08:51:23 发布
最新推荐文章于 2024-08-05 08:51:23 发布
阅读量863 收藏 2
点赞数
原文链接：https://cloud.tencent.com/developer/article/1493507
版权

springboot validation参数校验

Bean Validation 为 JavaBean 验证定义了相应的元数据模型和 API。缺省的元数据是 Java Annotations，通过使用 XML 可以对原有的元数据信息进行覆盖和扩展。在应用程序中，通过使用 Bean Validation 或是你自己定义的 constraint，例如 @NotNull, @Max, @ZipCode， 就可以确保数据模型（JavaBean）的正确性。constraint 可以附加到字段，getter 方法，类或者接口上面。对于一些特定的需求，用户可以很容易的开发定制化的 constraint。Bean Validation 是一个运行时的数据验证框架，在验证之后验证的错误信息会被马上返回。

常规使用方式

1.引入pom

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>

其中在spring-boot-starter-web中有hibernate-validater的依赖。

  1. 在bean上直接使用注解:
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class Medicine implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 主键
     */
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    /**
     * 序号，药品编号
     */
    private Long medicineCode;

    /**
     * 简码
     */
    @NotBlank(message = "拼音简码不能为空")
    private String simpleCode;

    /**
     * 条码
     */
    @NotBlank(message = "商品条码不能为空")
    private String tiaoCode;

    /**
     * 药品名称
     */
    @NotBlank(message = "药品名称不能为空")
    private String medicineName;

    /**
     * 剂型
     */
    @NotBlank(message = "剂型不能为空")
    private String jxType;

    /**
     * 通用名
     */
    private String commonName;

    /**
     * 规格
     */
    private String guiType;

    /**
     * 生产厂家
     */
    private String productor;

    /**
     * 批准文号
     */
    private String permitCode;

    /**
     * 包装单位
     */
    @NotBlank(message = "包装单位不能为空")
    private String wrapUnit;

    /**
     * 最小单位
     */
    @NotBlank(message = "最小单位不能为空")
    private String minUnit;
  1. 在controller中添加@Valid注解
@PostMapping(value = "/save")
    @RequiresPermissions("medic:add")
    @AddSysLog(descrption = "保存药品信息")
    @LoginedUser
    @ApiOperation(value = "保存药品信息",notes = "新增药品相关接口")
    public R save(@CurrentUser@ApiIgnore SysUser sysUser, @RequestBody @Valid Medicine medicine) {
  1. 普通的String 类型的
@PostMapping(value = "/save")
    @RequiresPermissions("medic:add")
    @AddSysLog(descrption = "查询药品相关接口")
    @LoginedUser
    @ApiOperation(value = "查询药品相关接口",notes = "查询药品相关接口")
    public R queryByName(@CurrentUser@ApiIgnore SysUser sysUser, @NotNull(message = "查询条件不能为空") String medicineName) {
  1. 如需要国际化
@PostMapping(value = "/save")
    @RequiresPermissions("medic:add")
    @AddSysLog(descrption = "查询药品相关接口")
    @LoginedUser
    @ApiOperation(value = "查询药品相关接口",notes = "查询药品相关接口")
    public R queryByName(@CurrentUser@ApiIgnore SysUser sysUser, @NotNull(message = "medicine.message.notnull") String medicineName) {

在messagezhCN.properties中

medicine.message.notnull=药品名称不能为空

在messageenUS.properties中

medicine.message.notnull=medicine name can not be null
  1. 默认使用spring validator如使用hibernate validator:
@Configuration
public class ValidatorConfig {

    @Bean
    public Validator validator(){
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class).configure()
        .failFast(true).buildValidatorFactory();
        return validatorFactory.getValidator();
    }
}
  1. 异常统一捕获处理，省去每个@Valid后都跟着处理BindingResult
/**
     * 数据校验处理
     * @param e
     * @return
     */
    @ExceptionHandler({BindException.class, ConstraintViolationException.class})
    public String validatorExceptionHandler(Exception e) {
        String msg = e instanceof BindException ? msgConvertor(((BindException) e).getBindingResult())
                : msgConvertor(((ConstraintViolationException) e).getConstraintViolations());

        return msg;
    }

    /**
     * 参数不合法异常
     *
     * @param ex
     * @return
     * @Description
     * @author
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public R handleException(MethodArgumentNotValidException ex) {
        BindingResult a = ex.getBindingResult();
        List<ObjectError> list = a.getAllErrors();
        String errorMsg = ErrorEnum.PARAMETER_ERR.getErrorMsg();
        if (CollectionUtils.isNotEmpty(list)) {
            errorMsg = list.get(0).getDefaultMessage();
        }
        return R.error(ErrorEnum.PARAMETER_ERR.getErrorCode(),errorMsg);
    }
  1. spring validator分组处理 为什么要有分组这一说呢？因为，举个例子，添加的时候不需要校验id，而修改的时候id不能为空，有了分组以后，就可以添加的时候校验用组A，修改的时候校验用组B。 两个分组的接口，一个是添加的组，一个是修改的组:

在这里插入图片描述
在这里插入图片描述
实体类中:
在这里插入图片描述
controller中:

@PostMapping(value = "/update")
    @RequiresPermissions("medic:update")
    @AddSysLog(descrption = "修改药品信息")
    @ApiOperation(value = "修改药品信息",notes = "修改药品相关接口")
//    @ApiImplicitParams({
//            @ApiImplicitParam(name = "medicine", value = "药品json数据", required = true, paramType = "body", dataType = "medicine")})
    @LoginedUser
    public R update(@CurrentUser@ApiIgnore SysUser sysUser,@RequestBody @Validated(value = {MedicineGroupEdit.class}) Medicine medicine) {

见:https://docs.spring.io/spring/docs/5.0.5.RELEASE/spring-framework-reference/core.html#validation

9.hibernate validator自定义validator 见:https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#validator-customconstraints
自定义方法:

创建注解
在这里插入图片描述

  1. 创建validator
    在这里插入图片描述

使用方式 在需要校验的bean上添加:
在这里插入图片描述
注意点

JSR 303 – Bean Validation 规范 http://jcp.org/en/jsr/detail?id=303
Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。如果想了解更多有关 Hibernate Validator 的信息，请查看 http://www.hibernate.org/subprojects/validator.html
一个 constraint 通常由 annotation 和相应的 constraint validator 组成，它们是一对多的关系。也就是说可以有多个 constraint validator 对应一个 annotation。在运行时，Bean Validation 框架本身会根据被注释元素的类型来选择合适的 constraint validator 对数据进行验证
BindingResult必须跟在被校验参数之后,若被校验参数之后没有BindingResult对象，将会抛出BindException
不要使用 BindingResult 接收String等简单对象的错误信息(也没有特别的错，只是 result 是接不到值。)。简单对象校验失败，会抛出 ConstraintViolationException。
SpringMVC 在进行方法参数的注入(将 Http请求参数封装成方法所需的参数)时，不同的对象使用不同的解析器注入对象。注入实体对象时使用ModelAttributeMethodProcessor而注入 String 对象使用AbstractNamedValueMethodArgumentResolver。而正是这个差异导致了BindingResult无法接受到简单对象(简单的入参参数类型)的校验信息。

HandlerMethodArgumentResolverComposite#resolveArgument():

public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
            NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
        // 获取 parameter 参数的解析器
        HandlerMethodArgumentResolver resolver = getArgumentResolver(parameter);
        // 调用解析器获取参数
        return resolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory);
    }

    // 获取 parameter 参数的解析器
    private HandlerMethodArgumentResolver getArgumentResolver(MethodParameter parameter) {
        // 从缓存中获取参数对应的解析器
        HandlerMethodArgumentResolver result = this.argumentResolverCache.get(parameter);
        for (HandlerMethodArgumentResolver methodArgumentResolver : this.argumentResolvers) {
            // 解析器是否支持该参数类型
            if (methodArgumentResolver.supportsParameter(parameter)) {
                result = methodArgumentResolver;
                this.argumentResolverCache.put(parameter, result);
                break;
            }
        }
        return result;
    }

注入 String 参数时，在AbstractNamedValueMethodArgumentResolver#resolveArgument()中，不会抛出BindException/ConstraintViolationException异常、也不会将 BindingResult 传入到方法中。

抛出BindException的地方
注入对象时在ModelAttributeMethodProcessor#resolveArgument():154 行的 validateIfApplicable(binder, parameter)语句,进行了参数校验，校验不通过并且实体对象后不存在BindingResult对象，则会在this#resolveArgument():156抛出BindException。

public final Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
            NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {

        // bean 参数绑定和校验
        WebDataBinder binder = binderFactory.createBinder(webRequest, attribute, name);

        // 参数校验
        validateIfApplicable(binder, parameter);
        // 校验结果包含错误，并且该对象后不存在 BindingResult 对象，就抛出异常
        if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
            throw new BindException(binder.getBindingResult());
        }

        // 在对象后注入 BindingResult 对象
        Map<String, Object> bindingResultModel = bindingResult.getModel();
        mavContainer.removeAttributes(bindingResultModel);
        mavContainer.addAllAttributes(bindingResultModel);
    }

抛出ConstraintViolationException的地方
InvocableHandlerMethod#invokeForRequest()的doInvoke(args)方法中Mehtod.invoke() 对应的CglibAopProxy$CglibMethodInvocation的父类ReflectiveMethodInvocation，在 ReflectiveMethodInvocation#process()方法的最后一行：

return ((MethodInterceptor) interceptorOrInterceptionAdvice).invoke(this);

这里的 Methodnterceptor 接口的真身是 MethodValidationInterceptor:

public Object invoke(MethodInvocation invocation) throws Throwable {
        ExecutableValidator execVal = this.validator.forExecutables();
        // 校验参数
        try {
            result = execVal.validateParameters(
                    invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
        }
        catch (IllegalArgumentException ex) {
            // 解决参数错误异常、再次校验
            methodToValidate = BridgeMethodResolver.findBridgedMethod(
                    ClassUtils.getMostSpecificMethod(invocation.getMethod(), invocation.getThis().getClass()));
            result = execVal.validateParameters(
                    invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
        }
        if (!result.isEmpty()) {
            throw new ConstraintViolationException(result);
        }

        // 执行结果
        Object returnValue = invocation.proceed();

        // 校验返回值
        result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups);
        if (!result.isEmpty()) {
            throw new ConstraintViolationException(result);
        }

        return returnValue;
    }

关于MethodArgumentNotValidException异常的抛出
通常采取处理BindException：

@RestControllerAdvice
@Slf4j
public class ExceptionAdvice {

    @ExceptionHandler(BindException.class)
    public Object validExceptionHandler(BindException e){
        FieldError fieldError = e.getBindingResult().getFieldError();
        assert fieldError != null;
        log.error(fieldError.getField() + ":" + fieldError.getDefaultMessage());
        // 将错误的参数的详细信息封装到统一的返回实体
        ...
        return ...;
    }
}

但是, 如果你使用了@RequestBody @Valid 来封装参数并校验, 这个时候这个异常处理器又不起作用了，需要添加MethodArgumentNotValidException异常处理器:

@ExceptionHandler(MethodArgumentNotValidException.class)
     @ResponseBody
     public R handleException(MethodArgumentNotValidException ex) {
         BindingResult a = ex.getBindingResult();
         List<ObjectError> list = a.getAllErrors();
         String errorMsg = ErrorEnum.PARAMETER_ERR.getErrorMsg();
         if (CollectionUtils.isNotEmpty(list)) {
             errorMsg = list.get(0).getDefaultMessage();
         }
         return R.error(ErrorEnum.PARAMETER_ERR.getErrorCode(),errorMsg);
     }

原因见 https://github.com/spring-projects/spring-framework/issues/14790

These are actually intentionally different exceptions. @ModelAttribute, which is assumed by default if no other annotation is present, 
goes through data binding and validation, and raises BindException to indicate a failure with binding request properties or validating
the resulting values. @RequestBody, on the other hand converts the body of the request via HttpMessageConverter, validates it and raises
various conversion related exceptions or a MethodArgumentNotValidexception if validation fails. 
In most cases a MethodArgumentNotValidException can be handled generically (e.g. via @ExceptionHandler method) while BindException is very
often handled individually in each controller method.

若没有手动配置Validator对象，自然需要从 Spring 容器中获取校验器对象，注入使用。
关于校验模式,默认会校验完所有属性，然后将错误信息一起返回，但很多时候不需要这样，一个校验失败了，其它就不必校验了

@Configuration
public class ValidatorConfig {

    @Bean
    public Validator validator(){
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class).configure().failFast(true).buildValidatorFactory();
        return validatorFactory.getValidator();
    }
}

注解的使用方式

@Null
被注释的元素必须为 null

@NotNull
被注释的元素必须不为 null

@AssertTrue
被注释的元素必须为 true

@AssertFalse
被注释的元素必须为 false

@Min(value)
被注释的元素必须是一个数字，其值必须大于等于指定的最小值

@Max(value)
被注释的元素必须是一个数字，其值必须小于等于指定的最大值

@DecimalMin(value)
被注释的元素必须是一个数字，其值必须大于等于指定的最小值

@DecimalMax(value)
被注释的元素必须是一个数字，其值必须小于等于指定的最大值

@Size(max=, min=)
被注释的元素的大小必须在指定的范围内

@Digits(integer, fraction)
被注释的元素必须是一个数字，其值必须在可接受的范围内

@Past
被注释的元素必须是一个过去的日期

@Future
被注释的元素必须是一个将来的日期

@Pattern(regex=, flag=)
被注释的元素必须符合指定的正则表达式

@NotBlank(message =)
验证字符串非null，且长度必须大于0

以下为hibernate Validator附加的
@Email
被注释的元素必须是电子邮箱地址

@Length(min=, max=)
被注释的字符串的大小必须在指定的范围内

@NotEmpty
被注释的字符串的必须非空

@Range(min=, max=, message=)
被注释的元素必须在合适的范围内

@Valid与@Validated的区别:
在这里插入图片描述

上面图片来源自https://www.jianshu.com/p/2432d0f51c0e，其他区别见:https://blog.csdn.net/qq_27680317/article/details/79970590

参考
https://www.ibm.com/developerworks/cn/java/j-lo-jsr303/
https://www.jianshu.com/p/2432d0f51c0e
https://www.cnblogs.com/cjsblog/p/8946768.html

happytaohaha
关注
springboot使用validation进行参数校验
zhou_zhao_xu的博客
10-12 651
1. 校验分组 public class GroupsInterface { public interface submitVideo{} public interface basic{} } 2. 校验实体 @Data @Getter @Setter @AllArgsConstructor @NoArgsConstructor @ToString public class BaseRequestParameterValidationModel implements Serializ
springboot+validation参数校验浅入浅出
m0_67390963的博客
05-15 1177
在spring开发中，对入参进行校验是一种常见且必须的需求，下面对springboot中引入validation组件实现校验进行简单的分析一下。 Java API 规范 JSR303 定义了 Bean 校验的标准，但没提供实现，而常用的hibernate validation则是对这个规范的实现，提供了校验注解@Min、@Max等。spring validation是对hibernate validation的二次封装，用于spirng中参数的校验。 若springboot版本低于2.3.时，spring-
spring boot参数校验实践简单总结
旺仔牛奶的博客
04-08 1430
1.传递的参数是json类型或者以实体对象传递的A. 在实体类的属性上添加校验注解public class User { @NotNull(message = "{the userName is not null}") private Long userId; private String userName; //get/set方法省略 }B.在controller...
Hibernate Validator 数据校验框架
最新发布
从基础到源码解析的学习记录
08-05 2355
JSR：Java Specification Requests的缩写，意思是Java规范提案是指向JCP(Java Community Process) 提出新增一个标准化技术规范的正式请求任何人都可以提交JSR，以向Java平台增添新的API和服务JSR已成为Java界的一个重要标准就是这个JSR规范之一Bean Validation是一个运行时的数据验证框架的标准JSR303是专家组成员向JCP提交的第1版Bean Validation，即针对bean数据校验提出的一个规范，
spring boot 参数校验
借物小人的博客
04-15 139
转载：Spring Boot 参数校验 背景介绍 开发过程中，后台参数校验必不可少，经常看到如下代码： public BaseResult save(User user) { if (StringUtils.isBlank(user.name)) { return BaseResult.failure("用户名不能为空"); } if (StringUtils.isBlank(user.password)) { return BaseResult.failure("密码不能为空"); }
spring-validateRequiredProperties()-自定义环境变量验证
luzhensmart的专栏
06-24 1471
文中涉及的spring版本号为4.1.8.RELEASE 扩展功能介绍 今天实战的内容，是通过spring容器来确保环境变量MYSQL_HOST一定存在，如果不存在应用就会启动失败； 分析spring源码 通过分析spring源码来确定如何扩展； 在spring环境初始化的时候，AbstractApplicationContext的prepareRefresh方法会被调用，源码如下: protected void prepareRefresh() { this.startupDat
MethodArgumentNotValidException 与 ConstraintViolationException
weixin_42206151的博客
11-22 1726
当使用注解进行参数校验时，如果参数违反了约束条件（例如，@NotNull、@Size、@Pattern等），就会抛出 ConstraintViolationException 异常。MethodArgumentNotValidException 和ConstraintViolationException 都是用于处理参数校验异常的异常类，但它们在不同的上下文中使用。- 通常，该异常是在控制器（Controller）中接收到请求参数后发生的，它包含了关于哪个参数违反了约束条件以及相应的错误消息。
Spring Boot + validation + AOP 请求参数校验
12-20
Spring Boot + validation + AOP 请求参数校验 一、validation 校验注解 通用 @Null 被注释的属性必须为 null @NotNull被注释的属性必须不为 null @AssertTrue 被注释的属性必须为 true @AssertFalse 被注释的属性...
springboot+dubbo+validation 进行rpc参数校验的实现方法
08-25
SpringBoot、Dubbo以及Hibernate Validation的组合为RPC参数校验提供了强大的支持。在本文中，我们将深入探讨如何利用这些技术实现在SpringBoot应用中对Dubbo RPC调用进行参数校验。 首先，我们需要了解项目的基本...
SpringBoot中参数校验 Validation
tianynnb的博客
03-30 1637
数据校验很重要，在前端对数据进行校验的情况下，我们还是要对传入后端的数据再进行一遍校验，避免用户绕过浏览器直接通过一些 HTTP 工具直接向后端请求一些违法数据。 虽然我们通过 if/else 语句对请求的每一个参数一一校验。但是这样写起来太麻烦了，而且破坏了单一职责原则。所以今天我们来看一下 Spring Boot validation 。 首先我们先来看两个注解 @Validated： 可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上； 用在方法入参上无法单独提供嵌套验证功能;能配合嵌套
spring boot validation参数校验实例分析
08-25
主要介绍了spring boot validation参数校验,结合实例形式分析了spring boot validation进行数据有效性验证的相关操作技巧,需要的朋友可以参考下
详解SpringMVC验证框架Validation特殊用法
08-31
本篇文章主要介绍了详解SpringMVC验证框架Validation特殊用法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
Springboot集成Swagger2的配置
penriver的博客
07-14 300
Swagger Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 作用如下： 接口的文档在线自动生成。 功能测试。 增加依赖 2.9.2的版本是用的最多的, 目前最新版本是3.0.x <!--Swagger--> <dependency> <groupId>io.springfox</groupId> <artifactId&g
SpringBoot 实现数据加密脱敏（注解 + 反射 + AOP）
竹林幽深
04-18 277
江苏。
springboot 之 BindException、MethodArgumentNotValidException和ConstraintViolationException
enjoy.day
03-01 713
BindException、MethodArgumentNotValidException、ConstraintViolationExceptio
SpringValidator美化验证不通过的返回
yufan的专栏
01-25 658
 关注的一点：Spring抛出的异常类型是MethodArgumentNotValidException。 package com.yufan.all.valid; import lombok.extern.slf4j.Slf4j; import org.springframework.http.HttpStatus; import org.springframework.stereotyp...
使用 Spring Validation 优雅地进行参数校验
HollisChuang's Blog
09-19 2506
引言不知道大家平时的业务开发过程中 controller 层的参数校验都是怎么写的？是否也存在下面这样的直接判断？publicStringadd(UserVOuserVO){ ...
基于Spring Validation自定义校验注解
xzh_blog
11-23 2071
自定义一个校验注解，针对字符串参数校验，校验逻辑是字符串必须是"xzh"。String message() default "必须是xzh";Class
SpringBoot使用Validation校验参数
热门推荐
JustryDeng
01-21 14万+
JSR(Java Specification Requests)是Java界的重要标准；JSR又细分很多标准，其中JSR303就代表Bean Validation。更多细节可参考：https://jcp.org/en/jsr/detail?id=303。 目录 准备工作 约束性注解(简单)说明 @Validated的使用时机 @Validated与@Valid的简单对比说明...
SpringBoot高效参数校验：优雅处理与示例
总结来说，通过SpringBoot与BeanValidation的集成，开发人员可以以一种优雅且高效的方式处理参数校验，避免了大量冗余的IF-ELSE条件判断，从而提高代码质量和项目的整体维护性。对于web开发者来说，这是一个值得掌握...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值