springboot讀取自定義配置檔案節點

神牛003發表於2018-05-25

  今天和大家分享的是自定義配置資訊的讀取;近期有寫部落格這樣的計劃,分別交叉來寫springboot方面和springcloud方面的文章,因為springboot預計的篇章很多,這樣cloud的文章就需要等到很後面才能寫了;分享這兩種文章的原因主要是為了方便自己查詢資料使用和對將要使用的朋友起到便捷作用;

  • @Value標記讀取(預設可直接讀取application.yml的節點)
  • 實體對映application.yml的節點
  • 實體對映自定義配置檔案的節點
  • 實體對映多層級節點的值

@Value標記讀取(預設可直接讀取application.yml的節點)

  首先在預設application.yml配置檔案中自定義如下節點資訊:

1 shenniu:
2   name: 神牛003

  然後通過@Value標記來直接獲取屬性值,為了更好的展示資料到介面上定義了一個/conf/name介面:

1     @Value("${shenniu.name}")
2     private String name;
3 
4     @GetMapping("/conf/defname")
5     public String getDefName() {
6         return this.name;
7     }

  執行後效果如:

  

實體對映application.yml的節點

  要用實體類對映出預設配置檔案值,僅僅只需要加一個屬性名稱字首就行了,當然這僅僅針對於application.yml預設檔案裡面的屬性:

 1 @Configuration
 2 @ConfigurationProperties(prefix = "shenniu")
 3 public class ShenniuConf {
 4 
 5     private String name;
 6 
 7     public String getName() {
 8         return name;
 9     }
10 
11     public void setName(String name) {
12         this.name = name;
13     }
14 
15     private Url url;
16 
17     public Url getUrl() {
18         return url;
19     }
20 
21     public void setUrl(Url url) {
22         this.url = url;
23     }
24 
25     private String des;
26 
27     public String getDes() {
28         return des;
29     }
30 
31     public void setDes(String des) {
32         this.des = des;
33     }
34 
35     public static class Url {
36 
37         private String blogurl;
38 
39         public String getBlogurl() {
40             return blogurl;
41         }
42 
43         public void setBlogurl(String blogurl) {
44             this.blogurl = blogurl;
45         }
46 
47     }
48 }

  實體類我多增加了幾個屬性,為了後面測試方便;要對application.yml做配置對映只需要加上 @ConfigurationProperties(prefix = "shenniu") 標記,prefix的值對應自定義配置檔案屬性的字首;這裡增加/conf/name介面輸出對映出物件的值:

1 @Autowired
2     private ShenniuConf shenniuConf;
3 
4     @GetMapping("/conf/name")
5     public String getName() {
6         return shenniuConf.getName();
7     }

  同樣得到了和@Values註解一樣的效果,這就表示實體和配置檔案自定義屬性匹配成功了,主要實體屬性名稱應該和配置檔案節點名稱保持一致;

  

實體對映自定義配置檔案的節點

  讀取application.yml中屬性值很簡單,有時候需要自定義自己的配置檔案,如這裡我的my.properties,檔案內容如下:

1 shenniu.des=我愛祖國
2 shenniu.url.blogurl=http://www.a.com

  對映的實體還是用上面的,不過實體上需要增加註解 @PropertySource("classpath:my.properties") 表示自定義檔案源,並且同樣需要prefix來指定節點字首;我們增加如下展示介面:

1 @Autowired
2     private ShenniuConf shenniuConf;
3 
4     @GetMapping("/conf/des")
5     public String getDes() {
6         return shenniuConf.getDes();
7     }

  

實體對映多層級節點的值

  通常自定義配置節點都有層級關係,那我們實體有怎麼來獲取到不同層級的屬性值呢,事實上只需要在實體類裡面通過類層級關係來表示就行了,如上面ShenniuConf實體裡面的Url實體類屬性;

  

  這裡新增一個測試介面:

1     @Autowired
2     private ShenniuConf shenniuConf;
3     
4     @GetMapping("/conf/myconf")
5     public ShenniuConf getBlogurl() {
6         return shenniuConf;
7     }

  不出意外能得到如下結果:

  

相關文章