java - 将@Validated 和@Valid 与spring validator 一起使用

Question

我有一个 java bean 用于将 JSON 消息发送到 spring @RestController 并且我有 bean 验证设置并使用 @Valid 运行得很好。但我想转移到 Protobuf/Thrift 并远离 REST。它是一个内部 API，许多大公司已经在内部取消了 REST。这真正意味着我不再控制消息对象——它们是在外部生成的。我不能再给它们添加注释了。

所以现在我的验证必须是程序化的。我该怎么做呢？我编写了一个 Validator 并且它工作得很好。但它没有使用漂亮的 @Valid 注释。我必须执行以下操作:

@Service
public StuffEndpoint implements StuffThriftDef.Iface {

    @Autowired
    private MyValidator myValidator;

    public void things(MyMessage msg) throws BindException {
        BindingResult errors = new BeanPropertyBindingResult(msg, msg.getClass().getName());
        errors = myValidator.validate(msg);
        if (errors.hasErrors()) {
            throw new BindException(errors);
        } else {
            doRealWork();
        }
    }
}

这很臭。我必须在每一种方法中都这样做。现在，我可以将其中的很多内容放入一个抛出 BindException 的方法中，这样就可以将一行代码添加到每个方法中。但这仍然不是很好。

我想要的是看到它看起来像这样:

@Service
@Validated
public StuffEndpoint implements StuffThriftDef.Iface {

    public void things(@Valid MyMessage msg) {
        doRealWork();
    }
}

仍然得到相同的结果。请记住，我的 bean 没有注释。是的，我知道我可以在方法上使用 @InitBinder 注释。但这仅适用于网络请求。

我不介意将正确的 Validator 注入(inject)此类，但我希望我的 ValidatorFactory 可以根据 supports() 方法提取正确的 validator 。

这可能吗？有没有办法将 bean 验证配置为实际使用 Spring 验证？我必须在某处劫持一个方面吗？侵入 LocalValidatorFactory 或 MethodValidationPostProcessor？

谢谢。

Answer 1

结合 Spring 验证和 JSR-303 约束是一件非常复杂的事情。并且没有“准备好使用”的方式。主要的不便之处在于 Spring 验证使用 BindingResult，而 JSR-303 使用 ConstraintValidatorContext 作为验证结果。

您可以尝试使用 Spring AOP 制作自己的验证引擎。让我们考虑一下，我们需要为此做些什么。首先，声明 AOP 依赖项(如果您尚未声明):

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aop</artifactId>
    <version>4.2.4.RELEASE</version>
</dependency>
<dependency>
   <groupId>org.aspectj</groupId>
   <artifactId>aspectjrt</artifactId>
   <version>1.8.8</version>
   <scope>runtime</scope>
</dependency>
<dependency>
   <groupId>org.aspectj</groupId>
   <artifactId>aspectjweaver</artifactId>
   <version>1.8.8</version>
</dependency>

我使用的是 4.2.4.RELEASE 版本的 Spring，但您当然可以使用自己的版本。使用方面注释需要 AspectJ。下一步，我们必须创建简单的 validator 注册表:

public class CustomValidatorRegistry {

    private List<Validator> validatorList = new ArrayList<>();

    public void addValidator(Validator validator){
        validatorList.add(validator);
    }

    public List<Validator> getValidatorsForObject(Object o) {
        List<Validator> result = new ArrayList<>();
        for(Validator validator : validatorList){
            if(validator.supports(o.getClass())){
                result.add(validator);
            }
        }
        return result;
    }
}

如您所见，这是一个非常简单的类，它允许我们找到对象的 validator 。现在让我们创建注释，这将是需要验证的标记方法:

package com.mydomain.validation;

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomValidation {
}

因为标准的BindingException 类不是RuntimeException，我们不能在覆盖方法中使用它。这意味着我们需要定义自己的异常:

public class CustomValidatorException extends RuntimeException {

    private BindingResult bindingResult;

    public CustomValidatorException(BindingResult bindingResult){
        this.bindingResult = bindingResult;
    }

    public BindingResult getBindingResult() {
        return bindingResult;
    }
}

现在我们准备创建一个将完成大部分工作的方面。方面将在方法之前执行，这些方法用 CustomValidation 注释标记:

@Aspect
@Component
public class CustomValidatingAspect {

    @Autowired
    private CustomValidatorRegistry registry; //aspect will use our validator registry


    @Before(value = "execution(public * *(..)) && annotation(com.mydomain.validation.CustomValidation)")
    public void doBefore(JoinPoint point){
        Annotation[][] paramAnnotations  =
                ((MethodSignature)point.getSignature()).getMethod().getParameterAnnotations();
        for(int i=0; i<paramAnnotations.length; i++){
            for(Annotation annotation : paramAnnotations[i]){
                //checking for standard org.springframework.validation.annotation.Validated
                if(annotation.annotationType() == Validated.class){
                    Object arg = point.getArgs()[i];
                    if(arg==null) continue;
                    validate(arg);
                }
            }
        }
    }

    private void validate(Object arg) {
        List<Validator> validatorList = registry.getValidatorsForObject(arg);
        for(Validator validator : validatorList){
            BindingResult errors = new BeanPropertyBindingResult(arg, arg.getClass().getSimpleName());
            validator.validate(arg, errors);
            if(errors.hasErrors()){
                throw new CustomValidatorException(errors);
            }
        }
    }
}

execution(public * *(..)) && @annotation(com.springapp.mvc.validators.CustomValidation) 意味着，这个方面将应用于bean的任何公共(public)方法，标记带有 @CustomValidation 注释。另请注意，为了标记经过验证的参数，我们使用标准的 org.springframework.validation.annotation.Validated 注释。但我们当然可以定制。我认为其他方面的代码很简单，不需要任何注释。示例 validator 的更多代码:

public class PersonValidator implements Validator {
    @Override
    public boolean supports(Class<?> aClass) {
        return aClass==Person.class;
    }

    @Override
    public void validate(Object o, Errors errors) {
        Person person = (Person)o;
        if(person.getAge()<=0){
            errors.rejectValue("age", "Age is too small");
        }
    }
}

现在我们已经调整好配置并准备好使用了:

@Configuration
@ComponentScan(basePackages = "com.mydomain")
@EnableAspectJAutoProxy(proxyTargetClass = true)
public class AppConfig{

    .....

    @Bean
    public CustomValidatorRegistry validatorRegistry(){
        CustomValidatorRegistry registry = new CustomValidatorRegistry();
        registry.addValidator(new PersonValidator());
        return registry;
    }    
}

请注意，proxyTargetClass 为 true 因为我们将使用 cglib 类代理。

---

服务类中的目标方法示例:

@Service
public class PersonService{

    @CustomValidation
    public void savePerson(@Validated Person person){        
       ....
    }

}

由于 @CustomValidation 注释方面将被应用，并且由于 @Validated 注释 person 将被验证。以及在 Controller (或任何其他类)中使用服务的示例:

@Controller
public class PersonConroller{

    @Autowired
    private PersonService service;

    public String savePerson(@ModelAttribute Person person, ModelMap model){
        try{
            service.savePerson(person);
        }catch(CustomValidatorException e){
            model.addAttribute("errors", e.getBindingResult());
            return "viewname";
        }
        return "viewname";
    }

}

请记住，如果您从 PersonService 类的方法中调用 @CustomValidation，验证将不起作用。因为它会调用原始类的方法，而不是代理。这意味着，如果您希望验证正常工作(例如，@Transactional 的工作方式相同)，您只能从类外部(从其他类)调用此方法。

抱歉发了这么长的帖子。我的回答与“简单的声明方式”无关，您可能不需要它。但我很好奇解决这个问题。