validation参数检验 - 如何使用

已于 2022-03-19 11:05:00 修改
阅读量6.3k 收藏 20
点赞数 3
分类专栏： spring 文章标签： validation
于 2020-05-23 11:26:33 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_20919883/article/details/106297635
版权

文章目录

Maven 依赖

项目为 springboot 项目，主要依赖有以下三个，其中spring-boot-starter-validation包含了 jakarta.validation-api（包含了 javax.validation）、hibernate-validator

	<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>
	</dependency>

	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
		<optional>true</optional>
	</dependency>

Spring MVC Controller 的输入

在 Controller 验证前端传来的参数是我们 Web 开发最常做的事了，现在可以用 validation 取代那一大堆的 if 判断，我们可以用其验证所有请求相关的输入，比如：

  • Path Variables
  • Request Parameters
  • RequestBody
  • Header
  • …

验证 Path Variables、 Request Parameters、Request Header

@RestController
@Validated
public class ValidatePathVariableController {

    @GetMapping("/validatePathVariable/{id}")
    public String validateRequestBody(@PathVariable @Length(min = 5, max = 10) String id) {
        return id;
    }
}


@RestController
@Validated
public class ValidateRequestParamController {
    
    @GetMapping("/validateRequestParam")
    public String validateRequestBody(@RequestParam @Length(min = 5, max = 10) String id) {
        return id;
    }
}

@RestController
@Validated
public class ValidateRequestHeaderController {

    @GetMapping("/validateRequestHeader")
    public String validateRequestBody(@RequestHeader @Length(min = 5, max = 10) String id) {
        return id;
    }
}

在以上两个例子中，必须将 @Validated 注解添加在类级别，以通知 Spring 要处理直接加载方法参数上的 Constraints 注解1，这区别于定义一个 POJO 作为被验证对象，即以 Constraints 注解标记字段，再以 POJO 作为方法参数。
验证失败将抛出异常ConstraintViolationException，而不是MethodArgumentNotValidException，Spring 没有对 ConstraintViolationException 进行异常处理，会直接 HTTP status 500 (Internal Server Error)。

验证 RequestBody

@RestController
public class ValidateRequestBodyController {
    
    @PostMapping("/validateRequestBody")
    public String validateRequestBody(
            // 使用 @Valid 也可以
            @Validated @RequestBody Input input) {
        return input.toString();
    }
}

在本例中，必须将 @Validated 或 @Valid 加在参数上，加在类级别、方法级别是无效的。
验证失败会抛出一个异常 MethodArgumentNotValidException，默认 Spring 会将其转化成 HTTP status 为 400(Bad Request)，且打印一条警告。可自定义异常处理器，比如@ExceptionHandler(MethodArgumentNotValidException.class)来覆盖默认行为。

如果 Input 类中还有一个复杂类型的字段，比如自定义的类需要验证，则要为其添加 @Valid 注解。

非 Controller 组件的方法

验证除了可以应用于 Controller 以外，还可以应用于任意的被 Spring 管理的组件( Spring Component)，与在 Controller 中使用有一点不同：

在验证 POJO 时，Controller 可以直接以 @Validated 或 @Valid 注解相应的 POJO 参数，不需要类级别的 @Validated 。但非Controller 组件需要类级别的 @Validated，且只能用 @Valid 注解相应的 POJO 参数。

@Service
@Validated
public class ValidatingService {

    public void validateInput(@Valid Input input){
        System.out.println(input.toString());
        // do something
    }

    public void validateId(@NotNull String id){
        System.out.println(id);
        // do something
    }
}

自定义 Validator

在这个例子中，要完善 Input 类中对于 IpAddress 的验证，避免出现 111.111.111.333 这种的非法数据。

自定义一个验证需要的注解

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Constraint(validatedBy = StartWithValidator.class)
public @interface StartWith {

    String value();

    String message() default "{me.zhao.validator.constraints.StartWith.message}";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };
}

# ValidationMessages.properties
me.zhao.validator.constraints.StartWith.message = \u5fc5\u987b\u4ee5{value}\u5f00\u5934: ${validatedValue}

自定义 Constraint 注解注意点

  • 必须有message()、groups()、payload()三个方法，否则会报错
  • 需要注解 @Constraint 来指定验证器，通过 validatedBy
  • message 信息需要一个 ValidationMessages.properties 文件承载，命名方式如下图。可以用 ${validatedValue} 获取被验证的值，用 {value} 获取注解的参数值。其他用法需要参考一下下图所示的文件内容。
  • ValidationMessages.properties 中的 message 要用中文的 Unicode

Hibernate 的 ValidationMessages.properties 文件命名

自定义一个 Validator

public class StartWithValidator implements ConstraintValidator<StartWith, String> {

   private StartWith startWith;

   @Override
   public void initialize(StartWith constraintAnnotation) {
       startWith = constraintAnnotation;
   }

   @Override
   public boolean isValid(String value, ConstraintValidatorContext context) {
       if (value == null) {
           return false;
       }
       return value.startsWith(startWith.value());
   }
}

定义一个 POJO 进行验证

@Data
public class Input2 {
   @StartWith("P")
   private String id;
}

以纯代码方式使用 Validator，不依赖 Spring 的 @Validate 注解

纯代码方式

我们可以手动创建一个 Validator 来完成验证，而不需要 Spring 提供任何支持。

@Service
public class ProgrammaticallyValidateService {

    public String validateNoSpring(Input input) {
        ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
        Validator validator = validatorFactory.getValidator();
        Set<ConstraintViolation<Input>> constraintViolations = validator.validate(input);
        if (!constraintViolations.isEmpty()) {
            throw new ConstraintViolationException(constraintViolations);
        }
        return input.toString();
    }
}

当 constraintViolations 为空时，表示验证通过。

Spring 的非注解方式

除了上面那种手动创建一个 Validator 的方式，Spring 也预置了一个 Validator，我们可以通过自动注入的方式使用它。

@Service
public class ProgrammaticallyValidateService {

    private final Validator validator;

    public ProgrammaticallyValidateService(Validator validator) {
        this.validator = validator;
    }

    public String validateWithSpringValidator(Input input) {
        Set<ConstraintViolation<Input>> constraintViolations = validator.validate(input);
        if (!constraintViolations.isEmpty()) {
            throw new ConstraintViolationException(constraintViolations);
        }
        return input.toString();
    }
}

验证组 group

一个 POJO 有时需要在多个地方使用，且每个情景下对 POJO 的要求不同，比如 insert 时要求 id 必须为空，update 时要求 id 不能为空，这时可以定义多个验证组。

非 Controller 中的使用

定义 group

public class InputGroup {

    public interface Insert{}

    public interface Update{}
}

被验证 POJO

id 参数被注解两次，且应用于不同的 group

@Data
public class InputWithGroup {

    @Null(groups = {InputGroup.Insert.class})
    @NotNull(groups = {InputGroup.Update.class})
    private String id;
}

Service 验证

@Service
@Validated(InputGroup.Insert.class)
public class GroupValidateService {

    @Validated(InputGroup.Insert.class)
    public String validateInsert(@Valid InputWithGroup input) {
        return input.toString();
    }

    @Validated(InputGroup.Update.class)
    public String validateUpdate(@Valid InputWithGroup input) {
        return input.toString();
    }
}
  • 必须在类级别添加 @Validate，可同时指定组，比如 @Validate(InputGroup.Insert.class)
  • 方法级别的 @Validate(group) 可以覆盖类级别的 group
  • 由于 @Validate 不能用于非 Controller 之外的方法参数上，所有无法用参数级别的 group 覆盖类、方法级别的
  • 如果在 POJO 中指定了 group，但 @Validate(这里没有写) 没有指定，是不起作用的

在 Controller 中使用 group

@RestController
public class GroupValidateController {
    @PostMapping("validateInsert")
    public String validateInsert(@Validated(InputGroup.Insert.class) @RequestBody InputWithGroup input) {
        return input.toString();
    }

    @PostMapping("validateUpdate")
    public String validateUpdate(@Validated(InputGroup.Update.class) @RequestBody InputWithGroup input) {
        return input.toString();
    }
}

- 可直接在参数级别的 `@Validate` 中指定 group

嵌套验证

嵌套验证是指一个对象 A 的某个字段 b 是另一个对象 B，在验证 A 对象其它字段的同时，也要验证 B 对象的字段，若 B 对象也有字段为对象，要一直验证下去。
嵌套验证的开启很简单，只需在需要嵌套验证的字段上添加 @Valid 注解。如下代码，A 类中的 b 字段、list 字段。

@Data
public class A {

    @NotNull
    @Length(min = 1)
    private String name;

    @Valid
    @NotNull
    private B b;

    @Valid
    @NotNull
    @Size(min = 1)
    private List<B> list;
}

@Data
public class B {

    @NotNull
    @Max(10)
    private Integer number;
}

@Service
@Validated
public class ValidateNestService {

    public String validateNest(@Valid A a) {
        return a.toString();
    }
}

校验模式：普通模式 -> 快速失败

普通模式：进行所有检验，然后统一返回所有错误。默认为此模式
快速失败：当遇到检验失败时，停止检验，直接返回

手动创建 Validator

如果是手动创建 Validator 进行验证的话，可采用以下方式将 failFast 设置为 true。

    public String validateFailFast(Input input) {
        
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class).configure().failFast(true).buildValidatorFactory();
        Validator validator = validatorFactory.getValidator();
        Set<ConstraintViolation<Input>> constraintViolations = validator.validate(input);
        if (!constraintViolations.isEmpty()) {
            throw new ConstraintViolationException(constraintViolations);
        }
        return input.toString();
    }

注入自己的 Validator

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(ExecutableValidator.class)
@ConditionalOnResource(resources = "classpath:META-INF/services/javax.validation.spi.ValidationProvider")
@Import(PrimaryDefaultValidatorPostProcessor.class)
public class ValidationAutoConfiguration {

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	@ConditionalOnMissingBean(Validator.class)
	public static LocalValidatorFactoryBean defaultValidator() {
		LocalValidatorFactoryBean factoryBean = new LocalValidatorFactoryBean();
		MessageInterpolatorFactory interpolatorFactory = new MessageInterpolatorFactory();
		factoryBean.setMessageInterpolator(interpolatorFactory.getObject());
		return factoryBean;
	}

	@Bean
	@ConditionalOnMissingBean
	public static MethodValidationPostProcessor methodValidationPostProcessor(Environment environment,
			@Lazy Validator validator) {
		MethodValidationPostProcessor processor = new MethodValidationPostProcessor();
		boolean proxyTargetClass = environment.getProperty("spring.aop.proxy-target-class", Boolean.class, true);
		processor.setProxyTargetClass(proxyTargetClass);
		processor.setValidator(validator);
		return processor;
	}

}

以上为 Spring Validator 的自动注入，可以看出，在没有配置 Validator.class 的时候，会默认注入一个 LocalValidatorFactoryBean 作为 Validator。那我们可以打破这个条件，配置一个自己的 Validator。

@Configuration
public class ValidationConfig {

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

修改 Spring 的 LocalValidatorFactoryBean 的属性

LocalValidatorFactoryBean
如图，通过 debug 能够找到一条路径 localValidatorFactoryBean -> targetValidator -> validatorScopedContext -> failFast，但 LocalValidatorFactoryBean 并没有方法直接获取 targetValidator，还需要自己通过反射一层层的获取，然后修改值，比较麻烦，没有动手操作，这里只记录一个思路。

验证失效的原因之一 jar 冲突

可以用 IDEA 的 maven helper 插件找问题，输入 valid 查询是否有冲突的 jar。

参考

  1. Constraints 注解指的是 java.validation、hibernate.validator 中定义的注解，比如 @NotNull、@NotBlank等等。 ↩︎

赵丙双
关注
  • 3
    点赞
  • 踩
  • 20
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot 使用 Validation 进行参数校验并统一返回校验异常
m0_73311735的博客
05-16 2898
新建自定义注解java复制代码import com.jk.validator.StatusValidator;String message() default "状态传递有误";Class
JAVA中通过Hibernate-Validation进行参数验证
08-26
JAVA中通过Hibernate-Validation进行参数验证 JAVA中通过Hibernate-Validation进行参数验证是JAVA服务器端代码开发中的一种常用技术。在开发JAVA服务器端代码时，我们会遇到对外部传来的参数合法性进行验证，而...
SpringBoot怎么使用Validation校验参数,看完你就会了@
m0_49496327的博客
04-12 7387
1. Validation 介绍 Validation 是用于检查程序代码中参数的有效性的框架，作为 Spring 框架中的一个参数校验工具，集成在 spring-context 包中。 1.1 Validation 注解 Validation 包含了众多的注解来帮助对Java程序不同类型的参数进行校验，校验相关注解分布在spring-boot-starter-validation 依赖的 javax.validation.constraints 包中。 @Null/@NotnULL，标注的字段必须
Spring Boot学习笔记（二十一）Spring boot 数据校验 @Validated、@Valid用法详解
TUTsmile的博客
08-27 1760
文章目录约束注解（大多为 `javax.validation.constraints` 下的注解）启用校验使用消息示例进阶总结 后端数据校验（JSR303/JSR-349、javax validation、hibernate validation、spring validation） 后端数据校验如：请求参数不能为null、数值至少为5、email参数符合邮箱地址规则等，通常涉及到上述几种工具，其区别： JSR303/JSR-349、javax validation：JSR303是一项标准、JSR-349
Jakarta Bean Validation (jakarta.validation.constraints) 常用注解
最新发布
qq_26370505的博客
06-05 505
Jakarta Bean Validation (jakarta.validation.constraints) 提供了一系列标准的注解，用于简化和标准化JavaBean的数据验证。Jakarta Bean Validation (jakarta.validation.constraints) 标准的注解。
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的简单对比说明...
validation参数检验 - 注解介绍
赵丙双的博客
05-23 1万+
文章目录Maven 依赖注解介绍javax.validation 中的注解（22个）Null、NotNullNotBlankNotEmptySizeAssertFalse、AssertTrueDecimalMax、DecimalMin、Max、MinDigitsPositive、PositiveOrZero、Negative、NegativeOrZeroFuture、FutureOrPresent、Past、PastOrPresentEmail、Patternhibernate.validator 中的注解
Spring Validation参数效验各种使用姿势
2301_76607156的博客
03-20 1571
定义的分组接口，继承Default接口。复制代码自定义校验规则小杰在工作当中用的比较少。大部分业务需求使用自带的注解已经够平常开发了。当然自定义validation规则也非常简单。这里使用校验电话号码是否合法来举例！别抬杠，说我为什么不用@Pattern(regexp = "^1[3456789]\\d{9}$",message = "手机号格式不正确")直接实现。对不起，我不想每次写正则。自定义注解Phone，跟着内置的注解照葫芦画瓢。不过的值要指定我们自定义的约束验证器！
service-validation-example:使用Jersey和HK2的服务水平方法参数Bean验证
05-19
在Jersey中，bean验证的局限性在于它不支持使用服务方法参数在服务级别进行验证。 例如 public static class Service { public String getValue ( @Valid Model model ) { return model . value; } } 我们想要...
validation_curve验证曲线与超参数
01-20
以下是一个简单的示例，展示了如何使用`validation_curve()` 来评估梯度提升回归模型（GradientBoostingRegressor）的`max_depth` 参数： ```python import numpy as np import pandas as pd from time import time...
核密度非参数估计的matlab代码-Cross-Validation:交叉验证
06-02
核密度非参数估计的matlab代码交叉验证 在我目前的课程“数据分析和解释”中，我们的课程讲师是图像处理专家，我们已经完成了关于这个主题的几个有趣的作业，并在 MATLAB 中实现了它们。 其中之一是 PDF 估计器，...
validation
03-17
validation验证zip，喜欢的可以下载。
validation.m:数据验证-matlab开发
05-30
在使用`validation.m` 这样的工具时，需要注意的是，验证不仅仅是检验模型是否正确，更重要的是理解模型的局限性和可能的改进方向。对于提供的`validation.zip`压缩包，解压后可以查看具体的代码实现，以获取更详细...
Spring6 数据校验 Validation
Lifelong learning
06-22 1952
spring validation允许通过注解的方式来定义对象校验规则，把校验和业务逻辑分离开，让代码编写更加方便。Spring Validation其实就是对Hibernate Validator进一步的封装，方便在Spring中使用。
SpringMVC 使用验证框架 Bean Validation（上）
weixin_30321449的博客
04-18 128
SpringMVC 使用验证框架 Bean Validation（上） 对于任何一个应用而言在客户端做的数据有效性验证都不是安全有效的，这时候就要求我们在开发的时候在服务端也对数据的有效性进行验证。 SpringMVC 自身对数据在服务端的校验(Hibernate Validator)有一个比较好的支持，它能将我们提交到服务端的数据按照我们事先的约定进行数据有效性验证，对于不合格的数据...
Validation参数校验框架
zyxzyx666的博客
01-27 809
Validation是Spring提供的一个参数校验框架，使用预定义的注解完成参数校验
交叉验证的缺陷及改进（Cross Validation done wrong）
mingo_敏
08-02 6438
本文主要是对我们使用交叉验证可能出现的一个问题进行讨论，并提出修正方案。 本文地址：http://blog.csdn.net/shanglianlm/article/details/47207173
Java代码简洁-validation参数校验
weixin_43994244的博客
07-09 8305
validation参数校验
JSR303校验 + 统一异常处理方法
lilydfghh的博客
01-17 788
3.JSR303校验 + 统一异常处理方法 问题引入：填写form时应该有前端校验，后端也应该有校验 对于后端来说，外界传递的一切参数都不可靠。 前端的校验是element-ui表单验证https://element.eleme.cn/#/zh-CN/component/form Form 组件提供了表单验证的功能，只需要通过 rules 属性传入约定的验证规则，并将 Form-Item 的 prop 属性设置为需校验的字段名即可。校验规则参见 async-validator 使用自定义校验规则可以解决
@Validated参数检验工具
08-13
总之，@Validated和@Valid都是参数检验工具，但在功能上有一些区别。具体使用哪个注解取决于项目的需求和框架的要求。<span class="em">1</span><span class="em">2</span><span class="em">3 #### 引用[.reference_...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值