SpringBoot自定義validation注解校驗參數只能為指定的值

目錄

• 自定義校驗注解
• 使用

需求：實體類中某個屬性的值必須為指定的值，比如 0 或者 1

SpringBoot 版本：2.4.8

validation 依賴

<!--數據校驗-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

自定義校驗注解

1、創建自定義校驗注解 EnumValue

package com.pro.utils;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 枚舉校驗注解
 */
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {EnumValueValidator.class})
public @interface EnumValue {

    // 默認錯誤消息
    String message() default "必須為指定值";

    String[] strValues() default {};

    int[] intValues() default {};

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

    // 負載
    Class<? extends Payload>[] payload() default {};

    // 指定多個時使用
    @Target({FIELD, METHOD, PARAMETER, ANNOTATION_TYPE})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        EnumValue[] value();
    }
}

2、創建 EnumValue 校驗注解處理類 EnumValueValidator

package com.pro.utils;

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

/**
 * 枚舉校驗注解處理類
 */
public class EnumValueValidator implements ConstraintValidator<EnumValue, Object> {

    private String[] strValues;
    private int[] intValues;

    @Override
    public void initialize(EnumValue constraintAnnotation) {
        strValues = constraintAnnotation.strValues();
        intValues = constraintAnnotation.intValues();
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        if (value instanceof String) {
            for (String s : strValues) {
                if (s.equals(value)) {
                    return true;
                }
            }
        } else if (value instanceof Integer) {
            for (int s : intValues) {
                if (s == ((Integer) value).intValue()) {
                    return true;
                }
            }
        }
        return false;
    }
}

使用

可以指定整數類型和字符串類型的參數，就可以像 validation 的注解一樣使用了

package com.pro.dto.user;

import com.pro.utils.EnumValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotNull;

/**
 * 更新用戶參數
 */
@ApiModel("更新用戶參數")
public class UpdateUserDto {

    @ApiModelProperty(value = "用戶id", name = "uid", required = true)
    @NotNull
    private Integer uid;

    @ApiModelProperty(value = "賬戶狀態", name = "active", required = true)
    @EnumValue(intValues = {0, 1}, message = "賬戶狀態只能是0或者1")
    private Integer active;

	// 文章類型 blog 博客，photo 作品
    @ApiModelProperty(value = "文章類型", name = "type", required = true)
    @EnumValue(strValues = {"blog", "photo"}, message = "文章類型只能是blog或者photo")
    private String type;
    
}