詳解Spring中的@PropertySource注解使用
@PropertySource注解是Spring用于加載配置文件，默認支持.properties與.xml兩種配置文件。@PropertySource屬性如下：
- name：默認為空，不指定
Spring自動生成 - value：配置文件
- ignoreResourceNotFound：沒有找到配置文件是否忽略，默認
false，4.0版本加入 - encoding：配置文件編碼格式，默認
UTF-84.3版本才加入 - factory：配置文件解析工廠，默認：
PropertySourceFactory.class4.3版本才加入，如果是之前的版本就需要手動注入配置文件解析Bean
接下來就使用@PropertySource來加載.properties與.xml配置文件。這里模擬連接MySQL數(shù)據(jù)庫。
首先添加依賴：
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.1.6.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.1.6.RELEASE</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.26</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
</dependency>
準備屬性配置文件jdbc.properties
jdbc.driver=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://127.0.0.1:3306 jdbc.userName=root jdbc.password=xiaohu
創(chuàng)建屬性實體類來加載配置文件JdbcProperties
@Data
@Repository
@PropertySource(value = "classpath:jdbc.properties")
public class JdbcProperties {
@Value("${jdbc.driver}")
private String driver;
@Value("${jdbc.url}")
private String url;
@Value("${jdbc.userName}")
private String userName;
@Value("${jdbc.password}")
private String password;
}
創(chuàng)建JDBC配置類JdbcConfig
@Component
public class JdbcConfig {
@Bean
public DataSource dataSource(JdbcProperties jdbcProperties){
System.out.println("打印獲取到的配置信息："+jdbcProperties);
DriverManagerDataSource dataSource = new DriverManagerDataSource();
dataSource.setDriverClassName(jdbcProperties.getDriver());
dataSource.setUrl(jdbcProperties.getUrl());
dataSource.setUsername(jdbcProperties.getUserName());
dataSource.setPassword(jdbcProperties.getPassword());
return dataSource;
}
}
創(chuàng)建Spring配置類SpringConfiguration
@Configuration
public class SpringConfiguration {
}
創(chuàng)建測試類測試讀取配置文件
public class PropertySourceTest {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext("config");
DataSource dataSource = context.getBean("dataSource",DataSource.class);
System.out.println(dataSource);
}
}
查看輸出結(jié)果：
打印獲取到的配置信息：JdbcProperties(driver=com.mysql.cj.jdbc.Driver, url=jdbc:mysql://127.0.0.1:3306, userName=root, password=xiaohu)
org.springframework.jdbc.datasource.DriverManagerDataSource@58695725
從結(jié)果可以看出，我們的properties中的配置已經(jīng)成功讀取到，并且DataSource也從Spring容器中獲取到。上面介紹注解的屬性時，factory是4.3版本才加入的，那么如果4.3版本之前要解析配置文件又應該怎么處理呢？，這個時候就需要手動將解析配置文件的Bean注入到Spring容器中了，用法很簡單，在SpringConfiguration類中添加如下代碼即可：
@Bean
public PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer(){
return new PropertySourcesPlaceholderConfigurer();
}
具體測試結(jié)果，就自行測試了。上面例子介紹了properties的使用，下面我們將配置文件換成xml文件。配置如下：
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<entry key="jdbc.driver">com.mysql.cj.jdbc.Driver</entry>
<entry key="jdbc.url">jdbc:mysql://127.0.0.1:3306/test</entry>
<entry key="jdbc.userName">root</entry>
<entry key="jdbc.password">xiaohu</entry>
</properties>
然后將JdbcProperties類上的注解的配置文件換成xml文件。
@PropertySource(value = "classpath:jdbc.properties")
其他不用調(diào)整，執(zhí)行測試類，輸出的結(jié)果一樣。因為上面介紹到@PropertySource默認支持properties與xml的配置文件。我們可以查看PropertySourceFactory的默認實現(xiàn)DefaultPropertySourceFactory源碼
public class DefaultPropertySourceFactory implements PropertySourceFactory {
@Override
public PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException {
return (name != null ? new ResourcePropertySource(name, resource) : new ResourcePropertySource(resource));
}
}
然后進入ResourcePropertySource類，源碼這里使用了一個三元運算符，如果name為空，就使用默認Spring默認生成的name。
public ResourcePropertySource(String name, EncodedResource resource) throws IOException {
super(name, PropertiesLoaderUtils.loadProperties(resource));
this.resourceName = getNameForResource(resource.getResource());
}
public ResourcePropertySource(EncodedResource resource) throws IOException {
super(getNameForResource(resource.getResource()), PropertiesLoaderUtils.loadProperties(resource));
this.resourceName = null;
}
這里可以看到調(diào)用了PropertiesLoaderUtils.loadProperties方法，進入到源碼
public static Properties loadProperties(EncodedResource resource) throws IOException {
Properties props = new Properties();
fillProperties(props, resource);
return props;
}
會調(diào)用fillProperties的方法，一直跟到調(diào)用最低的fillProperties方法。
static void fillProperties(Properties props, EncodedResource resource, PropertiesPersister persister)
throws IOException {
InputStream stream = null;
Reader reader = null;
try {
String filename = resource.getResource().getFilename();
if (filename != null && filename.endsWith(XML_FILE_EXTENSION)) {
stream = resource.getInputStream();
persister.loadFromXml(props, stream);
}
else if (resource.requiresReader()) {
reader = resource.getReader();
persister.load(props, reader);
}
else {
stream = resource.getInputStream();
persister.load(props, stream);
}
}
finally {
if (stream != null) {
stream.close();
}
if (reader != null) {
reader.close();
}
}
}
第一個if判斷文件后綴是否是xml結(jié)尾，常量XML_FILE_EXTENSION如下：
private static final String XML_FILE_EXTENSION = ".xml";
除了支持properties與xml的配置文件方式，也支持yml配置文件的方式，不過需要自定義解析工廠，下面來實現(xiàn)怎么解析yml配置文件。引入可以解析yml文件的第三方庫
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>1.28</version>
</dependency>
創(chuàng)建yml解析工廠YamlPropertySourceFactory實現(xiàn)PropertySourceFactory
public class YamlPropertySourceFactory implements PropertySourceFactory {
@Override
public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
YamlPropertiesFactoryBean factoryBean = new YamlPropertiesFactoryBean();
factoryBean.setResources(resource.getResource());
Properties properties = factoryBean.getObject();
return name != null ? new PropertiesPropertySource(name, properties) : new PropertiesPropertySource(resource.getResource().getFilename(), properties);
}
}
然后將JdbcProperties類的@PropertySource換成如下寫法：
@PropertySource(value = "classpath:jdbc.yml",factory = YamlPropertySourceFactory.class)
執(zhí)行測試類，輸出結(jié)果與上面結(jié)果一樣
打印獲取到的配置信息：JdbcProperties(driver=com.mysql.cj.jdbc.Driver, url=jdbc:mysql://127.0.0.1:3306, userName=root, password=xiaohu)
org.springframework.jdbc.datasource.DriverManagerDataSource@58695725
證明我們自定義的解析yml配置文件就成功了。
到此這篇關于Spring的@PropertySource注解使用的文章就介紹到這了,更多相關Spring的@PropertySource注解使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
springboot3整合SpringSecurity實現(xiàn)登錄校驗與權(quán)限認證
本文主要介紹了springboot3整合SpringSecurity實現(xiàn)登錄校驗與權(quán)限認證,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2025-04-04
Spring Boot在內(nèi)部通過集成hibernate-validation已經(jīng)實現(xiàn)了JSR-349驗證規(guī)范接口，在Spring Boot項目中只要直接使用就行了。 一般用在Controller中用于驗證前端傳來的參數(shù)。這篇文章給大家介紹Spring Validation 驗證框架的相關知識，感興趣的朋友一起看看吧2021-07-07
本文介紹了Java程序性能的主要表現(xiàn)點、衡量程序性能的主要指標、性能調(diào)優(yōu)的層次、基本調(diào)優(yōu)策略和手段等，具有很好的參考價值，下面跟著小編一起來看下吧2017-02-02
IDEA啟動tomcat項目報錯53820 socket closed問題及解決
IDEA啟動Tomcat項目時報錯,原因是IDEA關閉時Tomcat未正常關閉,導致端口被占用,解決方法是通過任務管理器關閉占用高內(nèi)存的Java進程,通常是IDEA進程下面的,或者使用命令行找到PID并強制終止進程2024-12-12
詳解在Spring MVC中使用注解的方式校驗RequestParams
本篇文章主要介紹了詳解在Spring MVC中使用注解的方式校驗RequestParams ，具有一定的參考價值，感興趣的小伙伴們可以參考一下。2017-03-03
這篇文章主要介紹了SpringBoot框架整合Mybatis的簡單攻略，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2021-10-10
這篇文章主要介紹了java封裝繼承多態(tài)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-08-08
這篇文章主要介紹了如何Java項目中獲取文件地址，在 Java 項目中我們經(jīng)常會讀取配置文件，但是文件的路徑在獲取時我們是怎么得到的？下面我們就一起進入文章學習該內(nèi)容吧,需要的朋友可以參考下2022-02-02
spring中的特殊注解@RequiredArgsConstructor詳解
這篇文章主要介紹了spring中的特殊注解@RequiredArgsConstructor,包括注解注入，構(gòu)造器注入及setter注入，結(jié)合示例代碼給大家介紹的非常詳細，需要的朋友可以參考下2022-04-04
Eclipse下編寫java程序突然不會自動生成R.java文件和包的解決辦法
這篇文章主要介紹了Eclipse下編寫java程序突然不會自動生成R.java文件和包的解決辦法 的相關資料,需要的朋友可以參考下2016-01-01