在SpringBoot下怎麼讀取自訂properties配置文件

一、在resource中新建.properties檔案

在resource目錄下新建一個config資料夾，然後新建一個.properties檔案放在該資料夾下。如圖remote.properties所示

#二、寫設定檔

remote.uploadFilesUrl=/resource/files/
remote.uploadPicUrl=/resource/pic/

三、新一個配置類別RemoteProperties.java

@Configuration
@ConfigurationProperties(prefix = "remote", ignoreUnknownFields = false)
@PropertySource("classpath:config/remote.properties")
@Data
@Component
public class RemoteProperties {
  private String uploadFilesUrl;
  private String uploadPicUrl;
}

其中

@Configuration 顯示這是一個配置類別
@ConfigurationProperties(prefix = "remote", ignoreUnknownFields = false) 此註解用於綁定屬性。 prefix用來選擇屬性的前綴，也就是在remote.properties檔案中的“remote”，ignoreUnknownFields是用來告訴SpringBoot在有屬性不能匹配到聲明的域時拋出異常。
@PropertySource("classpath:config/remote.properties") 設定檔路徑
@Data 這個是lombok註解，用來產生getter&setter方法
@Component 識別為Bean

#四、如何使用？

在想要使用設定檔的方法所在類別上表上註解EnableConfigurationProperties(RemoteProperties.class)
並自動注入

@Autowired
RemoteProperties remoteProperties;

在方法中使用remoteProperties.getUploadFilesUrl( )就可以拿到配置內容了。

@EnableConfigurationProperties(RemoteProperties.class)
@RestController
public class TestService{
  @Autowired
  RemoteProperties remoteProperties;

  public void test(){
    String str = remoteProperties.getUploadFilesUrl();
    System.out.println(str);
  }
}

這裡str就是設定檔中的”/resource/files/”了。

#PS：下面看下Spring-boot中讀取config設定檔的兩種方式

了解spring-Boot這個技術的，應該知道Spring-Boot的核心設定檔application.properties，當然也可以透過註解自訂設定檔的資訊。

Spring-Boot讀取設定檔的方式：

一.讀取核心設定檔資訊application.properties的內容

     核心設定檔是指在resources根目錄下的application.properties或application.yml設定文件，讀取這兩個設定檔的方法有兩種，都比較簡單。

核心設定檔application.properties內容如下：

test.msg=Hello World SpringBoot

方式一：使用@Value方式（常用）

package Solin.controller; 
import org.springframework.beans.factory.annotation.Value; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.bind.annotation.RestController; 
@RestController 
public class WebController { 
  @Value("${test.msg}") 
  private String msg; 
  @RequestMapping("/index1")  
  public String index1(){ 
    return "方式一:"+msg; 
  } 
}

注意：在@Value的${}中包含的是核心設定檔中的鍵名。在Controller類別上加上@RestController表示將此類別中的所有視圖都以JSON方式顯示，類似於在視圖方法上加上@ResponseBody。
存取：http://localhost:8088/index1時得到："方式一:Hello World SpringBoot"

方式二：使用Environment方式

package Solin.controller; 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.beans.factory.annotation.Value; 
import org.springframework.core.env.Environment; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.bind.annotation.RestController; 
@RestController 
public class WebController { 
  @Autowired 
  private Environment env; 
   
  @RequestMapping("/index2")  
  public String index2(){ 
    return "方式二:"+env.getProperty("test.msg"); 
  } 
}

注意：這種方式是依賴注入Evnironment來完成，在建立的成員變數private Environment env上加上@Autowired註解即可完成依賴注入，然後使用env.getProperty("鍵名")即可讀取出對應的值。
存取：http://localhost:8088/index2時得到："方式二:Hello World SpringBoot"

二.讀取自訂設定檔訊息，例如：author.properties

為了不破壞核心檔案的原生態，但又需要有自訂的設定資訊存在，一般情況下會選擇自訂設定檔來放這些自訂訊息，這裡在resources目錄下創建設定檔author.properties

resources/author.properties內容如下：

author.name=Solin 
author.age=22

建立管理配置的實體類別：

package Solin.controller; 
 
import org.springframework.boot.context.properties.ConfigurationProperties; 
import org.springframework.context.annotation.Configuration; 
import org.springframework.stereotype.Component; 
 
//加上注释@Component，可以直接在其他地方使用@Autowired来创建其实例对象 
@Component 
@ConfigurationProperties(prefix = "author",locations = "classpath:author.properties")   
public class MyWebConfig{ 
  private String name; 
  private int age; 
  public String getName() { 
    return name; 
  } 
  public void setName(String name) { 
    this.name = name; 
  } 
  public int getAge() { 
    return age; 
  } 
  public void setAge(int age) { 
    this.age = age; 
  } 
}

注意：

    在@ConfigurationProperties註解中有兩個屬性：

locations：指定設定檔的所在位置
prefix：指定設定檔中鍵名稱的前綴（我這裡設定檔中所有鍵名都是以author.開頭）

    使用@Component是讓類別能夠在其他地方依賴使用，即使用@Autowired註解來建立實例。

建立測試Controller

package Solin.controller; 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.stereotype.Controller; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.bind.annotation.ResponseBody; 
@Controller  
public class ConfigController { 
  @Autowired 
  private MyWebConfig conf; 
   
  @RequestMapping("/test")  
  public @ResponseBody String test() { 
    return "Name:"+conf.getName()+"---"+"Age:"+conf.getAge();  
  } 
}

注意：由於在Conf類別上加了註解@Component，所以可以直接在這裡使用@Autowired來建立其實例物件。

訪問：http://localhost:8088/test時得到："Name:Solin---Age:22"

以上是在SpringBoot下怎麼讀取自訂properties配置文件的詳細內容。更多資訊請關注PHP中文網其他相關文章！