關(guān)于SpringBoot的@ConfigurationProperties注解和松散綁定、數(shù)據(jù)校驗
@ConfigurationProperties
源碼分析
@ConfigurationProperties
主要作用就是將prefix屬性指定的前綴配置項的值綁定到這個JavaBean上 ,通過指定的前綴,來綁定配置文件中的配置,通過如下源碼可以看出, 如果你想綁定和驗證一些外部屬性,可以將它添加到類定義或@Configuration
類中的@Bean
方法上。
標(biāo)注在類上
@Data //使用該注解需要導(dǎo)入Lombok依賴 @Component @ConfigurationProperties(prefix = "userinfo") public class UserInfo { private String userId; private String name; }
application.yml文件配置內(nèi)容
userInfo: userId: 1001 name: lucy
接下來通過控制器方法來返回這個對象,查看數(shù)據(jù)是否綁定
@RestController public class HelloController { @Autowired private UserInfo userInfo; @GetMapping("/user") public UserInfo getUserInfo(){ return userInfo; } }
標(biāo)注在方法上
上面源碼中說到可以將它添加到@Configuration
類中的@Bean
方法上,所以下面來看看標(biāo)注在方法上是如何使用的!
比如我們用到druid數(shù)據(jù)源的操作,這個數(shù)據(jù)源是屬于第三方的,所以我們不能操作源碼,不能再源碼里面找到它的對象來給他添加注解,但我們可以在yml文件中給他配置,來拿到它的屬性。
首先添加所需的依賴
<dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.2.11</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency>
接著在yml文件中配置數(shù)據(jù)源
spring: datasource: druid: driver-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://localhost:3306/test?serverTimezone=UTC username: root password: root
創(chuàng)建一個配置類,然后在類方法上添加注解,并通過prefix綁定數(shù)據(jù)
@SpringBootConfiguration public class DatasourceConfig { @Bean @ConfigurationProperties(prefix = "spring.database.druid") public DataSource database(){ return new DruidDataSource(); } }
通過控制器方法來檢驗綁定效果
@RestController public class HelloController { @Autowired private DataSource dataSource; @GetMapping("/datasource") public void getDataSource(){ System.out.println(dataSource); } }
訪問//localhost/datasource
,查看控制臺輸出?。?!
松散綁定
我們在使用 @ConfigurationProperties
注解的時候,@ConfigurationProperties(prefix = “userinfo”)
,這里給prefix的屬性值與yml文件中的屬性名稱不一致,但是依舊綁定成功了!原因是什么呢?
這就需要提到Spring的松散綁定屬性規(guī)則。因此使用以下方式書寫都能與類的屬性名稱匹配。
userInfo: userId: 1001 # 駝峰命名方式 #user_id: 1002 #下劃線方式 #user-id: 1003 #烤肉串方式 #USER_ID: 1004 # 常量方式 name: lucycd
需要注意的是,prefix的屬性值必須全部為小寫,就像下圖所示,就會報錯:前綴必須是規(guī)范形式。
運行程序,也會在控制臺提示你:配置屬性名稱“userInfo
”無效;無效字符:“I”
數(shù)據(jù)校驗
Spring Boot中有很多配置文件,配置文件中我們可以自定義一些對應(yīng)的屬性值。那么這些屬性值是否合法呢?我們?nèi)绾蝸硇r??在Java中有一種JSR303規(guī)范,我們可以針對一些對應(yīng)的數(shù)值來進(jìn)行校驗。按照規(guī)范來進(jìn)行書寫,如果不符合要求就說明校驗失敗,反之,則成功!
SpringBoot也給出了強(qiáng)大的數(shù)據(jù)校驗功能,可以有效的避免此類問題的發(fā)生。在JAVA EE的JSR303規(guī)范中給出了具體的數(shù)據(jù)校驗標(biāo)準(zhǔn),開發(fā)者可以根據(jù)自己的需要選擇對應(yīng)的校驗框架,此處使用Hibernate提供的校驗框架來作為實現(xiàn)進(jìn)行數(shù)據(jù)校驗。
導(dǎo)入驗證包和校驗實現(xiàn)包
<dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> </dependency> <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> </dependency>
添加注解@Validated
給屬性添加驗證規(guī)則
@Data @Component @ConfigurationProperties(prefix = "userinfo") @Validated public class UserInfo { @Max(value = 1000,message = "userid超出范圍了!") @Min(value = 0,message = "userid不能小于0!") private String userId; @Size(min = 2,max = 5,message = "name長度應(yīng)該在2-5之間") private String name; }
這里我們先輸入不符合規(guī)范的數(shù)據(jù),來驗證數(shù)據(jù)是否能夠校驗成功
userInfo: userId: 1001 name: lucycd
編寫一個控制器方法來檢驗
@RestController public class HelloController { @Autowired private UserInfo userInfo; @GetMapping("/user") public UserInfo getUserInfo(){ return userInfo; } }
運行程序,查看控制臺,校驗成功?。?!
同樣,將數(shù)據(jù)修改為符合規(guī)則的數(shù)據(jù),程序就可以成功運行了?。?!
當(dāng)然,這里的校驗規(guī)則還有許多,@NotNull
、@NotEmpty
、@Email
等等,可以根據(jù)實際情況選擇合適的注解。
到此這篇關(guān)于關(guān)于SpringBoot的@ConfigurationProperties注解和松散綁定、數(shù)據(jù)校驗的文章就介紹到這了,更多相關(guān)SpringBoot的@ConfigurationProperties注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- SpringBoot中的@ConfigurationProperties注解解析
- SpringBoot中@ConfigurationProperties注解的使用與源碼詳解
- SpringBoot2底層注解@ConfigurationProperties配置綁定
- SpringBoot中@ConfigurationProperties注解實現(xiàn)配置綁定的三種方法
- SpringBoot中注解@ConfigurationProperties與@Value的區(qū)別與使用詳解
- SpringBoot @ConfigurationProperties注解的簡單使用
- Springboot之@ConfigurationProperties注解解讀
相關(guān)文章
spring boot 添加admin監(jiān)控的方法
這篇文章主要介紹了spring boot 添加admin監(jiān)控的相關(guān)知識,非常不錯,具有參考借鑒價值,需要的朋友可以參考下2018-02-02SpringBoot與SpringMVC中參數(shù)傳遞的原理解析
這篇文章主要介紹了SpringBoot與SpringMVC中參數(shù)傳遞的原理,本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-07-07JSP 開發(fā)之 releaseSession的實例詳解
這篇文章主要介紹了JSP 開發(fā)之 releaseSession的實例詳解的相關(guān)資料,需要的朋友可以參考下2017-07-07springboot后端如何實現(xiàn)攜帶token登陸
這篇文章主要介紹了springboot后端如何實現(xiàn)攜帶token登陸,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-11-11SpringBoot JVM參數(shù)調(diào)優(yōu)方式
這篇文章主要介紹了SpringBoot JVM參數(shù)調(diào)優(yōu)方式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-09-09