Spring自定义Validator未触发调用问题排查求助

1. 检查自定义注解的元数据配置 #

确保@NameValidation注解正确关联验证器，且元注解配置完整：

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = NameValidator.class) // 必须指定对应验证器类
public @interface NameValidation {
    String message() default "Invalid name";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

• 必须包含@Constraint(validatedBy = ...)，否则Spring无法识别关联的验证器
• @Retention必须设为RUNTIME，保证注解在运行时能被反射读取

2. 验证器类实现规范 #

确认NameValidator正确实现ConstraintValidator接口，重写核心方法：

public class NameValidator implements ConstraintValidator<NameValidation, String> {
    @Override
    public void initialize(NameValidation constraintAnnotation) {
        // 可选初始化逻辑
    }

    @Override
    public boolean isValid(String name, ConstraintValidatorContext context) {
        // 自定义验证逻辑，示例：仅允许字母
        return name != null && name.matches("^[A-Za-z]+$");
    }
}

• 泛型参数需匹配：第一个是自定义注解类，第二个是待验证字段的类型（如String）
• isValid方法必须返回布尔值，不要遗漏核心校验逻辑

3. 实体类字段注解使用 #

检查Person类的name字段是否正确标注@NameValidation：

public class Person {
    @NameValidation
    private String name;
    // 其他字段、getter/setter方法
}

• 确保注解直接作用在需要验证的字段上，不要遗漏或误标

4. 控制器层触发验证 #

在控制器请求方法的参数上添加@Valid或@Validated注解，触发Spring的验证机制：

@RestController
@RequestMapping("/persons")
public class PersonController {
    @Autowired
    private PersonService personService;

    @PostMapping
    public ResponseEntity<Person> createPerson(@Valid @RequestBody Person person) {
        Person savedPerson = personService.savePerson(person);
        return ResponseEntity.ok(savedPerson);
    }
}

• 若使用分组验证，需用@Validated(Group.class)，并在@NameValidation的groups属性中指定对应分组
• Spring Boot项目默认支持@Valid，非Boot项目需确保启用了mvc验证配置

5. 依赖配置检查（pom.xml） #

确保pom.xml中包含Spring Validation相关依赖，Spring Boot项目可直接引入：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

• 非Spring Boot项目，需引入hibernate-validator和spring-context-support，版本需与Spring版本兼容

6. 服务层验证（若需） #

如果要在服务层触发验证，需在服务类或方法上添加@Validated注解：

@Service
@Validated
public class PersonService {
    public Person savePerson(@Valid Person person) {
        // 保存逻辑
        return person;
    }
}

• 服务层仅用@Valid无法触发验证，必须搭配@Validated

7. 验证异常排查 #

若验证已触发但未被捕获，可能误以为未调用。可添加全局异常处理器查看：

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationErrors(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getAllErrors().forEach(error -> {
            String fieldName = ((FieldError) error).getField();
            String errorMsg = error.getDefaultMessage();
            errors.put(fieldName, errorMsg);
        });
        return ResponseEntity.badRequest().body(errors);
    }
}

内容的提问来源于stack exchange，提问作者AppleBees