快捷導(dǎo)航

java自定義驗(yàn)證器的實(shí)現(xiàn)示例

更新時(shí)間：2024年01月18日 08:26:43 作者：飛起的豹子

在對外暴露接口中，我們通常會對入?yún)⑦M(jìn)行驗(yàn)證，比如一些字符串非空判斷等，本文主要介紹了java自定義驗(yàn)證器的實(shí)現(xiàn)示例，具有一定的參考價(jià)值，感興趣的可以了解一下

前言

在對外暴露接口中，我們通常會對入?yún)⑦M(jìn)行驗(yàn)證，比如一些字符串非空判斷、數(shù)字最小值最大值這些基礎(chǔ)的判斷在java驗(yàn)證規(guī)范中已經(jīng)提供了，然而這些只是常規(guī)的驗(yàn)證，我們可以通過自定義注解以及驗(yàn)證器來進(jìn)行我們自己業(yè)務(wù)上的一些驗(yàn)證，這樣可以避免在業(yè)務(wù)邏輯中添加過多的驗(yàn)證，降低代碼的可讀性。

使用

1、依賴引入

僅需引入驗(yàn)證包即可，當(dāng)然，如果使用的springboot，可以直接管理依賴，不用指定版本

        <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
        </dependency>

2、自定義注解

這里添加一個(gè)銀行卡驗(yàn)證的注解，其實(shí)核心注解就是@Constraint，這個(gè)注解要求我們的注解中必須有message()groups()以及payload()這三個(gè)方法

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

/**
 * 銀行卡號校驗(yàn)注解
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
// 這里指定驗(yàn)證器
@Constraint(validatedBy = {BankCardValidator.class})
@Target({ElementType.FIELD,ElementType.ANNOTATION_TYPE,ElementType.PARAMETER})
public @interface BankCardValidity {

    /**
     * 提示信息
     * @return String
     */
    String message() default "";

    /**
     * 是否驗(yàn)證
     * @return boolean
     */
    boolean required() default true;

    /**
     * groups
     * @return []
     */
    Class<?>[] groups() default {};


    /**
     * payload
     * @return []
     */
    Class<? extends Payload>[] payload() default {};
}

3、編寫驗(yàn)證器

驗(yàn)證器的核心是實(shí)現(xiàn)ConstraintValidator這個(gè)類，第一個(gè)參數(shù)是指定注解，第二個(gè)則是指定的入?yún)?/p>

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * 銀行卡號校驗(yàn)器
 */
public class BankCardValidator implements ConstraintValidator<BankCardValidity,String> {

    /**
     * 是否強(qiáng)制驗(yàn)證
     */
    private boolean required = false;

    /**
     * 銀行卡號正則校驗(yàn),這里就是一個(gè)正則驗(yàn)證
     */
    private static Pattern patternForBankCardNo = Pattern.compile("^([1-9]{1})(\\d{15}|\\d{18})$");
	
	/**
	 * 這里就是驗(yàn)證邏輯，返回true驗(yàn)證通過，返回false驗(yàn)證不通過
	 */
    @Override
    public boolean isValid(String bankCardNo, ConstraintValidatorContext context) {
        if (required) {
            return isBankCardNo(bankCardNo);
        } else {
            if (StrUtil.isBlank(bankCardNo)) {
                return false;
            }
            return isBankCardNo(bankCardNo);
        }
    }

    @Override
    public void initialize(BankCardValidity validity) {
        required = validity.required();
    }

    /**
     * 驗(yàn)證是否為銀行卡號
     * @param bankCardNo 輸入內(nèi)容
     * @return boolean
     */
    private static boolean isBankCardNo(String bankCardNo) {
        // 使用的hutool工具包，也可以使用其它工具包
        if (StrUtil.isBlank(bankCardNo)) {
            return false;
        }
        Matcher matcherForBankCardNo = patternForBankCardNo.matcher(bankCardNo);
        return matcherForBankCardNo.matches() ;
    }
}

至此編碼就完成了，我們可以在注解中添加新的方法，在initialize()方法中使用，或者取值等操作，這都是根據(jù)業(yè)務(wù)場景來進(jìn)行的。
當(dāng)然，在入?yún)⑿z中，我們肯定也需要把@Valid等注解加上，驗(yàn)證器才會去驗(yàn)證。

到此這篇關(guān)于java自定義驗(yàn)證器的實(shí)現(xiàn)示例的文章就介紹到這了,更多相關(guān)java自定義驗(yàn)證器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: