Spring使用@Value注解與@PropertySource注解加載配置文件操作
更新時(shí)間：2021年06月15日 10:06:01 作者：pan_junbiao
這篇文章主要介紹了Spring使用@Value注解與@PropertySource注解加載配置文件操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
1、@Value注解簡(jiǎn)介
Spring框架提供的@Value注解可以將外部的值動(dòng)態(tài)注入到Bean中，@Value注解使用在字段、構(gòu)造器參數(shù)和方法參數(shù)上。
@Value可以指定屬性取值的表達(dá)式，支持通過(guò)#{}使用SpringEL來(lái)取值，也支持使用${}來(lái)將屬性來(lái)源中（Properties文件、本地環(huán)境變量、系統(tǒng)屬性等）的值注入到Bean的屬性中。
此注解值的注入發(fā)生在AutowiredAnnotationBeanPostProcessor類(lèi)中。
@Value注解實(shí)現(xiàn)以下幾種情況：
（1）注入普通字符；
（2）注入操作系統(tǒng)屬性；
（3）注入表達(dá)式運(yùn)算結(jié)果；
（4）注入其他Bean的屬性；
（5）注入文件內(nèi)容；
（6）注入網(wǎng)址內(nèi)容；
（7）注入屬性文件。
2、@PropertySource注解簡(jiǎn)介
@PropertySource注解可以加載指定的屬性文件（*.properties）到 Spring 的 Environment 中?？梢耘浜?@Value 和 @ConfigurationProperties 使用。語(yǔ)法格式如下：
@PropertySource(value = "classpath:com/pjb/el/user.properties",encoding = "UTF-8")
public class UserInfo
{
}
【實(shí)例】使用@Value注解與@PropertySource注解加載配置文件。
（1）創(chuàng)建用戶(hù)信息屬性文件（user.properties）
user.userId=1 user.userName=pan_junbiao的博客 user.blogUrl=https://blog.csdn.net/pan_junbiao user.remark=您好，歡迎訪(fǎng)問(wèn) pan_junbiao的博客
（2）創(chuàng)建用戶(hù)信息實(shí)體類(lèi)（UserInfo.java）
使用@PropertySource注解加載配置文件信息，然后使用@Value注解注入屬性值。
package com.pjb.el;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
/**
* 用戶(hù)信息實(shí)體類(lèi)
* @author pan_junbiao
**/
@Component
@PropertySource(value = "classpath:com/pjb/el/user.properties",encoding = "UTF-8")
public class UserInfo
{
//用戶(hù)ID
@Value("${user.userId}")
private int userId;
//用戶(hù)姓名
@Value("${user.userName}")
private String userName;
//博客地址
@Value("${user.blogUrl}")
private String blogUrl;
//備注
@Value("${user.remark}")
private String remark;
//省略getter與setter方法...
}
（3）運(yùn)行
public static void main(String[] args)
{
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ElConfig.class);
UserInfo userInfo = context.getBean(UserInfo.class);
//打印用戶(hù)信息
System.out.println("用戶(hù)編號(hào)：" + userInfo.getUserId());
System.out.println("用戶(hù)姓名：" + userInfo.getUserName());
System.out.println("博客地址：" + userInfo.getBlogUrl());
System.out.println("備注信息：" + userInfo.getRemark());
}
執(zhí)行結(jié)果：
3、綜合實(shí)例
【實(shí)例】使用@Value注解實(shí)現(xiàn)多種情況值的注入和@PropertySource注解加載配置文件。
（1）添加相關(guān)的jar包
添加Spring支持及commons-io依賴(lài)，pom.xml文件的配置如下：
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<spring.version>5.2.3.RELEASE</spring.version>
</properties>
<dependencies>
<!-- Spring框架 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- commons-io依賴(lài) -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.6</version>
</dependency>
</dependencies>
添加 commons-io.jar 可以簡(jiǎn)化文件相關(guān)操作，本實(shí)例中使用 commons-io 將 file 轉(zhuǎn)換成字符串。
（2）創(chuàng)建資源文件
在resources資源目錄下創(chuàng)建名稱(chēng)為info.txt的文本文件，文件內(nèi)容為：您好，歡迎訪(fǎng)問(wèn) pan_junbiao的博客。
在resources資源目錄下創(chuàng)建數(shù)據(jù)庫(kù)連接配置文件db.properties，該文件配置如下：
jdbc.driver=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://localhost:3306/db_admin jdbc.username=root jdbc.password=123456
（3）需被注入的Bean
創(chuàng)建名為OtherUser.java的用戶(hù)信息類(lèi)。
package com.pjb.el;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
/**
* 用戶(hù)信息類(lèi)
* @author pan_junbiao
**/
@Component
public class OtherUser
{
//用戶(hù)名稱(chēng)
@Value("pan_junbiao的博客")
private String userName;
//博客地址
@Value("https://blog.csdn.net/pan_junbiao")
private String blogUrl;
public String getUserName()
{
return userName;
}
public void setUserName(String userName)
{
this.userName = userName;
}
public String getBlogUrl()
{
return blogUrl;
}
public void setBlogUrl(String blogUrl)
{
this.blogUrl = blogUrl;
}
}
（4）配置類(lèi)
創(chuàng)建名為ElConfig.java的配置類(lèi)。
package com.pjb.el;
import org.apache.commons.io.IOUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.core.env.Environment;
import org.springframework.core.io.Resource;
/**
* 配置類(lèi)
* @author pan_junbiao
**/
@Configuration
@ComponentScan("com.pjb.el")
@PropertySource("classpath:db.properties")
public class ElConfig
{
/**
* 注入普通字符串
*/
@Value("您好，歡迎訪(fǎng)問(wèn) pan_junbiao的博客")
private String comment;
/**
* 注入操作系統(tǒng)屬性
*/
@Value("#{systemProperties['os.name']}")
private String osName;
/**
* 注入表達(dá)式運(yùn)算結(jié)果
*/
@Value("#{ T(java.lang.Math).random() * 100.0 }")
private double randomNumber;
/**
* 注入其他Bean的屬性
*/
@Value("#{otherUser.userName}")
private String fromUserName;
@Value("#{otherUser.blogUrl}")
private String fromBlogUrl;
/**
* 注入文件資源
*/
@Value("classpath:info.txt")
private Resource testFile;
/**
* 注入網(wǎng)址資源
*/
@Value("https://blog.csdn.net/pan_junbiao")
private Resource testUrl;
/**
* 注入配置文件
*/
@Value("${jdbc.driver}")
private String jdbc_driver;
@Value("${jdbc.url}")
private String jdbc_url;
@Value("${jdbc.username}")
private String jdbc_username;
@Value("${jdbc.password}")
private String jdbc_password;
@Autowired
private Environment environment;
@Bean
public static PropertySourcesPlaceholderConfigurer propertyConfigurer()
{
return new PropertySourcesPlaceholderConfigurer();
}
public void outputResource()
{
try
{
System.out.println("注入普通字符串：");
System.out.println(comment);
System.out.println("------------------------------------------------");
System.out.println("注入操作系統(tǒng)屬性：");
System.out.println(osName);
System.out.println("------------------------------------------------");
System.out.println("注入表達(dá)式運(yùn)算結(jié)果：");
System.out.println(randomNumber);
System.out.println("------------------------------------------------");
System.out.println("注入其他Bean的屬性：");
System.out.println("用戶(hù)名稱(chēng)：" + fromUserName);
System.out.println("博客地址："+ fromBlogUrl);
System.out.println("------------------------------------------------");
System.out.println("注入文件資源：");
System.out.println("文件中的內(nèi)容：" + IOUtils.toString(testFile.getInputStream()));
System.out.println("------------------------------------------------");
System.out.println("注入配置文件（方式一）：");
System.out.println("數(shù)據(jù)庫(kù)驅(qū)動(dòng)：" + jdbc_driver);
System.out.println("數(shù)據(jù)庫(kù)連接：" + jdbc_url);
System.out.println("數(shù)據(jù)庫(kù)用戶(hù)：" + jdbc_username);
System.out.println("數(shù)據(jù)庫(kù)密碼：" + jdbc_password);
System.out.println("------------------------------------------------");
System.out.println("注入配置文件（方式二）：");
System.out.println("數(shù)據(jù)庫(kù)驅(qū)動(dòng)：" + environment.getProperty("jdbc.driver"));
System.out.println("數(shù)據(jù)庫(kù)連接：" + environment.getProperty("jdbc.url"));
System.out.println("數(shù)據(jù)庫(kù)用戶(hù)：" + environment.getProperty("jdbc.username"));
System.out.println("數(shù)據(jù)庫(kù)密碼：" + environment.getProperty("jdbc.password"));
System.out.println("------------------------------------------------");
}
catch (Exception ex)
{
ex.printStackTrace();
}
}
}
注入配置配件需要使用@PropertySource注解指定文件地址，若使用@Value注解，則要配置一個(gè)PropertySourcesPlaceholderConfigurer的Bean。注意，@Value("${jdbc.driver}")使用的是“${}”而不是“#{}”。
注入Properties還可以從Environment中獲得。
（5）運(yùn)行
package com.pjb.el;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
/**
* 運(yùn)行類(lèi)
* @author pan_junbiao
**/
public class Main
{
public static void main(String[] args)
{
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ElConfig.class);
ElConfig resourceService = context.getBean(ElConfig.class);
resourceService.outputResource();
context.close();
}
}
執(zhí)行結(jié)果：
spring中@value注解需要注意
首先
@value需要參數(shù)，這里參數(shù)可以是兩種形式：
@Value(“#{configProperties[‘t1.msgname']}”)
或者
@Value(“${t1.msgname}”)；
其次
下面我們來(lái)看看如何使用這兩形式，在配置上有什么區(qū)別：
1、@Value(“#{configProperties[‘t1.msgname']}”)這種形式的配置中有“configProperties”，其實(shí)它指定的是配置文件的加載對(duì)象：配置如下：
classpath:/config/t1.properties
這樣配置就可完成對(duì)屬性的具體注入了；
2、@Value("${t1.msgname}")這種形式不需要指定具體加載對(duì)象，這時(shí)候需要一個(gè)關(guān)鍵的對(duì)象來(lái)完成PreferencesPlaceholderConfigurer，這個(gè)對(duì)象的配置可以利用上面配置1中的配置，也可以自己直接自定配置文件路徑。
如果使用配置1中的配置，可以寫(xiě)成如下情況：
<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PreferencesPlaceholderConfigurer">
<property name="properties" ref="configProperties"/>
</bean>
如果直接指定配置文件的話(huà)，可以寫(xiě)成如下情況：
<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PreferencesPlaceholderConfigurer">
<property name="location">
<value>config/t1.properties</value>
</property>
</bean>**重點(diǎn)內(nèi)容**
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
java實(shí)現(xiàn)單機(jī)版五子棋小游戲
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)單機(jī)版五子棋小游戲，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-12-12
Java二維碼登錄流程實(shí)現(xiàn)代碼(包含短地址生成，含部分代碼)
近年來(lái)，二維碼的使用越來(lái)越風(fēng)生水起，本篇文章主要介紹了Java二維碼登錄流程實(shí)現(xiàn)代碼，其中包含短地址生成，有興趣的可以了解一下。2016-12-12
詳解IDEA下Gradle多模塊(項(xiàng)目)的構(gòu)建
這篇文章主要介紹了詳解IDEA下Gradle多模塊(項(xiàng)目)的構(gòu)建，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2019-01-01
AbstractQueuedSynchronizer(AQS)鎖狀態(tài)同步和排隊(duì)管理
這篇文章主要介紹了為大家AbstractQueuedSynchronizer(AQS)鎖狀態(tài)同步和排隊(duì)管理源碼解讀，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-11-11
使用Java實(shí)現(xiàn)簡(jiǎn)單串口通信
這篇文章主要介紹了使用Java實(shí)現(xiàn)簡(jiǎn)單串口通信，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07
Java實(shí)現(xiàn)簡(jiǎn)易生產(chǎn)者消費(fèi)者模型過(guò)程解析
這篇文章主要介紹了Java實(shí)現(xiàn)簡(jiǎn)易生產(chǎn)者消費(fèi)者模型過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-06-06
通過(guò)這篇文章帶你了解logstash收集springboot日志的方法,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-04-04
Spring?Boot循環(huán)依賴(lài)原理、解決方案與最佳實(shí)踐(全解析)
循環(huán)依賴(lài)指兩個(gè)或多個(gè)Bean相互直接或間接引用,形成閉環(huán)依賴(lài)關(guān)系,這篇文章主要介紹了Spring?Boot循環(huán)依賴(lài)原理、解決方案與最佳實(shí)踐(全解析),需要的朋友可以參考下2025-04-04
springboot-dubbo cannot be cast to問(wèn)題及解決
這篇文章主要介紹了springboot-dubbo cannot be cast to問(wèn)題及解決方案，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-04-04
Struts2學(xué)習(xí)筆記(1)-入門(mén)教程
本文是一個(gè)Struts2的簡(jiǎn)單入門(mén)教程，比較簡(jiǎn)單，希望能給大家做一個(gè)參考。2016-06-06