请求反序列化期间的自定义声明性spring pojo验证

Question

我正在寻找注释来注释pojo类，我需要在请求反序列化期间对其进行验证。我正在搜索要作为参数类传递的注释，该类将验证我的pojo。

实现可以如下所示：

@ValidateAnnotation(class = ExampleClassValidator.class)
public class ExampleClass {
    private String name;
}

有人知道这种方法的Spring注释或提供声明性验证的依赖项吗？我问是因为我在留档中找不到任何类似的解决方案。

Answer 1

也许编写自定义注释和使用Spring AOP会对您有所帮助。Spring AOP非常简单。

Answer 2

对于正常的验证，您可以使用javax中的注释对类进行注释。验证。约束包，如javax。验证。约束条件。注意空。对于自定义验证，您可以创建自己的注释来调用您编写的自定义验证程序。

例如，如果您想创建一个验证器来确保一个字段的长度为9个字符，您可以执行以下操作：

首先，创建自定义验证注释。

@Documented
@Constraint(validatedBy = NineCharactersValidator.class)
@Target( { ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface NineCharactersOnly {
    String message() default "This field must contain exactly nine characters";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

接下来，创建自定义验证器：

public class NineCharactersValidator implements ConstraintValidator<NineCharactersOnly, String> {

    @Override
    public void initialize(NineCharactersOnly contactNumber) {
    }

    @Override
    public boolean isValid(String contactField, ConstraintValidatorContext cxt) {
        return contactField != null && contactField.length() == 9;
    }
}

接下来，对需要约束在pojo上的字段使用注释。

public class ExampleClass {
    @NineCharactersOnly
    private String fieldThatMustBeNineCharacters;
}

接下来，将控制器中的方法参数标记为@Valid，以便Spring验证它们：

@RestController
public class CustomValidationController {

    @PostMapping("/customValidationPost")
    public ResponseEntity<String> customValidation(@Valid ExampleClass exampleClass, BindingResult result, Model m) {
        // we know the data is valid if we get this far because Spring automatically validates the input and 
        // throws a MethodArgumentNotValidException if it's invalid and returns an HTTP response of 400 (Bad Request).
        return ResponseEntity.ok("Data is valid");
    }   
}

最后，如果您想要自定义逻辑来处理验证错误而不仅仅是发送400，您可以创建自定义验证处理程序方法。

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(MethodArgumentNotValidException.class)
public Map<String, String> handleValidationException(MethodArgumentNotValidException e) {
    Map<String, String> errors = new HashMap<>();
    d.getBindingResult().getAllErrors().forEach((error) -> {
        String fieldName = ((FieldError) error).getField();
        String errorMessage = error.getDefaultMessage();
        errors.put(fieldName, errorMessage);
    });

    return errors;
}

Answer 3

您可以使用@InitBinder根据方法的目标配置验证器。下面是一个简单的例子：

注释类：

package test.xyz;


import org.springframework.validation.Validator;

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

@Retention(RetentionPolicy.RUNTIME)
public @interface ValidateAnnotation {
    Class<? extends Validator> value();
}

要验证的示例类：

package test.xyz;

@ValidateAnnotation(ExampleClassValidator.class)
public class ExampleClass {
}

验证程序类：

package test.xyz;

import org.springframework.validation.Errors;

public class ExampleClassValidator implements org.springframework.validation.Validator {
    @Override
    public boolean supports(Class<?> aClass) {
        return ExampleClass.class.isAssignableFrom(aClass);
    }

    @Override
    public void validate(Object o, Errors errors) {

    }
}

最后是具有@InitBinder定义的控制器类：

import org.springframework.stereotype.Controller;
import org.springframework.validation.Errors;
import org.springframework.validation.Validator;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import test.xyz.ExampleClass;
import test.xyz.ValidateAnnotation;

import javax.servlet.http.HttpServletRequest;
import javax.validation.Valid;
import java.util.Collections;

@Controller
public class ExampleController {
    @RequestMapping(value="test-endpoint", method= RequestMethod.GET)
    public @ResponseBody
    Object testMethod(@Valid ExampleClass exampleClass, Errors errors) {
        return Collections.singletonMap("success", true);
    }


    @InitBinder
    public void initBinder(WebDataBinder binder, HttpServletRequest request) throws IllegalAccessException, InstantiationException {
        Class<?> targetClass = binder.getTarget().getClass();
        if(targetClass.isAnnotationPresent(ValidateAnnotation.class)) {
            ValidateAnnotation annotation = targetClass.getAnnotation(ValidateAnnotation.class);
            Class<? extends Validator> value = annotation.value();
            Validator validator = value.newInstance();
            binder.setValidator(validator);
        }
    }
}

说明：

您可以使用WebDataBinder的getTarget方法访问要验证的目标。从那里可以直接检查类上的注释，获取validator类，并将其设置在活页夹上。我相信您还可以使用@ControllerAdvice注释来配置全局InitBinder。作为免责声明，我不知道是否建议访问InitBinder中的binder目标，但我已经这样做了几次，没有遇到任何问题。