掌握Spring Boot魔法：集合中对象属性唯一性的完美校验之道

2023-04-10 22:04:39

Spring Boot 自定义注解与校验器：打造集合对象属性唯一性校验利器

在 Spring Boot 的强大生态系统中，数据校验是一个不可或缺的功能，它帮助我们确保数据的准确性和完整性。其中，集合中对象属性的唯一性校验是一个常见且至关重要的需求。在本文中，我们将深入探讨如何利用 Spring Boot 的自定义注解和校验器来轻松实现这一校验。

集合中对象属性唯一性的重要性

在实际应用中，集合中对象属性的唯一性校验有着广泛的应用场景：

用户注册： 确保用户名和邮箱的唯一性，避免重复注册。
订单管理： 保证每个订单的订单号唯一，便于管理和追溯。
商品管理： 使商品编号保持唯一，方便库存管理和商品识别。

自定义注解与校验器的作用

自定义注解 的作用是标记需要校验的属性，指定校验规则和错误提示信息。**例如，我们可以创建一个名为 @Unique 的自定义注解，如下所示：

@Constraint(validatedBy = UniqueValidator.class)
public @interface Unique {
    String message() default "属性值不唯一";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

校验器 则是用于实现校验逻辑的 Java 类，它需要实现 ConstraintValidator 接口。**在我们的例子中，我们可以创建一个名为 UniqueValidator 的校验器，如下所示：

public class UniqueValidator implements ConstraintValidator<Unique, Object> {
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        // 校验逻辑，根据具体业务场景实现
    }
}

应用自定义注解与校验器

要应用自定义注解和校验器，我们需要在需要校验的属性上使用 @Unique 注解。例如，以下代码校验了 User 对象中 username 和 email 属性的唯一性：

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Unique
    private String username;

    @Unique
    private String email;
}

当使用 Spring Boot 进行数据校验时，@Unique 注解会触发 UniqueValidator 校验器的校验逻辑。如果校验不通过，系统将抛出相应的异常并提示自定义的错误信息。

代码示例

以下代码示例演示了如何在 Spring Boot 应用中使用自定义注解和校验器实现集合中对象属性唯一性校验：

import javax.validation.Constraint;
import javax.validation.Payload;

@Constraint(validatedBy = UniqueValidator.class)
public @interface Unique {
    String message() default "属性值不唯一";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class UniqueValidator implements ConstraintValidator<Unique, Object> {
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        // 校验逻辑
        return true;
    }
}

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Unique
    private String username;

    @Unique
    private String email;
}