非Controller控制層參數(shù)校驗要怎么做

作者：索碼理 2024-03-26 08:17:00

本文介紹了在非Controller控制層參數(shù)校驗的兩種方法，不管是哪種獲取方法只要能達到結果就行，不過建議使用后者，可以把后者封裝成工具類，統(tǒng)一管理校驗方法。

上篇文章中我們介紹了如何自定義Springboot參數(shù)約束注解和約束校驗器，默認情況下，Springboot中的參數(shù)校驗都是在Controller控制層完成的，那如果我們想要在非Controller控制層進行參數(shù)校驗要怎么辦呢？本文將介紹非Controller控制層參數(shù)校驗的方法。

看源碼

從上篇文章中我們知道Spring提供了JSR-303 的一個變種 @Validated ，下面我們看一下 @Validated 的部分源碼。

圖片

Validator

看注釋官方是讓我們?nèi)タ纯碫alidator#validate() 方法，官方讓我看我們就去看唄，索性直接看Validator 源碼：

public interface Validator {

 <T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups);

 <T> Set<ConstraintViolation<T>> validateProperty(T object,
              String propertyName,
              Class<?>... groups);

 <T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType,
              String propertyName,
              Object value,
              Class<?>... groups);

 BeanDescriptor getConstraintsForClass(Class<?> clazz);

 <T> T unwrap(Class<T> type);

 ExecutableValidator forExecutables();
}

那Validator是做什么用的呢？

Validator 接口定義了用于執(zhí)行驗證的方法，用于驗證對象的字段值是否符合指定的約束條件。它主要提供了以下幾個核心方法：

<T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups)：

該方法用于驗證給定對象是否符合指定的約束條件。

參數(shù) object是要驗證的對象，參數(shù) groups可選，表示驗證組。

返回一個 Set 集合，其中包含違反約束條件的 ConstraintViolation 對象。

<T> Set<ConstraintViolation<T>> validateProperty(T object, String propertyName, Class<?>... groups)：

該方法用于驗證給定對象的特定屬性是否符合指定的約束條件。

參數(shù) object是要驗證的對象，參數(shù) propertyName是屬性名，參數(shù) groups可選，表示驗證組。

返回一個 Set 集合，其中包含違反約束條件的 ConstraintViolation 對象。

<T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups)：

該方法用于驗證給定屬性值是否符合指定的約束條件，而不需要實際創(chuàng)建對象實例。

參數(shù) beanType是對象類型，參數(shù) propertyName是屬性名，參數(shù) value是屬性值，參數(shù) groups可選，表示驗證組。

返回一個 Set 集合，其中包含違反約束條件的 ConstraintViolation 對象。

這些方法能夠?qū)?Java 對象進行全面的驗證，從整個對象級別到單個屬性值的驗證，都可以通過 Validator 接口提供的方法來實現(xiàn)。

實操

從上面的介紹我們可以看到，實際上參數(shù)校驗是通過 Validator 接口的實現(xiàn)類來驗證的。下面我們通過代碼來看一下 Validator 接口怎么用？

先把我們的老演員拿出來，下面再校驗就用它了。

@Data
public class UserBean {

    @NotBlank
    private String username;

    @Min(value = 18)
    private Integer age;
}

依賴Spring 容器

JSR 303 提供了 Validator 接口作為規(guī)范接口，用于實現(xiàn)數(shù)據(jù)校驗功能。在實際應用中，我們并不需要自己從頭開始實現(xiàn)這一接口，因為已經(jīng)有官方參考實現(xiàn)——Hibernate Validator。Spring 框架作為廣泛使用的Java開發(fā)框架，自然也遵循這一原則，它并沒有重復造輪子，而是采用了 Hibernate Validator 的實現(xiàn)來支持校驗功能。

因此，當我們使用 Spring 框架進行開發(fā)時，通常意味著我們可以直接利用 Spring 提供的集成，將 Validator 接口注入到我們的組件中，然后方便地使用它來進行數(shù)據(jù)校驗。

下面來看下如何在Springboot中使用 Validator 接口。

@SpringBootTest
class SpringbootPracticeApplicationTests {
 @Resource
    private Validator validator;

 @Test
    public void testValidator(){
        UserBean userBean = new UserBean();
        userBean.setAge(17);
        userBean.setUsername(null);

        Set<ConstraintViolation<UserBean>> constraintViolations = validator.validate(userBean);
        System.out.println("validate 校驗對象屬性：");
        System.out.println(constraintViolations);
        System.out.println();

        constraintViolations = validator.validateProperty(userBean, "age");
        System.out.println("validateProperty校驗age屬性是否合規(guī)：");
        System.out.println(constraintViolations);
        System.out.println();

        constraintViolations = validator.validateValue(UserBean.class , "age", 14 );
        System.out.println("validateValue校驗age屬性的值是否合規(guī)：");
        System.out.println(constraintViolations);
    }
}

測試結果：

validate 校驗對象屬性：
[ConstraintViolationImpl{interpolatedMessage='不能為空', propertyPath=username, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.NotBlank.message}'}, 
ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]

validateProperty校驗age屬性是否合規(guī)：
[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]

validateValue校驗age屬性的值是否合規(guī)：
[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]

從打印結果中可以發(fā)現(xiàn)具體是哪些字段約束不通過、具體的提示信息都有。

不依賴Spring 容器

JSR 303 是一種規(guī)范，意味著它不依賴Spring 容器，能用Java的地方都可以用它，那如果我們在非Spring框架的項目中怎么使用它呢？

其實，最主要的是能獲取到 Validator 接口的實現(xiàn)，然后就可以進行驗證了。Validator 接口的實現(xiàn)可以通過如下代碼獲取，前提是要引入 Hibernate Validator 的依賴或者自己重新造輪子實現(xiàn)Validator 接口。

public class ValidationUtils {

    public static Validator getValidator(){
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        return factory.getValidator();
    }
}

/**
 * @author 公眾號-索碼理(suncodernote)
 */
public class ValidatorTest {
    public static void main(String[] args) {
        Validator validator = ValidationUtils.getValidator();

        UserBean userBean = new UserBean();
        userBean.setAge(17);
        userBean.setUsername(null);

        Set<ConstraintViolation<UserBean>> constraintViolations = validator.validate(userBean);
        System.out.println("validate 校驗對象屬性：");
        System.out.println(constraintViolations);
        System.out.println();

        constraintViolations = validator.validateProperty(userBean, "age");
        System.out.println("validateProperty校驗age屬性是否合規(guī)：");
        System.out.println(constraintViolations);
        System.out.println();

        constraintViolations = validator.validateValue(UserBean.class , "age", 14 );
        System.out.println("validateValue校驗age屬性的值是否合規(guī)：");
        System.out.println(constraintViolations);
    }
}

打印結果：

23:57:10.700 [main] INFO org.hibernate.validator.internal.util.Version -- HV000001: Hibernate Validator 8.0.1.Final
validate 校驗對象屬性：
[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}, 
ConstraintViolationImpl{interpolatedMessage='不能為空', propertyPath=username, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.NotBlank.message}'}]

validateProperty校驗age屬性是否合規(guī)：
[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]

validateValue校驗age屬性的值是否合規(guī)：
[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]

可以看到依賴Spring 容器和不依賴Spring 容器，兩者的調(diào)用結果都是相同的，不同之處就在于 Validator 的獲取，前者直接從 Spring 容器獲取，后者需要通過工廠類獲取，適用范圍更廣一點，在Spring框架中也能使用。

總結

責任編輯：武曉燕來源：索碼理

Controller 參數(shù)校驗