SpringBoot Validation 快速失败(failFast)

SpringBoot Validation 快速失败(failFast)

1. 解决方案

直接给出解决方案，有兴趣的可以看看下面的解决问题的历程

@Configuration
public class ValidatorConfiguration {

    @Bean
    public Validator validator(AutowireCapableBeanFactory springFactory) {
        try (ValidatorFactory factory = Validation.byProvider(HibernateValidator.class)
                .configure()
                // 快速失败
                .failFast(true)
                // 解决 SpringBoot 依赖注入问题
                .constraintValidatorFactory(new SpringConstraintValidatorFactory(springFactory))
                .buildValidatorFactory()) {
            return factory.getValidator();
        }
    }
}

2. 解决历程

2.1 背景

在做一个后台项目的时候，用了 SpringBoot Validation 来做参数校验，并利用ControllerAdvice做全局的异常捕获。
例如我写了下面的代码来校验参数信息,利用自定义的注解校验器校验系统资源是否存在：

// Controller 

@PostMapping("settingHydrology")
    public XxyResponse<String> settingHydrology(@RequestBody @NotEmpty List<@Valid MonitorHydrologyRelation> list) {

        monitorUnitService.settingHydrology(list);
        return XxyResponse.of();
    }

// Bean
@Data
public class MonitorHydrologyRelation implements Serializable {

    @MonitorUnitExists
    private Integer unitId;
    //.....
}

2.2 问题

这样写完，我在调试的时候发现一个问题，如果列表中的资源都不存在，每一个都会被校验一次，例如下面接口的返回：

{
  "status": 400,
  "timestamp": "2022-02-15 17:43:40",
  "message": "settingHydrology.list[1].unitId: 监测单元不存在, settingHydrology.list[0].unitId: 监测单元不存在",
  "error": null,
  "exception": null
}

这是因为SpringValidation框架默认是关闭快速失败的，也就是说当一个参数校验不通过的时候它不会直接停止，而是会继续校验剩余的参数。
我觉得这样不太好，因为一旦有参数校验失败就意味着这次调用就已经不合法了，再继续校验不太好，一是返回给前端的展示信息不太友好，另外也会浪费系统资源，所以我就想到了框架是否也有failFast机制。

2.3 寻找解决方案

网上一搜，果然有，几乎所有人给的答案都是下面的代码

@Bean
public Validator validator() {
    ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
            .configure()
            // 快速失败模式
            .failFast(true)
            .buildValidatorFactory();
    return validatorFactory.getValidator();
}

满心欢喜用到代码中，结果报错了。空指针异常！！！然后我发现是我自己写的注解校验器的问题，因为我在注解校验器中使用了@Autowire自动注入Bean。也就意味着使用上面的方式Bean无法自动注入！！！

 自定义的注解校验器

 public static class MonitorUnitExistsValidation extends AbstractValidator<MonitorUnitExists, Integer> {

        @Autowired
        private MonitorUnitDAO dao;

        @Override
        public boolean isValid(Integer value, ConstraintValidatorContext context) {
            return dao.existsByPrimarykey(value);
        }
    }

之后找了各种官方文档，奈何Springboot有关Validation的文档就没有这方面的信息，Hibernate-Validation 的文档中也没有提到怎么在SpringBoot中进行配置。貌似走到了死胡同。

2.4 转机

我发现在ConfigValidationConfuguration中有一个方法 constraintValidatorFactory() ，他需要一个参数 ConstraintValidatorFactory， 看着好眼熟。

自定义注解不就是实现 ConstraintValidator 这个接口吗？也就是说这个Factory负责实例化那些我们自定义的注解校验器。看一下它的子类。有一个SpringConstraintValidatorFactory类 实现了这个Factory。

点进去看 SpringConstraintValidatorFactory 的源码，发现他特别简单，只是一个代理类。代理了AutowireCapableBeanFactory 对象（适配器模式）。AutowireCapableBeanFactory 这个对象就不陌生了，这不就是SpringBoot中BeanFactory的实现类吗？SpringBoot 依赖注入就是靠他来实现的。而且SpringBoot中默认就有这个Bean，不需要我们自己new一个对象

/// SpringConstraintValidatorFactory 源码

public class SpringConstraintValidatorFactory implements ConstraintValidatorFactory {
	
	// 代理的BeanFactory对象
	private final AutowireCapableBeanFactory beanFactory;
	public SpringConstraintValidatorFactory(AutowireCapableBeanFactory beanFactory) {
		Assert.notNull(beanFactory, "BeanFactory must not be null");
		this.beanFactory = beanFactory;
	}
	@Override
	public <T extends ConstraintValidator<?, ?>> T getInstance(Class<T> key) {
		// 创建校验器对象
		return this.beanFactory.createBean(key);
	}
	@Override
	public void releaseInstance(ConstraintValidator<?, ?> instance) {
		// 释放校验器对象
		this.beanFactory.destroyBean(instance);
	}

}

2.5 问题解决

明白了框架是怎么创建校验器对象的话，上面的问题也就解决了，我们只需要在创建Validator这个Bean的时候配置上 ConstraintValidatorFactory 对象即可。
于是就有了下面的代码：

@Bean
public Validator validator(AutowireCapableBeanFactory springFactory) {
     ValidatorFactory factory = Validation.byProvider(HibernateValidator.class)
             .configure()
             // 快速失败
             .failFast(true)
             // 解决 SpringBoot 依赖注入问题
             .constraintValidatorFactory(new SpringConstraintValidatorFactory(springFactory))
             .buildValidatorFactory() ;
         return factory.getValidator();
 }

但是，我发现idea给了我一个警告。

ValidatorFactory 接口继承了 AutoCloseable接口，意味着他需要调用close方法关闭，出于个人的代码洁癖的原因，于是将Factory创建使用try包裹了一层，于是就有了下面的最终的代码。

 @Bean
    public Validator validator(AutowireCapableBeanFactory springFactory) {
        try (ValidatorFactory factory = Validation.byProvider(HibernateValidator.class)
                .configure()
                // 快速失败
                .failFast(true)
                // 解决 SpringBoot 依赖注入问题
                .constraintValidatorFactory(new SpringConstraintValidatorFactory(springFactory))
                .buildValidatorFactory()) {
            return factory.getValidator();
        }
    }

至此问题解决，多个参数校验失败的时候当第一个校验失败后直接返回。

{
  "status": 400,
  "timestamp": "2022-02-15 18:14:21",
  "message": "settingHydrology.list[0].unitId: 监测单元不存在",
  "error": null,
  "exception": null
}