Spring-boot中讀取config配置文件的兩種方式

瞭解過spring-Boot這個技術的,應該知道Spring-Boot的核心配置文件application.properties,當然也可以通過註解自定義配置文件的信息。


Spring-Boot讀取配置文件的方式:

一.讀取核心配置文件信息application.properties的內容

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


核心配置文件application.properties內容如下:

[java] view plain copy
  1. test.msg=Hello World SpringBoot  

方式一:使用@Value方式(常用)

[java] view plain copy
  1. <span style="font-size:18px;">package Solin.controller;  
  2.   
  3. import org.springframework.beans.factory.annotation.Value;  
  4. import org.springframework.web.bind.annotation.RequestMapping;  
  5. import org.springframework.web.bind.annotation.RestController;  
  6.   
  7. @RestController  
  8. public class WebController {  
  9.     @Value("${test.msg}")  
  10.     private String msg;  
  11.       
  12.     @RequestMapping("/index1")   
  13.     public String index1(){  
  14.         return "方式一:"+msg;  
  15.     }  
  16. }</span>  
注意:在@Value的${}中包含的是核心配置文件中的鍵名。在Controller類上加@RestController表示將此類中的所有視圖都以JSON方式顯示,類似於在視圖方法上加@ResponseBody。
訪問:http://localhost:8088/index1時得到:"方式一:Hello World SpringBoot"


方式二:使用Environment方式

[java] view plain copy
  1. <span style="font-size:18px;">package Solin.controller;  
  2.   
  3. import org.springframework.beans.factory.annotation.Autowired;  
  4. import org.springframework.beans.factory.annotation.Value;  
  5. import org.springframework.core.env.Environment;  
  6. import org.springframework.web.bind.annotation.RequestMapping;  
  7. import org.springframework.web.bind.annotation.RestController;  
  8.   
  9. @RestController  
  10. public class WebController {  
  11.     @Autowired  
  12.     private Environment env;  
  13.       
  14.     @RequestMapping("/index2")   
  15.     public String index2(){  
  16.         return "方式二:"+env.getProperty("test.msg");  
  17.     }  
  18. }  
  19. </span>  
注意:這種方式是依賴注入Evnironment來完成,在創建的成員變量private Environment env上加上@Autowired註解即可完成依賴注入,然後使用env.getProperty("鍵名")即可讀取出對應的值。
訪問:http://localhost:8088/index2時得到:"方式二:Hello World SpringBoot"


二.讀取自定義配置文件信息,例如:author.properties

爲了不破壞核心文件的原生態,但又需要有自定義的配置信息存在,一般情況下會選擇自定義配置文件來放這些自定義信息,這裏在resources目錄下創建配置文件author.properties

resources/author.properties內容如下:

[java] view plain copy
  1. author.name=Solin  
  2. author.age=22  

創建管理配置的實體類:

[java] view plain copy
  1. package Solin.controller;  
  2.   
  3. import org.springframework.boot.context.properties.ConfigurationProperties;  
  4. import org.springframework.context.annotation.Configuration;  
  5. import org.springframework.stereotype.Component;  
  6.   
  7. //加上註釋@Component,可以直接其他地方使用@Autowired來創建其實例對象  
  8. @Component  
  9. @ConfigurationProperties(prefix = "author",locations = "classpath:author.properties")     
  10. public class MyWebConfig{  
  11.     private String name;  
  12.     private int age;  
  13.     public String getName() {  
  14.         return name;  
  15.     }  
  16.     public void setName(String name) {  
  17.         this.name = name;  
  18.     }  
  19.     public int getAge() {  
  20.         return age;  
  21.     }  
  22.     public void setAge(int age) {  
  23.         this.age = age;  
  24.     }  
  25. }  

注意:
    在@ConfigurationProperties註釋中有兩個屬性:
locations:指定配置文件的所在位置
prefix:指定配置文件中鍵名稱的前綴(我這裏配置文件中所有鍵名都是以author.開頭)
    使用@Component是讓該類能夠在其他地方被依賴使用,即使用@Autowired註釋來創建實例。


創建測試Controller

[java] view plain copy
  1. package Solin.controller;  
  2.   
  3. import org.springframework.beans.factory.annotation.Autowired;  
  4. import org.springframework.stereotype.Controller;  
  5. import org.springframework.web.bind.annotation.RequestMapping;  
  6. import org.springframework.web.bind.annotation.ResponseBody;  
  7.   
  8. @Controller    
  9. public class ConfigController {  
  10.     @Autowired  
  11.     private MyWebConfig conf;  
  12.       
  13.     @RequestMapping("/test")   
  14.     public @ResponseBody String test() {  
  15.         return "Name:"+conf.getName()+"---"+"Age:"+conf.getAge();   
  16.     }  
  17. }  

注意:由於在Conf類上加了註釋@Component,所以可以直接在這裏使用@Autowired來創建其實例對象。

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

發佈了31 篇原創文章 · 獲贊 7 · 訪問量 8萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章