Spring註解@Value及屬性載入組態檔方式

2021-07-06 16:01:02

Spring中使用@Value註解給bean載入屬性的組態檔有兩種使用方式

第一種：使用@Value("#{configProperties['websit.msgname']}")

spring中設定屬性載入檔案的設定方式

<bean id="configProperties" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
        <property name="locations">
            <list>
                <value>classpath:/properties/websit.properties</value>
            </list>
        </property>
</bean>

注意

1.這裡使用的configProperties必須要和定義的bean名稱一致。

2.websit用來指定msgname來源於那個組態檔

3.設定的載入屬性bean名稱為org.springframework.beans.factory.config.PropertiesFactoryBean

第二種：使用@Value("${websit.msgname}")；

使用這種方式，又可以有兩種設定方式

方式一

<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PreferencesPlaceholderConfigurer">
        <property name="properties" ref="configProperties"/>
</bean>
 
<bean id="configProperties" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
        <property name="locations">
            <list>
                <value>classpath:/properties/websit.properties</value>
            </list>
        </property>
</bean>

方式二

<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
     <property name="locations">
     <list>
         <value>classpath:properties/websit.properties</value>
     </list>
        </property>
</bean>

當使用@Value註解bean屬性時，如果沒有在組態檔中設定，這時啟動spring就會丟擲異常。@Value提供了一種預設值的設定方式，如果在屬性檔案中沒有設定則可以使用預設值。

形式如下

@Value("${avg.age:22}")  
private int userAge;

如果使用@Value註解後，資料不能正常的被注入則需要在xml的組態檔中加入下列程式碼

<context:annotation-config/>

SpringBoot使用註解(@value)讀取properties（yml）檔案中設定資訊

為了簡化讀取properties檔案中的設定值，spring支援@value註解的方式來獲取，這種方式大大簡化了專案設定，提高業務中的靈活性。

1. 兩種使用方法

1）@Value("#{configProperties['key']}")

2）@Value("${key}")

2. 組態檔範例

ftp:
ftplp: 10.2.23.89
ftpPort: 21
ftpUser: uftp
ftpPwd: 12345678
ftpRemotePath: /home

說明：以上是組態檔中的資訊，主要是一些賬號密碼等資訊。

3. 讀取yml組態檔的工具類

package com.dbright.dataprediction.entity;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
@Component
@PropertySource("classpath:ftpconfig.yml")
@ConfigurationProperties(prefix = "ftp")
public class FtpProperties {

    @Value("${ftplp}")
    public String ftplp;
    @Value("${ftpPort}")
    public String ftpPort;
    @Value("${ftpUser}")
    public String ftpUser;
    @Value("${ftpPwd}")
    public String ftpPwd;
    @Value("${ftpRemotePath}")
    public String ftpRemotePath;

    public String getFtplp() {
        return ftplp;
    }

    public void setFtplp(String ftplp) {
        this.ftplp = ftplp;
    }

    public String getFtpPort() {
        return ftpPort;
    }

    public void setFtpPort(String ftpPort) {
        this.ftpPort = ftpPort;
    }

    public String getFtpUser() {
        return ftpUser;
    }

    public void setFtpUser(String ftpUser) {
        this.ftpUser = ftpUser;
    }

    public String getFtpPwd() {
        return ftpPwd;
    }

    public void setFtpPwd(String ftpPwd) {
        this.ftpPwd = ftpPwd;
    }

    public String getFtpRemotePath() {
        return ftpRemotePath;
    }

    public void setFtpRemotePath(String ftpRemotePath) {
        this.ftpRemotePath = ftpRemotePath;
    }
}

說明：以上是使用@value註解來讀取yml組態檔的程式碼範例

1）@component —— 把普通pojo範例化到spring容器中，相當於組態檔中的`<bean id="" class=""/>`

2) @PropertySource("classpath:ftpconfig.yml") —— 設定yml檔案的路徑，方便掃描到。一般我們組態檔都是放在resources包下。所以我們只需要 classpath+所需要讀取的組態檔名稱。

3）@ConfigurationProperties(prefix = "ftp") —— 這個不需要解釋太多，組態檔裡面內容的字首，我們讀取的是ftp下的資訊。

4）@Value("${ftplp}") —— 這是讀取我們所需的設定資訊，美元符號+{欄位名}即可制定

5）下面定義字串來接收所讀取到的設定資訊。

6）寫set和get方法，方便外部類呼叫。