javax.validation 自定义校验注解

本文深入探讨了如何在Java中使用 javax.validation 框架自定义校验注解,包括创建注解、定义验证器、元注解的使用以及在实际项目中的应用示例,帮助开发者提升数据验证的灵活性和定制化。
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Target( {ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = TypeEnumValidator.class)
@Documented
public @interface TypeConstraint {
    String message() default "pricing rule type is incorrect";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;

public class TypeEnumValidator implements ConstraintValidator<TypeConstraint, Type> {

    private String message;

    @Override
    public void initialize(PriceRuleTypeConstraint annotation) {
        message = annotation.message();
    }

    @Override
    public boolean isValid(type value, ConstraintValidatorContext context) {
        return Arrays.stream(Type.values()).anyMatch(type -> Type.equals(value));
    }
}

public enum Type {
    TIME,
    DATE,
    DATE_TIME
}
### 问题分析 在 Java 开发中,当遇到 `javax.validation.constraints` 包不存在的问题时,通常意味着项目依赖配置存在问题。随着 Spring Boot 版本的升级(尤其是从 2.x 升级到 3.x),Java EE 的命名空间发生了变化,`javax.*` 被替换为 `jakarta.*`。因此,在使用 Spring Boot 3.x 时,原本引用 `javax.validation.constraints` 的代码将无法编译通过 [^1]。 此外,如果项目未正确引入验证模块(如 `spring-boot-starter-validation`),也会导致该包无法找到,进而影响 `@Email`、`@NotBlank`、`@NotNull` 和 `@Size` 等注解的正常使用 [^1]。 --- ### 解决方案 #### 使用 Spring Boot 3.x 时的修复方法 在 Spring Boot 3.x 中,`javax.validation.constraints` 已被替换为 `jakarta.validation.constraints`。因此,项目中的相关导入语句需要更新为新的命名空间: ```java import jakarta.validation.constraints.Email; import jakarta.validation.constraints.NotBlank; import jakarta.validation.constraints.NotNull; import jakarta.validation.constraints.Size; ``` 同时,确保 `pom.xml` 文件中包含以下依赖,以支持 Jakarta Validation API: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> ``` 该依赖会自动引入 `jakarta.validation` 的实现,从而支持 Bean Validation 功能 。 #### 使用 Spring Boot 2.x 时的修复方法 如果项目仍在使用 Spring Boot 2.x,并希望继续使用 `javax.validation.constraints`,则需确保 `spring-boot-starter-validation` 被正确引入: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> ``` 此方式可确保 `@NotBlank`、`@NotNull`、`@Email` 和 `@Size` 等注解正常工作 [^1]。 #### 手动添加 Jakarta Validation 依赖(适用于自定义构建) 如果不使用 Spring Boot 提供的 starter 包,也可以手动引入 Jakarta Validation 的核心依赖: ```xml <dependency> <groupId>jakarta.validation</groupId> <artifactId>jakarta.validation-api</artifactId> <version>3.0.0</version> </dependency> ``` 此方式适用于对依赖结构有精细控制需求的项目 。 --- ### 注解功能说明 - `@NotBlank`:用于验证字符串是否非空且至少包含一个非空白字符,常用于 `String` 类型字段。 - `@NotNull`:确保字段不为 `null`,适用于基本数据类型和包装类型(如 `Integer`)。 - `@Email`:验证字段是否符合电子邮件格式。 - `@Size`:限制字符串长度或集合大小在指定范围内 [^3]。 这些注解可以结合 `@Valid` 在控制器中进行参数校验,提升应用的数据安全性与健壮性。 --- ### 总结 解决 `javax.validation.constraints` 包缺失的问题,主要取决于所使用的 Spring Boot 版本: - **Spring Boot 3.x**:使用 `jakarta.validation.constraints` 并引入 `spring-boot-starter-validation`。 - **Spring Boot 2.x**:确保 `spring-boot-starter-validation` 已被引入,以支持 `javax.validation.constraints`。 通过上述方式可以有效避免因验证注解缺失而导致的编译错误。 ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值