spring?boot項(xiàng)目自定義參數(shù)校驗(yàn)規(guī)則示例詳解

更新時(shí)間：2023年07月07日 08:18:43 作者：醬油何在

這篇文章主要介紹了spring boot項(xiàng)目如何自定義參數(shù)校驗(yàn)規(guī)則,自定義校驗(yàn)規(guī)則和自帶的規(guī)則實(shí)現(xiàn)方式一樣，先自定義一個(gè)注解，然后指定校驗(yàn)類，在校驗(yàn)類里實(shí)現(xiàn)具體的校驗(yàn)規(guī)則，本文結(jié)合示例代碼給大家介紹的非常詳細(xì)，需要的朋友可以參考下

spring boot項(xiàng)目對參數(shù)進(jìn)行校驗(yàn)時(shí)，比如非空校驗(yàn)，可以直接用validation包里面自帶的注解。但是對于一些復(fù)雜的參數(shù)校驗(yàn)，自帶的校驗(yàn)規(guī)則無法滿足要求，此時(shí)需要我們自定義參數(shù)校驗(yàn)規(guī)則。自定義校驗(yàn)規(guī)則和自帶的規(guī)則實(shí)現(xiàn)方式一樣，先自定義一個(gè)注解，然后指定校驗(yàn)類，在校驗(yàn)類里實(shí)現(xiàn)具體的校驗(yàn)規(guī)則。

下面以校驗(yàn)手機(jī)號(hào)為例，來實(shí)現(xiàn)自定義參數(shù)校驗(yàn)規(guī)則。

首先定義一個(gè)注解，直接照著NotNull注解定義即可。

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
//這里的class就是實(shí)現(xiàn)具體校驗(yàn)規(guī)則的類
@Constraint(validatedBy = {MobileNoValidator.class})
public @interface MobileNo {
    String message() default "請輸入正確的手機(jī)號(hào)";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

然后定義實(shí)現(xiàn)具體校驗(yàn)規(guī)則的類，這個(gè)類要實(shí)現(xiàn)ConstraintValidator接口。

public class MobileNoValidator implements ConstraintValidator<MobileNo, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if ((value == null)) {
            return false;
        }
        String regex = "^1\\d{10}$";
        Pattern p = Pattern.compile(regex, Pattern.CASE_INSENSITIVE);
        Matcher m = p.matcher(value);
        return m.matches();
    }
}

這樣，很簡單的兩個(gè)類，就實(shí)現(xiàn)了自定義參數(shù)校驗(yàn)規(guī)則。當(dāng)參數(shù)中加了MobileNo注解，如果輸入的手機(jī)號(hào)不滿足1打頭的11位數(shù)字的規(guī)則，就會(huì)拋出異常信息。下面寫個(gè)controller簡單測試一下。

先定義一個(gè)vo。

public class UserVo {
    @NotNull
    private Long id;
    @NotNull
    @MobileNo
    private String mobileNo;
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getMobileNo() {
        return mobileNo;
    }
    public void setMobileNo(String mobileNo) {
        this.mobileNo = mobileNo;
    }
}

再定一個(gè)controller。

@RestController
public class UserController {
    @PostMapping(value = "/test")
    public String test(@Validated @RequestBody UserVo userVo) {
        return "success";
    }
}

啟動(dòng)項(xiàng)目，用postman測試一下。

首先輸入符合要求的手機(jī)號(hào)，這時(shí)是能正常返回success。

然后輸入一個(gè)不符合要求的手機(jī)號(hào)，會(huì)返回400錯(cuò)誤碼，錯(cuò)誤信息如下。當(dāng)然這里返回的錯(cuò)誤信息比較不友好，實(shí)際項(xiàng)目中可以對參數(shù)校驗(yàn)異常統(tǒng)一攔截，返回需要的數(shù)據(jù)格式。

到此這篇關(guān)于spring boot項(xiàng)目如何自定義參數(shù)校驗(yàn)規(guī)則的文章就介紹到這了,更多相關(guān)spring boot自定義參數(shù)校驗(yàn)規(guī)則內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: