bios校验 boot的校验注解 springboot自动配置源

本文深入探讨了 Spring Boot 中自定义 `ConstraintValidator` 依赖注入失败导致 `NullPointerException` 的常见问题。通过将校验器嵌入注解内部并配置 `LocalValidatorFactoryBean`，可以有效解决此问题。同时，文章还介绍了如何利用 `existsBy` 查询优化数据库存在性检查，提升应用性能。

在 Spring Boot 应用中，我们经常需要对用户输入的数据进行校验。除了使用 @NotNull、@NotEmpty、@Pattern 等内置校验注解外，业务逻辑可能需要更复杂的自定义校验规则。javax.validation (Bean Validation API) 允许我们通过创建自定义注解和 ConstraintValidator 实现这些规则。

一个典型的自定义校验器由两部分组成：

例如，为了确保用户注册时邮箱的唯一性，我们可以定义一个 UniqueEmail 注解：

// UniqueEmail.java@Constraint(validatedBy = UniqueEmailValidator.class)@Retention(RetentionPolicy.RUNTIME)@Target({ ElementType.FIELD })public @interface UniqueEmail {    public String message() default "There is already user with this email!";    public Class<?>[] groups() default {};    public Class<? extends Payload>[] payload() default{};}

以及其对应的校验器：

// UniqueEmailValidator.java@Component // 尝试将其注册为Spring Beanpublic class UniqueEmailValidator implements ConstraintValidator<UniqueEmail, String> {    @Autowired    private UserService userService; // 依赖注入 UserService    @Override    public boolean isValid(String value, ConstraintValidatorContext context) {        // 校验逻辑：检查邮箱是否已存在        return value != null && !userService.findUserByUserEmail(value);    }}

在 User 实体或 DTO 中使用：

// User.class (或 UserRequestDTO)@NotNull@NotEmpty@UniqueEmail // 应用自定义校验private String email;

然后在 Controller 层通过 @Valid 触发校验：

// UserController.java@RestControllerpublic class UserController {   @Autowired   private UserService userService;   @PostMapping(path = "api/addUser", consumes = "application/json")   public GenericResponseMessage addUser(@Valid @RequestBody UserRequestDTO userRequestDTO){      userService.createUser(userRequestDTO);      return new GenericResponseMessage("ok");   }}

尽管我们在 UniqueEmailValidator 上添加了 @Component 注解，并尝试通过 @Autowired 注入 UserService，但在实际运行时，userService 仍然可能为 null，导致 isValid 方法中调用 userService.findUserByUserEmail(value) 时抛出 NullPointerException。

错误堆栈通常会显示类似 javax.validation.ValidationException: HV000028: Unexpected exception during isValid call. 和 java.lang.NullPointerException，指向 UniqueEmailValidator.isValid 方法。

根本原因：Bean Validation 规范（Hibernate Validator 是其实现）在默认情况下，可能不会通过 Spring 的应用上下文来实例化 ConstraintValidator。这意味着即使 UniqueEmailValidator 被标记为 @Component，当 Hibernate Validator 需要一个 UniqueEmailValidator 实例时，它可能直接通过 new 关键字创建，而不是从 Spring 容器中获取。这样一来，Spring 的 @Autowired 机制就无法生效，导致 userService 依赖注入失败，保持为 null。

要解决 ConstraintValidator 中的依赖注入问题，我们需要确保 ConstraintValidator 的实例是由 Spring 容器管理的。

一种常见的做法是将 ConstraintValidator 类定义为自定义校验注解的静态内部类。这种方式可以提高代码的内聚性，并且在某些情况下，Spring 框架能够更好地识别并管理这些内部校验器。

// UniqueEmail.javaimport javax.validation.Constraint;import javax.validation.ConstraintValidator;import javax.validation.ConstraintValidatorContext;import javax.validation.Payload;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Component; // 可以保留，但核心是下面的LocalValidatorFactoryBeanimport java.lang.annotation.Documented;import java.lang.annotation.Retention;import java.lang.annotation.Target;import static java.lang.annotation.ElementType.FIELD;import static java.lang.annotation.RetentionPolicy.RUNTIME;@Documented@Target(FIELD)@Retention(RUNTIME)@Constraint(validatedBy = UniqueEmail.Validator.class) // 关联内部类public @interface UniqueEmail {    String message() default "There is already a user with this email!";    Class<?>[] groups() default {};    Class<? extends Payload>[] payload() default {};    // 将 ConstraintValidator 定义为注解的静态内部类    @Component // 确保Spring能够扫描到并管理这个内部类    class Validator implements ConstraintValidator<UniqueEmail, String> {        @Autowired        private UserService userService; // 依赖注入 UserService        @Override        public void initialize(UniqueEmail constraintAnnotation) {            // 可选：初始化逻辑        }        @Override        public boolean isValid(String email, ConstraintValidatorContext context) {            // 确保 email 不为 null，并且 UserService 已被正确注入            return email != null && !userService.existsUserByEmail(email); // 使用优化后的 existsByEmail 方法        }    }}

注意： 即使将 Validator 定义为内部类，@Component 注解仍然很重要，它告诉 Spring 这是一个需要被管理的 Bean。

为了让 Spring Boot 应用程序能够正确地将 ConstraintValidator 实例与 Spring 容器集成，我们需要显式地配置一个 LocalValidatorFactoryBean。LocalValidatorFactoryBean 是 Spring 对 javax.validation.ValidatorFactory 的一个封装，它允许 Spring 管理 ConstraintValidator 的生命周期和依赖注入。

用人工智能ChatGPT帮你解答所有建筑问题

创建一个配置类：

// ValidationConfiguration.javaimport org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.Primary;import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;@Configurationpublic class ValidationConfiguration {    @Bean    @Primary // 如果存在多个 Validator Bean，@Primary 确保此 Bean 被优先使用    public LocalValidatorFactoryBean localValidatorFactoryBean() {        return new LocalValidatorFactoryBean();    }}

通过这个配置，Spring Boot 将使用 LocalValidatorFactoryBean 来创建和管理 ConstraintValidator 实例。当 LocalValidatorFactoryBean 创建校验器时，它会利用 Spring 的应用上下文来解析校验器内部的 @Autowired 依赖，从而确保 UserService 等依赖能够被正确注入。

在 UserService 和 UserRepository 中，为了检查邮箱是否存在，原先的代码可能使用了 findByEmail 并检查返回结果是否为 null 或空。这种方式通常会从数据库中加载整个实体对象，即使我们只需要知道它是否存在。

为了提高性能，Spring Data JPA 提供了 existsBy 关键字，可以直接生成 SQL EXISTS 查询，避免不必要的数据加载。

更新 UserRepository：

// UserRepository.javaimport org.springframework.data.jpa.repository.JpaRepository;public interface UserRepository extends JpaRepository<User,Long> {   // 推荐使用 existsBy 替代 findBy 来检查是否存在   boolean existsByEmail(String email);   // 如果需要，也可以为其他字段添加 existsBy   // boolean existsByUsername(String username);}

更新 UserService：

// UserService.javaimport org.springframework.stereotype.Service;@Servicepublic class UserService {    private final UserRepository userRepository;    // ... 其他字段和构造函数    public UserService(UserRepository userRepository) {        this.userRepository = userRepository;        // ...    }    // 优化后的方法，使用 existsByEmail    public boolean existsUserByEmail(String email){        return userRepository.existsByEmail(email);    }    // 原来的 findUserByUserEmail 方法可以移除或修改为返回 Optional<User>    // public boolean findUserByUserEmail(String email){    //     // 假设 userRepository.findByEmail(email) 返回 Optional<User>    //     return userRepository.findByEmail(email).isPresent();    // }}

更新 UniqueEmail.Validator：

确保 UniqueEmail.Validator 调用的是 UserService 中优化后的 existsUserByEmail 方法。

// UniqueEmail.java (内部 Validator 类)// ...    class Validator implements ConstraintValidator<UniqueEmail, String> {        @Autowired        private UserService userService;        // ...        @Override        public boolean isValid(String email, ConstraintValidatorContext context) {            return email != null && !userService.existsUserByEmail(email); // 调用优化后的方法        }    }// ...

通过以上步骤，我们解决了 Spring Boot 中自定义 ConstraintValidator 依赖注入失败的 NullPointerException 问题，并对数据库存在性检查进行了性能优化。

关键点回顾：

遵循这些最佳实践，可以构建出更健壮、性能更优的 Spring Boot 应用程序。

以上就是Spring Boot 自定义校验器依赖注入失效（NPE）问题及解决方案的详细内容，更多请关注乐哥常识网其它相关文章！