Spring中自定义数据校验器

翻译：叩丁狼教育吴嘉俊

通常情况下，Spring提供的内置的校验已经足够应付绝大多数需求，但是，迟早我们可能会遇到JSR303或者Hibernate Validator不能处理的情况。在这篇文章中，我将会介绍如果在SpringBoot应用中创建自定义的校验注解。本文中介绍的内容，对于Springboot1.x和Springboot2.x均适用。

创建需求

我们来构思一个需求，我们假设在一个REST服务端中，允许在我们的应用中注册新用户。我们的目标就是校验用户不能重复登录应用。

@RestController
@RequestMapping("/users")
public class UserController {

    private UserRepository userRepository;

    public UserController(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    @PostMapping
    public void register(@RequestBody @Valid User user) {
        userRepository.save(user);
    }

}

在一个实际的应用中，我们会用到真实的持久化策略来保存我们的用户，但是在这个演示代码中，我仅仅将用户保存到一个内存列表中就可以了。另外，在持久化层中，我们提供了一个简单的方法，该方法模拟查询一个用户是否已经登录过了：

@Repository
class UserRepository {

    private List<User> registeredUsers = new LinkedList<>();

    void save(User user) {
        registeredUsers.add(user);
    }

    Optional<User> findByLogin(String login) {
        return registeredUsers.stream()
                .filter(user -> user.getLogin().equals(login))
                .findFirst();
    }

}

最后，我们来定义User数据模型。其中的login字段使用了@UniqueLogin注解，这个注解就是我们自定义的，用于做防止重复登录限制的校验注解。

public class User {

    @UniqueLogin
    private String login;
    private char[] password;

    private User() {
        // no-arg Jackson constructor
    }

    public User(String login, char[] password) {
        Objects.requireNonNull(login);
        Objects.requireNonNull(password);
        this.login = login;
        this.password = password;
    }
    // getters omitted
}

注意，因为我们需要使用Jackson来包装我们的用户对象。Jackson使用反射直接获取无参构造方法，并创建一个用户对象，再通过set方法完成属性的设置，所以这个private的无参构造方法主要提供给jackson使用。

[注，简单说明，这个文章的目的就是使用@UniqueLogin注解标记login这个属性，意思就是通过login这个属性来作为判定条件，只允许一个相同的login名称的用户登录。]

自定义注解

@UniqueLogin注解的定义看起来有点复杂，其实仔细看，也就那么回事，每一个注解都有其对应的功能。

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = UniqueLoginValidator.class)
public @interface UniqueLogin {
    String message() default "{com.dolszewski.blog.UniqueLogin.message}";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

我们的注解使用了另外的三个元注解。@Target和@Retention两个注解应该不会陌生。@Target注解表明自定义注解能够用来标记哪些元素类型，这里表明@UniqueLogin能够放在方法和字段上；@Retention代表注解保留到什么时候，这里表明需要把@UniqueLogin注解保留到运行时。

@Constraint注解会更有趣一些，这个元注解表明我们的注解是用来作为校验约束的。其中的validatedBy属性，指向了一个类，就是这个类中提供了约束检查相关的逻辑。我们待会会实现这个类。

我们的自定义标签中的其他属性，都是@Constraint必须的。如果你想了解他们的实际用处，可以查看 the JavaDoc。groups和payload两个属性默认为空即可。message属性我们设置了一个消息的key，message属性是在校验出错的时候的默认提示错误信息，这个信息我们待会配置。

错误信息

默认情况下，异常信息会从应用的classpath下的ValidationMessages.properties文件中加载。请在应用中创建一个这个文件，并在其中添加：

com.dolszewski.blog.UniqueLogin.message=The given login is already in use

实现校验器

现在我们来实现真正的校验逻辑，就是前面我们在UniqueLogin标签中validatedBy属性对应的UniqueLoginValidator类。

class UniqueLoginValidator implements ConstraintValidator<UniqueLogin, String> {

    private UserRepository userRepository;

    public UniqueLoginValidator(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public void initialize(UniqueLogin constraint) {
    }

    public boolean isValid(String login, ConstraintValidatorContext context) {
        return login != null && !userRepository.findByLogin(login).isPresent();
    }

}

首先，你主要这个类并没有使用Spring的@Component等组件标签标注，但是他仍然需要依赖Spring中管理的UserRespository，这是怎么实现的呢？原因是Spring会自动的检查所有实现了ConstraintValidator接口的类，实例化这些类，并自动注入所有的依赖。注意，在Spring4.3之后，构造器自动注入是不需要使用@Autowired注解。

ConstraintValidator接口需要两个泛型类型，第一个泛型类型是指对应的校验注解类型，第二个参数是该校验器需要用来作为校验目标的字段类型，因为我们的UniqueLogin注解是放在String login字段上的，所以第二个参数设置为String类型。

public interface ConstraintValidator<A extends Annotation, T> {

    void initialize(A constraintAnnotation);

    boolean isValid(T value, ConstraintValidatorContext context);
}

[注：上面是ConstraintValidator接口的声明]

这个接口有两个方法需要实现，initialize()方法就是验证器的初始化方法，我们保留空方法即可。isValid()方法就是验证的逻辑所在地方。那么我们在这个方法中就使用UserRepository实例来完成验证。

单元测试

最后，我们来测试一下我们的方案。因为我们的验证器依赖Spring容器，将我们的测试放在Spring容器中测试。

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserTest {

    @Autowired
    private UserRepository userRepository;
    @Autowired
    private Validator validator;

    @Test
    public void shouldValidateDuplicatedLogin() throws Exception {
        // given
        String login = "daniel";
        User predefinedUser = new User(login, "pass".toCharArray()); 
        userRepository.save(predefinedUser);
        // when
        User newUser = new User(login, "asd".toCharArray());
        Set<ConstraintViolation<User>> violations = validator.validate(newUser);
        // then
        assertEquals(1, violations.size());
    }

}

这个测试看着很奇怪。第一，我们将一个预定义的用户通过注册方法添加到repository中。下一步，我们使用Spring注入给我们的Validator抽象类来执行是否另一个相同login名字的用户是否能够同时注册。最后，我们希望验证结果中得到一个验证错误提示。

小结

在这篇文章中，我们学习了如果创建一个自定义字段验证器的步骤。通过这些内容，我们也能够创建类似@NotNull或者@Size这样非常有用的约束。

原文：http://dolszewski.com/spring/custom-validation-annotation-in-spring/

想获取更多技术视频，请前往叩丁狼官网：http://www.wolfcode.cn/openClassWeb_listDetail.html