@Validated
@Data
@ConfigurationProperties(prefix = "app")
@Component
public class AppConfigProperties {
    @NotEmpty(message = "配置文件配置必須要配置[app.id]屬性")
    private String id;
}

上面的配置就會校驗我們在 application.yml中有沒有配置 app.id參數(shù)。如果在配置文件中沒有該配置，項目啟動就會失敗，并拋出校驗異常。

在使用配置文件校驗時，必須使用@configurationproperties注解，@value不支持該注解。

在需要使用app.id的時候注入配置類即可：

@Autowired
private AppConfigProperties appConfigProperties;

這樣就可以實現(xiàn)我們想要的效果，如下圖：

效果

校驗類型

校驗規(guī)則	規(guī)則說明
@Null	限制只能為null
@NotNull	限制必須不為null
@AssertFalse	限制必須為false
@AssertTrue	限制必須為true
@DecimalMax(value)	限制必須為一個不大于指定值的數(shù)字
@DecimalMin(value)	限制必須為一個不小于指定值的數(shù)字
@Digits(integer,fraction)	限制必須為一個小數(shù)，且整數(shù)部分的位數(shù)不能超過integer，小數(shù)部分的位數(shù)不能超過fraction
@Future	限制必須是一個將來的日期
@Max(value)	限制必須為一個不大于指定值的數(shù)字
@Min(value)	限制必須為一個不小于指定值的數(shù)字
@Past	驗證注解的元素值（日期類型）比當(dāng)前時間早
@Pattern(value)	限制必須符合指定的正則表達式
@Size(max,min)	限制字符長度必須在min到max之間
@NotEmpty	驗證注解的元素值不為null且不為空（字符串長度不為0、集合大小不為0）
@NotBlank	驗證注解的元素值不為空（不為null、去除首位空格后長度為0），不同于@NotEmpty，@NotBlank只應(yīng)用于字符串且在比較時會去除字符串的空格
@Email	驗證注解的元素值是Email，也可以通過正則表達式和flag指定自定義的email格式

Validation 支持如下幾種校驗，可以滿足基本的業(yè)務(wù)邏輯，當(dāng)然如果還是滿足不了你的業(yè)務(wù)邏輯，可以選擇定制校驗規(guī)則。

定制校驗邏輯

定義校驗邏輯規(guī)則，實現(xiàn) org.springframework.validation.Validator

public class ConfigPropertiesValidator implements Validator {
    @Override
    public boolean supports(Class<?> aClass) {
        return AppConfigProperties.class.isAssignableFrom(aClass);
    }
     @Override
    public void validate(Object o, Errors errors) {
        AppConfigProperties config = (AppConfigProperties) o;
        if(StringUtils.isEmpty(config.getId())){
            errors.rejectValue("id", "app.id.empty", "[app.id] 屬性必須要在配置文件配置");
        }else if (config.getId().length() < 5) {
            errors.rejectValue("id", "app.id.short", "[app.id] 屬性的長度必須不能小于5");
        }
    }
}

使用自定義校驗規(guī)則就不需要在使用原生的@NotEmpty了，將其刪除

@Validated
@Data
@ConfigurationProperties(prefix = "app")
@Component
public class AppConfigProperties {
//    @NotEmpty(message = "配置文件配置必須要配置[app.id]屬性")
    private String id;
}

注入自定義校驗規(guī)則

@Bean
public  ConfigPropertiesValidator configurationPropertiesValidator(){
  return new ConfigPropertiesValidator();
}

注意：這里bean的方法名必須要 configurationPropertiesValidator，否則啟動的時候不會執(zhí)行該校驗

修改app.id配置，觀察啟動情況

測試驗證結(jié)果

錯誤信息即為我們自定義校驗的結(jié)果。

小結(jié)

通過配置Spring Boot啟動校驗功能，可以快速的識別參數(shù)配置的錯誤，避免在使用組件的時候才發(fā)現(xiàn)問題，可以減少排查問題的工作量，并且在我們封裝自定義的starter時可以有更好的體驗。

以上就是SpringBoot開發(fā)技巧啟動時配置校驗實現(xiàn)示例的詳細內(nèi)容，更多關(guān)于SpringBoot啟動時配置校驗的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章:

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

軟件下載

源碼下載

軟件編程

網(wǎng)絡(luò)編程

在線工具

數(shù)據(jù)庫

CMS

常用工具

SpringBoot開發(fā)技巧啟動時配置校驗實現(xiàn)示例

目錄

概述

增加啟動校驗

校驗類型

定制校驗邏輯

測試驗證結(jié)果

小結(jié)

相關(guān)文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具