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

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

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

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

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

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

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

然后定義實現(xiàn)具體校驗規(guī)則的類，這個類要實現(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();
    }
}

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

先定義一個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;
    }
}

再定一個controller。

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

啟動項目，用postman測試一下。

首先輸入符合要求的手機號，這時是能正常返回success。