微服務 SpringBoot 2.0（二）：配置文件解析

properties我用了好多年，你卻讓我用yml，這是什么鬼 —— Java面試必修

引言

上一篇介紹了Spring Boot的輕松入門項目構建，對Spring Boot的特性有了初步了解。但如果要想玩得很熟練的話就請看接下來的文章，這樣有助於后續我們快速的構建企業級應用，打怪咱得先熟悉地圖對吧

配置詳解

工具

• SpringBoot版本：2.0.4
• 開發工具：IDEA 2018
• Maven：3.3 9
• JDK：1.8

配置文件類型

本文主要講解SpringBoot的配置文件，常用的配置文件類型有如下兩種，分為properties、yml，先甭管什么文件，SpringBoot都能正確加載讀取里面的參數，配置文件的路徑在：src/main/resources下

1. properties結尾的文件，這種想必大家都比較熟悉了，比如：jdbc.properties，或log4j.properties。
2. yml結尾的文件，YAML（Yet Another Markup Language）結構化的數據配置文件，諧音(亞妹襖)，ML和XML同音

動手嘗試

1. 2種配置均可讀取的固定代碼，配置請往下看

@RestController
@SpringBootApplication
public class DemoApplication {

    @Value("${com.demo.name}")
    private String name;

    @Value("${com.demo.url}")
    private String url;

    @RequestMapping("/index")
    public String index(){
        return "name：" + name +"，url：" + url ;
    }

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);

    }
}

 

2. application.properties，先來個簡單的配置，代碼@Value注解直接綁定

com.demo.name="JAVA面試必修" com.demo.url="www.itmsbx.com" 

結果：成功返回name：“Java面試必修”，url："www.itmsbx.com" 

---

3. 換成 application.yml 則內容如下

#注釋
com.demo.name: Java面試必修 com.demo.url: www.itmsbx.com ---- yml上下任選一種即可 com.demo: name: Java面試必修 url: www.itmsbx.com 

結果：name：Java面試必修，url：www.itmsbx.com 

---

Spring框架提供兩個便利的類用於加載YAML文檔，YamlPropertiesFactoryBean會將YAML加載為Properties，YamlMapFactoryBean會將YAML加載為Map，后續講解

Bean對象綁定

認識了配置文件后，我們發現yml中的數據綁定還挺好用的。但是問題來了，一個個綁定到屬性字段上太累，能換成對象，咱們就使用對象對吧，那也是可以的，我們建一個DemoBean.java類。

1. Bean類中使用注解 @ConfigurationProperties(prefix = “com.demo”)來指明綁定配置文件中哪個變量

@ConfigurationProperties(prefix = "com.demo")
public class DemoBean {

    //省略getter和setter
    private String name;
    private String url;

}

 

2. Controller中使用注解@EnableConfigurationProperties({DemoBean.class})來綁定實體類，並使用Autowired在成員變量處注入即可

@RestController
@SpringBootApplication
@EnableConfigurationProperties({DemoBean.class})
public class DemoApplication {

    @Autowired
    DemoBean demoBean;


    @RequestMapping("/index")
    public String index(){
        return "name：" + demoBean.getName() + "，url：" + demoBean.getUrl();
    }

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);

    }
}

 

結果：name：Java面試必修，url：www.itmsbx.com 

---

參數與參數間的引用

# 注釋 com.demo: name: Java面試必修 url: www.itmsbx.com scope: ${com.demo.name}的網址是${com.demo.url} 

這樣我們直接使用scope屬性就能看到效果了，注：properties和yml除了書寫格式上的差異外，使用方式基本類似，所以后續我們的講解中都建議使用yml文件

隨機參數生成

通常是用這些隨機數我們得寫一段代碼生成，現在配置文件中${random} 可以用來生成各種不同類型的隨機值，從而簡化了代碼生成的麻煩，例如 生成 int 值、long 值或者 string 字符串

demo.secret: ${random.value}
demo.number: ${random.int}
demo.bignumber: ${random.long}
demo.uuid: ${random.uuid}
demo.number.less.than.ten: ${random.int(10)}
demo.number.in.range: ${random.int[1024,65536]}

 

大家仔細思考下，${}很熟悉，我們用自己的變量也是${}包含起來的對不對，那其實這是SpringBoot已經封裝好的配置變量啦，類似於jsp中的隱式對象request一樣，拿來即用

命令行參數配置

Spring Boot是基於jar包運行的，打成jar包的程序可以直接通過下面命令運行：

java -jar demo-0.0.1-SNAPSHOT.jar 

可以使用下命令修改tomcat端口號：

java -jar demo-0.0.1-SNAPSHOT.jar --server.port=9090

等價於在yml中配置server.port: 9090，或properties中配置server.port=9090
java -jar demo-0.0.1-SNAPSHOT.jar

控制台輸出

$ java -jar myapp.jar --debug
但前提是你需要在yml或properties中指明 debug=true 

設置Spring profiles參數啟動

$ java -jar -Dspring.profiles.active=production demo-0.0.1-SNAPSHOT.jar 

命令啟動參數用 --xxx=xxx 的形式傳遞。命令行參數在demo.jar的后面，如果你擔心命令行有風險，則可以使用SpringApplication.setAddCommandLineProperties(false)禁用它。

運行或系統參數獲取

Spring Boot應用程序有多種設置途徑，Spring Boot能從多重屬性源獲得屬性，包括如下幾種（優先級從高到低排序）：

• 命令行參數
• SPRING_APPLICATION_JSON中的屬性(環境變量或系統屬性中的內聯JSON嵌入)。
• ServletConfig初始化參數。
• ServletContext初始化參數。
• 來自java:comp/env的JNDI屬性
• Java系統屬性（System.getProperties()）
• 操作系統環境變量
• RandomValuePropertySource配置的random.*屬性值，比如${random.long}
• jar包外部的application-{profile}.properties或application.yml(帶spring.profile)配置文件
• jar包內部的application-{profile}.properties或application.yml(帶spring.profile)配置文件
• jar包外部的application.properties或application.yml(不帶spring.profile)配置文件
• jar包內部的application.properties或application.yml(不帶spring.profile)配置文件
• @Configuration注解類上的@PropertySource
• 通過SpringApplication.setDefaultProperties指定的默認屬性

任何在高優先級屬性源里設置的屬性都會覆蓋低優先級的相同屬性，列如我們上面提到的命令行屬性就覆蓋了application.properties的屬性。

配置文件的優先級

application.properties和application.yml文件可以放在以下四個位置：

• 外置，在相對於應用程序運行目錄的/congfig子目錄里。
• 外置，在應用程序運行的目錄里
• 內置，在config包內
• 內置，在Classpath根目錄

同樣，這個列表按照優先級排序，也就是說，src/main/resources/config/application.properties覆蓋src/main/resources/application.properties中相同的屬性，如圖：

 

配置文件優先級

 

此外，如果你在相同優先級位置同時有application.properties和application.yml，那么application.properties里的屬性里面的屬性就會覆蓋application.yml

使用自定義的配置文件

對於同時加載多個properties配置文件，SpringBoot有注解@PropertySource支持，而yml多配置文件需要單獨用程序讀取，官方提供了YamlPropertySourceLoader.java類來支持，所以@PropertySource只能支持properties配置文件，如下：

@Configuration
@ConfigurationProperties(prefix = "com.custom")
@PropertySource("classpath:application-test.properties")
public class CustomBean {

    //省略getter和setter
    private String sex;
    private String age;
    private String desc;
    
}

 

若對於yml多配置文件，建議寫到一個里面，但如果分成多個環境加載不同配置，那接下來我們就講解下如何通過命令參數調用不同的yml

Profile-多環境配置

普通springmvc項目解決方案

在普通的springmvc的tomcat項目中，我們也可以指定JVM的運行參數，在啟動服務的時候通過System.getProperty("JVM配置key")獲取到這個參數，然后初始化不同的Properties文件，操作如下：

 

 

普通springmvc項目，properties文件

 <!-- 從properties文件加載配置信息 -->
    <bean id="propertyPlaceholderConfigurer" class="com.xx.xx.common.spring.CustomizedPropertyPlaceholderConfigurer">
        <property name="locations">
            <list>
                <!-- 此處配置文件需要在tomcat運行參數中指定[develop|test|product]其中一個，若不指定，默認取develop -->
                <value>classpath*:**/config/config-develop.properties</value>
                <value>classpath*:**/config/config-test.properties</value>
                <value>classpath*:**/config/config-product.properties</value>
            </list>
        </property>
        <property name="configureClasses">
            <list>
                <value>com.xx.xx.common.util.Constants</value>
            </list>
        </property>
    </bean>

    tomcat 中 catalina.bat（.sh中不用“set”） 添加JAVA_OPS。通過設置active選擇不同配置文件
    set JAVA_OPTS="-Dspring.profiles.active=test"

 

上述的CustomizedPropertyPlaceholderConfigurer類實現了PropertyPlaceholderConfigurer，在初始化的時候通過獲取JVM的profile進行不同的properties選取

SpringBoot解決方案

對於多環境的配置，各種項目構建工具或是框架的基本思路是一致的，通過配置多份不同環境的配置文件，再通過打包命令指定需要打包的內容之后進行區分打包，Spring Boot也不例外，或者說更加簡單。

在Spring Boot中多環境配置文件名需要滿足application-{profile}.yml的格式，其中{profile}對應你的環境標識，如下圖：

 

yml結構

至於哪個具體的配置文件會被加載，需要在application.yml文件中通過spring.profiles.active屬性來設置，其值對應{profile}值。如：spring.profiles.active=prod就會加載application-prod.yml配置文件內容

application.yml內容如下

spring.profiles.active: dev 

application-dev.yml內容如下

server:
  port: 1000

application-prod.yml內容如下

server:
  port: 1001

啟動的時候帶上參數：java -jar xxx.jar --spring.profiles.active=dev，就會發現啟動的端口不一樣，說明配置文件生效了

---

代碼使用profile

除了可以用profile的配置文件來分區配置我們的環境變量，在代碼里，我們還可以直接用@Profile注解來進行配置，例如數據庫配置，這里我們先定義一個接口

public interface DBConnector { public void dbConfig(); } 

分別定義倆個實現類來實現它

/**
  * 開發數據庫
  */
@Component
@Profile("devdb")
public class DevDBConnector implements DBConnector {
    @Override
    public void dbConfig() {
        System.out.println("devdb");
    }
}
/**
 * 生產數據庫
 */
@Component
@Profile("prodb")
public class ProDBConnector implements DBConnector {
    @Override
    public void dbConfig() {
        System.out.println("prodb");
    }
}

 

通過在配置文件激活具體使用哪個實現類

spring.profiles.active=prodb

然后具體調用如下

@RestController
@RequestMapping("/call")
public class CallController {

    @Autowired DBConnector connector ;

    @RequestMapping(value = {"/",""})
    public String hellYml(){

        connector.dbConfig(); //最終打印prodb
        return "Hello yml";
    }
}

 

總結

SpringBoot的配置文件給我們帶來了極大的便利，properties和yml兩者各選一個吧，不過我更傾向於yml，其格式化的配置看起來很舒服，有點類似於json格式，更多的屬性及配置后續在使用的過程中慢慢講解。

---

作者有話說：喜歡的話就請移步Java面試必修網，請自備水，更多干、干、干貨等着你