Spring中如何验证Base64字符串？自定义校验注解实现方法

javax.validation 本身没有内置的Base64格式校验注解，你可以通过自定义校验注解来实现需求，具体步骤如下：

1. 定义自定义校验注解 #

创建@Base64Valid注解，指定关联的校验器和元数据：

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Documented
@Constraint(validatedBy = Base64Validator.class)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface Base64Valid {
    String message() default "无效的Base64格式字符串";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

2. 实现校验器逻辑 #

编写Base64Validator类，实现ConstraintValidator接口，把你需要的校验逻辑放在这里：

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Base64;

public class Base64Validator implements ConstraintValidator<Base64Valid, String> {
    @Override
    public void initialize(Base64Valid constraintAnnotation) {
        // 初始化逻辑，不需要的话留空即可
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            // 若字段允许null，返回true；若不允许，可返回false，或配合@NotNull注解一起使用
            return false;
        }
        try {
            Base64.getDecoder().decode(value);
            return true;
        } catch (IllegalArgumentException e) {
            return false;
        }
    }
}

3. 在请求体Bean中使用注解 #

直接在需要校验的Base64字段上添加@Base64Valid，可以结合其他校验注解一起用：

public class FileRequest {
    @NotBlank(message = "Base64文件内容不能为空")
    @Base64Valid(message = "文件内容不是有效的Base64格式")
    private String base64File;

    // getter、setter省略
}

另外要注意，确保你的项目已经引入了JSR-380（javax.validation）的实现依赖，比如Spring Boot项目可以引入spring-boot-starter-validation，它默认使用Hibernate Validator作为底层实现。

内容的提问来源于stack exchange，提问作者Alfredo Morales