java 字符串长度校验用什么注解

原创

mob64ca12f58d71 2024-09-02 03:48:49 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12f58d71的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 字符串长度校验注解指南

在Java中，当我们需要对字符串进行长度校验时，通常会使用注解（Annotation）来简化和规范这些校验步骤。本文将为刚入行的小白们详细讲解如何实现字符串长度的校验，带你一步步学习如何使用注解。

流程概述

我们可以将整个实现过程拆分为以下几个步骤：

步骤	操作
1	创建自定义注解
2	创建验证器类
3	实现注解逻辑
4	使用注解进行校验

流程图

我们可以使用 mermaid 语法来展示这个流程：

flowchart TD
    A[创建自定义注解] --> B[创建验证器类]
    B --> C[实现注解逻辑]
    C --> D[使用注解进行校验]

步骤详解

第一步：创建自定义注解

首先，我们需要创建一个自定义注解，比如叫 @Length。这个注解将用于指定字符串的最小和最大长度。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

// 自定义注解
@Target(ElementType.FIELD) // 注解适用于字段
@Retention(RetentionPolicy.RUNTIME) // 注解将在运行时可用
public @interface Length {
    int min() default 0; // 默认最小长度为0
    int max() default Integer.MAX_VALUE; // 默认最大长度为Integer的最大值
}

第二步：创建验证器类

接下来，我们需要创建一个验证器类，用于处理这个注解的逻辑。

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

// 验证器类
public class LengthValidator implements ConstraintValidator<Length, String> {
    
    private int min; // 最小长度
    private int max; // 最大长度

    // 初始化方法
    @Override
    public void initialize(Length length) {
        this.min = length.min();
        this.max = length.max();
    }

    // 进行校验的方法
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 检查字符串是否为null
        if (value == null) {
            return true; // 如果为null不进行校验
        }
        // 校验字符串长度是否在范围内
        return value.length() >= min && value.length() <= max;
    }
}

第三步：实现注解逻辑

在验证器中，我们定义了 isValid 方法来检查字符串的长度是否在我们指定的范围内。若字符串为 null，则不做校验（通常，我们可以用其他机制来处理）。

第四步：使用注解进行校验

现在我们可以在我们的实体类中使用这个注解来校验字符串长度，例如：

import javax.validation.constraints.NotNull;

public class User {
    @NotNull // 确保不能为空
    @Length(min = 5, max = 15) // 字符串长度校验
    private String username;

    // getter and setter
    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }
}

在这个例子中，username 字段的长度必须在5到15个字符之间。

测试与验证

要测试上述逻辑，我们可以使用下面的代码：

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import javax.validation.ConstraintViolation;

import java.util.Set;

public class Main {
    public static void main(String[] args) {
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        
        User user = new User();
        user.setUsername("abc"); // 设置一个不符合长度的用户名
        
        Set<ConstraintViolation<User>> violations = validator.validate(user);

        for (ConstraintViolation<User> violation : violations) {
            System.out.println(violation.getMessage()); // 输出校验错误信息
        }
    }
}

在这个测试代码中，我们创建了一个 User 对象，并试图设置一个不符合长度限制的 username，验证会提示错误。