MethodValidationInterceptor和@Validated @ModelAttribute

时间:2018-05-25 14:57:59

标签: java spring spring-mvc spring-boot hibernate-validator

我有一个Spring Boot 2应用程序,我希望能够使用Hibernate验证器验证控制器参数 - 我已成功使用它。我将所有控制器注释为@Validated,并且我使用了@PathVariable @AssertUuid final String customerId之类的请求参数验证 - 到目前为止一切顺利,一切正常。

但是,我希望能够从表单中验证@ModelAttribute

@Controller
@PreAuthorize("hasRole('ADMIN')")
@RequestMapping(path = "/customers")
@Validated
public class CustomerController
{

    private final CustomerFacade customerFacade;

    public CustomerController(
        final CustomerFacade customerFacade
    )
    {
        this.customerFacade = customerFacade;
    }

    @GetMapping("/create")
    public ModelAndView create(
        final AccessToken accessToken
    )
    {
        return new ModelAndView("customer/create")
            .addObject("customer", new CreateCustomerRequest());
    }

    @PostMapping("/create")
    public ModelAndView handleCreate(
        final AccessToken accessToken,
        @Validated @ModelAttribute("customer") final CreateCustomerRequest customerValues,
        final BindingResult validation
    ) throws 
        UserDoesNotHaveAdminAccessException
    {
        if (validation.hasErrors()) {
            return new ModelAndView("customer/create")
                .addObject("customer", customerValues);
        }

        CustomerResult newCustomer = customerFacade.createCustomer(
            accessToken,
            customerValues.getName()
        );

        return new ModelAndView(new RedirectView("..."));
    }

    public static final class CreateCustomerRequest
    {

        @NotNull
        @NotBlank
        private String name;

        public CreateCustomerRequest(final String name)
        {
            this.name = name;
        }

        public CreateCustomerRequest()
        {
        }

        public String getName()
        {
            return name;
        }

    }

}

但是当我发送无效数据时,这会导致MethodValidationInterceptor抛出ConstraintViolationException。这通常是有意义的,我希望在其他所有情况下都有这种行为,但在这种情况下,正如您所看到的,我想使用BindingResult来处理验证错误 - 这在处理表单时是必需的。 / p>

有没有办法告诉Spring不要使用MethodValidationInterceptor验证这个特定参数,因为它已经被活页夹验证了,我想以不同的方式处理它?<​​/ p>

我一直在挖掘弹簧代码,看起来不是为了共同努力。我有一些想法如何解决这个问题:

  • 从参数中删除@Validated
    • 在控制器方法中明确调用validator.validate() - 丑陋且危险(您可能忘记称之为)
    • 创建另一个AOP拦截器,它会找到&#34;对&#34; @ModelAttributeBindingResult并在那里调用验证器,强制全局验证

我是否完全错了?我错过了什么吗?还有更好的方法吗?

2 个答案:

答案 0 :(得分:0)

我已经提出了一个允许我继续工作的解决方案,但我不认为这个问题已经解决了。

正如我在原始问题中暗示的那样,当@ModelAttribute未使用@Validated@Valid进行注释时,此方面会强制验证{<1}}。

这意味着ConstraintViolationException不会因无效@ModelAttribute而被抛出,您可以处理方法体中的错误。

import com.google.common.collect.Iterators;
import com.google.common.collect.PeekingIterator;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.MethodParameter;
import org.springframework.validation.Errors;
import org.springframework.validation.Validator;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.ModelAttribute;

import javax.validation.Valid;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

@SuppressWarnings({"checkstyle:IllegalThrows"})
@Aspect
public class ControllerModelAttributeAutoValidatingAspect
{

    private final Validator validator;

    public ControllerModelAttributeAutoValidatingAspect(
        final Validator validator
    )
    {
        this.validator = validator;
    }

    @Around("execution(public * ((@org.springframework.web.bind.annotation.RequestMapping *)+).*(..)))")
    public Object proceed(final ProceedingJoinPoint pjp) throws Throwable
    {
        MethodSignature methodSignature = MethodSignature.class.cast(pjp.getSignature());
        List<MethodParameter> methodParameters = getMethodParameters(methodSignature);

        PeekingIterator<MethodParameter> parametersIterator = Iterators.peekingIterator(methodParameters.iterator());
        while (parametersIterator.hasNext()) {
            MethodParameter parameter = parametersIterator.next();
            if (!parameter.hasParameterAnnotation(ModelAttribute.class)) {
                // process only ModelAttribute arguments
                continue;
            }
            if (parameter.hasParameterAnnotation(Validated.class) || parameter.hasParameterAnnotation(Valid.class)) {
                // if the argument is annotated as validated, the binder already validated it
                continue;
            }

            MethodParameter nextParameter = parametersIterator.peek();
            if (!Errors.class.isAssignableFrom(nextParameter.getParameterType())) {
                // the Errors argument has to be right after the  ModelAttribute argument to form a pair
                continue;
            }

            Object target = pjp.getArgs()[methodParameters.indexOf(parameter)];
            Errors errors = Errors.class.cast(pjp.getArgs()[methodParameters.indexOf(nextParameter)]);
            validator.validate(target, errors);
        }

        return pjp.proceed();
    }

    private List<MethodParameter> getMethodParameters(final MethodSignature methodSignature)
    {
        return IntStream.range(0, methodSignature.getParameterNames().length)
            .mapToObj(i -> new MethodParameter(methodSignature.getMethod(), i))
            .collect(Collectors.toList());
    }

}

现在,您可以继续使用控制器方法中的验证注释,同时final BindingResult validation按预期工作。

@PostMapping("/create")
public ModelAndView handleCreate(
    final AccessToken accessToken,
    @ModelAttribute("customer") final CreateCustomerRequest customerValues,
    final BindingResult validation
)

答案 1 :(得分:0)

感谢您分享此解决方案。

我以此为灵感,并以此为基础,创建了我打算在选定方法上使用的更通用的方法参数验证器。

由@Validate注释的方法触发验证:

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

示例:

@Validate
public void testMe(BindingModel bindingModel, Errors errors) {
    if (!errors.hasErrors()) {
        // bindingModel is valid
    }
}

这是经过修改的方面类:

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.MethodParameter;
import org.springframework.stereotype.Component;
import org.springframework.validation.Errors;
import org.springframework.validation.Validator;

import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

@Aspect
@Component
public class ValidateAspect {

    private final Validator validator;

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

    @Around("@annotation(Validate)")
    public Object proceed(ProceedingJoinPoint pjp) throws Throwable {
        MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
        List<MethodParameter> methodParameters = getMethodParameters(methodSignature);

        for (int i = 0; i < methodParameters.size() - 1; i++) {
            MethodParameter parameter = methodParameters.get(i);

            MethodParameter nextParameter = methodParameters.get(i + 1);
            if (!Errors.class.isAssignableFrom(nextParameter.getParameterType())) {
                // the Errors argument has to be right after the validated argument to form a pair
                continue;
            }

            Object target = pjp.getArgs()[methodParameters.indexOf(parameter)];
            Errors errors = (Errors) pjp.getArgs()[methodParameters.indexOf(nextParameter)];
            validator.validate(target, errors);
        }

        return pjp.proceed();
    }

    private static List<MethodParameter> getMethodParameters(MethodSignature methodSignature) {
        return IntStream
                .range(0, methodSignature.getParameterNames().length)
                .mapToObj(i -> new MethodParameter(methodSignature.getMethod(), i))
                .collect(Collectors.toList());
    }
}

上面的代码已经过测试,并且(到目前为止)似乎可以在Spring Boot 2.1.4.RELEASE中正常工作