spring boot 配置文件application

場景：在項目部署的過程中，對於spring boot的配置文件一直不很了解，直到項目出現一個莫名其妙的問題——工程classes中的配置文件被覆蓋，程序啟動總是報錯！

 

1  配置文件的優先級

application.properties大家都不陌生，我們在開發的時候，經常使用它來配置一些可以手動修改而且不用編譯的變量，這樣的作用在於，打成war包或者jar用於生產環境時，我們可以手動修改環境變量而不用再重新編譯。

spring boo默認已經配置了很多環境變量，例如，tomcat的默認端口是8080，項目的contextpath是“/”等等，可以在這里看spring boot默認的配置信息http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-external-config

1.1 配置項讀取順序

1. 命令行參數
2. 通過 SPRING_APPLICATION_JSON 設置的值
3. JNDI attributes from java:comp/env
4. Java 系統屬性(System.getProperties())
5. 操作系統環境變量
6. A RandomValuePropertySource that only has properties in random.*.
7. 項目 Jar 外的Profile 相關的配置文件(application-{profile}.properties)
8. Jar 內的Profile 相關的配置文件(application-{profile}.properties)
9. 項目 Jar 外的配置文件(application.properties)
10. Jar 內的配置文件(application.properties)
11. @PropertySource annotations on your @Configuration classes.
12. 默認屬性 (SpringApplication.setDefaultProperties)

1.2  application.properties 查找位置

除了在application.properties配置參數，還有多種方式可以設定參數。Spring Boot 按照下面的順序查找配置項：

spring boot允許你自定義一個application.properties文件，然后放在以下的地方，來重寫spring boot的環境變量或者定義你自己環境變量

Spring Boot 默認從4個位置查找application.properties文件。

1. 當前目錄下的/config目錄
2. 當前目錄
3. 類路徑下的/config目錄
4. 類路徑根目錄

說明：
當前目錄指的是運行Jar文件時的目錄，不一定是jar文件所在目錄，所有上面前2項是Jar包外目錄。

如果同時在四個地方都有配置文件，配置文件的優先級是從1到4。

• 當前目錄，目前不知道如何確定，但是spring在啟動的時候會顯示當前目錄：

根據xxxApplicationStarter可以定位到當前目錄。然后根據需要配置配置文件。

 

• 類路徑：

也就是classes目錄。

 1.3 讀取和設置配置文件屬性

參考文章http://www.nathanyan.com/2016/01/25/Spring-Boot-04-%E9%85%8D%E7%BD%AE%E7%9B%B8%E5%85%B3/

 使用配置文件之后，spring boo啟動時，會自動把配置信息讀取到spring容器中，並覆蓋spring boot的默認配置，那么，我們怎么來讀取和設置這些配置信息呢

1.通過命令行來重寫和配置環境變量，優先級最高，例如可以通過下面的命令來重寫spring boot 內嵌tomcat的服務端口，注意“=”倆邊不要有空格

java -jar demo.jar --server.port=9000

如果想要設置多個變量怎么辦，可以已json的格式字符串來設置

java -jar demo.jar --spring.application.json='{"foo":"bar"}'

 

 

2.通過@value注解來讀取

@RestController
@RequestMapping("/task")
public class TaskController {

@Value("${connection.remoteAddress}") private String address;

@RequestMapping(value = {"/",""})
public String hellTask(@Value("${connection.username}")String name){

    return "hello task !!";
}

}

 

 

3.通過Environment接口來獲取，只需要把接口注進去即可

@RestController
@RequestMapping("/task")
public class TaskController {

@Autowired Environment ev ;

@Value("${connection.remoteAddress}") private String address;

@RequestMapping(value = {"/",""})
public String hellTask(@Value("${connection.username}")String name){

    String password = ev.getProperty("connection.password");
    return "hello task !!";
}

}

 

 

4.可以自定義一個工具類，來獲取，這種方式關鍵在於讀取配置文件信息，適合自定義的配置信息，spring 容器默認的配置信息會讀不到

@Component
public class SystemConfig {

    private static Properties props ;

    public SystemConfig(){

        try {
            Resource resource = new ClassPathResource("/application.properties");//
            props = PropertiesLoaderUtils.loadProperties(resource);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }


    /**
     * 獲取屬性
     * @param key
     * @return
     */
    public static String getProperty(String key){

        return props == null ? null :  props.getProperty(key);

    }

    /**
     * 獲取屬性
     * @param key 屬性key
     * @param defaultValue 屬性value
     * @return
     */
    public static String getProperty(String key,String defaultValue){

         return props == null ? null : props.getProperty(key, defaultValue);

    }

    /**
     * 獲取properyies屬性
     * @return
     */
    public static Properties getProperties(){
        return props;
    }

}

//用的話，就直接這樣子
String value = SystemConfig.getProperty("key");

 

 

5.可以利用${…}在application.properties引用變量

myapp.name=spring
myapp.desc=${myapp.name} nice

 

6.可以在application.properties配置隨機變量,利用的是RandomValuePropertySource類

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

 

 

7.綁定屬性值到Bean

YAML文件

properties文件在面對有層次關系的數據時，就有點不合適。YAML 支持一種類似JSON的格式，可以表現具有層次的數據。詳細說明看這里.
YAML的內容會轉換為properties格式，如下:

environments:
    dev:
        url: http://dev.bar.com
        name: Developer Setup
    prod:
        url: http://foo.bar.com
        name: My Cool App
my:
   servers:
       - dev.bar.com
       - foo.bar.com

 

 

environments.dev.url=http://dev.bar.com
environments.dev.name=Developer Setup
environments.prod.url=http://foo.bar.com
environments.prod.name=My Cool App
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com

可以用@Value("${environments.dev.url}")注入.

 

YAML的一個特性就是可以把多個文件的配置項，合並到一個文件里。用---分隔。

server:
    address: 192.168.1.100
---
spring:
    profiles: development
server:
    address: 127.0.0.1
---
spring:
    profiles: production
server:
    address: 192.168.1.120

再結合spring.profiles可以指定Profile下使用哪個配置項.

Spring Boot 也支持Profile特性，Profile相關的配置文件命名為:application-{profile}.properties,可以用spring.profiles.active激活Profile:

java -jar target/demo-0.0.1-SNAPSHOT.jar --spring.profiles.active=test

 

 

雖然可以通過@Value("${property}")注入屬性值,如果有多項需要注入，就有點麻煩了。@ConfigurationProperties可以直接把多個屬性值綁定到Bean上。

配置文件：

# application.yml

connection:
    username: admin
    remoteAddress: 192.168.1.1

 

使用：

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
    private String username;
    private InetAddress remoteAddress;
    // ... getters and setters
}

 

 

也可以在創建Bean時注入：

@ConfigurationProperties(prefix = "foo")
@Bean
public FooComponent fooComponent() {
    ...
}

 

 

 

3