現(xiàn)在開發(fā)主要使用微服務(wù)框架springboot，在springboot中經(jīng)常遇到讀取application.yml文件的情形。

開發(fā)過程中經(jīng)常遇到要讀取application.yml文件中的屬性值，本文總結(jié)幾種讀取的方式，供參考。

我這里使用的是springboot-2.1.2.RELEASE版本，這里使用的是application.properties的配置方式，和使用application.yml的方式是一樣的。下面是application.properties文件的內(nèi)容

cn.com.my.test1=test1cn.com.my.test2=test21、@Value注解

這種方式是spring最早提供的方式，通過@Value注解的方式，該注解用在屬性上，但是要求該屬性所在的類必須要被spring管理。

package com.example.demo.controller;import org.springframework.beans.factory.annotation.Value;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.ResponseBody;@Controllerpublic class TestController { @Value('${cn.com.my.test1}') private String test1; @Value('${cn.com.my.test2}') private String test2; @RequestMapping('/test1/test') @ResponseBody public String getTest(){ return 'hello:'+test1+',test2:'+test2; }}

在標(biāo)記有@Controller類中使用了帶有@Value注解的test1和test2的屬性，首先標(biāo)記有@Controller注解便可以使該類被spring管理。其次，使用@Value標(biāo)記了屬性，則可以獲得application.properties（application.yml）文件中的屬性，這里使用${cn.com.my.test1}，屬性的名稱必須是全部的名稱，測試結(jié)果如下，

@ConfigurationProperties注解是springboot提供的，在springboot中大量使用，下面看其用法，

使用@Component注解

這里需要定義一個(gè)類，

package com.example.demo.properties;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.stereotype.Component;@Component@ConfigurationProperties(prefix = 'cn.com.my')public class ApplicationPro { private String test1; private String test2; private String testName; //必須有set方法 public void setTest1(String test1) { this.test1 = test1; } //必須有set方法 public void setTest2(String test2) { this.test2 = test2; } public String getTest1() { return test1; } public String getTest2() { return test2; }public void setTestName(String testName) { this.testName = testName;}public String getTestName() { return testName;}}

該類上使用了@ConfigurationProperties注解，且配置了prefix屬性，指定了要獲取屬性的前綴，這里的前綴是cn.com.my，在類中定義的屬性名最好和application.properties文件中的一致，不過這種方式可以采用稀疏匹配，把a(bǔ)pplication.properties修改為下面的內(nèi)容，

cn.com.my.test1=test1cn.com.my.test2=test2cn.com.my.test-name='hello world'

另外，在ApplicationPro類上標(biāo)記有@Component注解，標(biāo)記該注解的意思是要把該類交給spring管理，也就是說要讓spring管理此類，其實(shí)也可以使用其他注解，如，@Service等

下面看測試類，

package com.example.demo.controller;import com.example.demo.properties.ApplicationPro;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;@Controllerpublic class TestController3 { @Autowired private ApplicationPro ap; @RequestMapping('test3/test') @ResponseBody public String getTest(){ return ap.getTest1()+','+ap.getTest2()+','+ap.getTestName(); }}

看測試結(jié)果，

從上面的結(jié)果可以看出已經(jīng)獲得了application.properties文件中的值，并且獲得了test-name的值。具體匹配規(guī)則可以自行百度，這里強(qiáng)烈建議配置文件中的屬性和類中的保持一致。

使用@EnableConfigurationProperties注解使用該注解在ApplicationPro類中便不需要使用@Component注解，

package com.example.demo.properties;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.stereotype.Component;//@Component@ConfigurationProperties(prefix = 'cn.com.my')public class ApplicationPro { private String test1; private String test2; private String testName; //必須有set方法 public void setTest1(String test1) { this.test1 = test1; } //必須有set方法 public void setTest2(String test2) { this.test2 = test2; } public String getTest1() { return test1; } public String getTest2() { return test2; } public void setTestName(String testName) { this.testName = testName; } public String getTestName() { return testName; }}

再看啟動(dòng)類，在啟動(dòng)類上標(biāo)記了@EnableConfigurationProperties({ApplicationPro.class})，也就是使@ConfigurationProperties注解生效，并標(biāo)記了標(biāo)有@ConfigurationProperties注解的類Application.class

package com.example.demo;import com.example.demo.properties.ApplicationPro;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.boot.context.properties.EnableConfigurationProperties;@SpringBootApplication@EnableConfigurationProperties({ApplicationPro.class})public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); }}

下面看測試結(jié)果，

使用Environment對象，該對象是spring提供的一個(gè)對象，且是spring內(nèi)部創(chuàng)建的對象，

package com.example.demo.controller;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.core.env.Environment;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.ResponseBody;@Controllerpublic class TestController2 { @Autowired private Environment environment; @RequestMapping('/test2/test') @ResponseBody public String getTest(){ return 'hello,'+environment.getProperty('cn.com.my.test1')+','+'test2:'+environment.getProperty('cn.com.my.test2'); }}

可以看到，可以直接注入該對象的實(shí)例，通過其getProperty方法獲得相應(yīng)的屬性值。

本文總結(jié)了，在使用springboot的過程中獲取配置文件中的幾種方式，

@Value

@ConfigurationProperties

Environment對象

有不當(dāng)之處，歡迎指正，謝謝。

以上就是springboot如何讀取application.yml文件的詳細(xì)內(nèi)容，更多關(guān)于springboot 讀取application.yml文件的資料請關(guān)注好吧啦網(wǎng)其它相關(guān)文章！