SpringBoot開發(fā)技巧啟動時配置校驗實現(xiàn)示例
概述
在項目開發(fā)過程中,某個功能需要依賴在配置文件中配置的參數(shù)。這時候就可能出現(xiàn)下面這種現(xiàn)象問題:
有時候經(jīng)常出現(xiàn)項目啟動了,等到使用某個功能組件的時候出現(xiàn)異常,提示參數(shù)未配置或者bean注入失敗。
有沒有一種方法在項目啟動時就對參數(shù)進行校驗而不是在實際使用的時候再拋出提示呢?
答案就是使用Spring提供的Java Validation功能,簡單實用。
增加啟動校驗
只需要在我們創(chuàng)建的配置Properties類增加Validation相關(guān)配置即可
@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,也可以通過正則表達式和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)文章!
相關(guān)文章
使用postman傳遞list集合后臺springmvc接收
這篇文章主要介紹了使用postman傳遞list集合后臺springmvc接收的操作,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-08-08mybatis-plus添加數(shù)據(jù)時id自增問題及解決
這篇文章主要介紹了mybatis-plus添加數(shù)據(jù)時id自增問題及解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-01-01通過java反射機制動態(tài)調(diào)用某方法的總結(jié)(推薦)
下面小編就為大家?guī)硪黄ㄟ^java反射機制動態(tài)調(diào)用某方法的總結(jié)(推薦)。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2016-07-07java運行時數(shù)據(jù)區(qū)域和類結(jié)構(gòu)詳解
這篇文章主要介紹了java運行時數(shù)據(jù)區(qū)域和類結(jié)構(gòu),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-07-07SpringBoot條件注解@Conditional詳細解析
這篇文章主要介紹了SpringBoot條件注解@Conditional詳細解析,@Conditional是Spring4.0提供的一個用于條件裝配的注解,其定義了一個Condition的數(shù)組,只有當(dāng)數(shù)組所有的條件都滿足的時候,組件才會被導(dǎo)入容器,需要的朋友可以參考下2023-11-11Java編程中應(yīng)用的GUI設(shè)計基礎(chǔ)
這篇文章主要介紹了Java編程中應(yīng)用的GUI設(shè)計基礎(chǔ),為一些Java開發(fā)CS類型應(yīng)用的基礎(chǔ)概念知識,需要的朋友可以參考下2015-10-10BigDecimal divide除法除不盡報錯的問題及解決
這篇文章主要介紹了BigDecimal divide除法除不盡報錯的問題及解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-06-06