spring boot（4）application.properties配置和使用

      Spring Boot使用了一個全局的配置文件application.properties，放在src/main/resources目錄下或者類路徑的/config下。Sping Boot的全局配置文件的做用是對一些默認配置的配置值進行修改。接下來，讓咱們一塊兒來解開配置文件的面紗。

注:若是你工程沒有這個application.properties，那就在src/main/java/resources目錄下新建一個。

1 自定義屬性

      application.properties提供自定義屬性的支持，這樣咱們就能夠把一些常量配置在這裏：

com.qiuqiu.name="球球"
com.qiuqiu.want="祝你們雞年大吉！"

      而後直接在要使用的地方經過註解@Value(value=」${XXX}」)就能夠綁定到你想要的屬性上面

@RestController
public class UserController {
    @Value("${com.qiuqiu.name}")
    private  String name;
    @Value("${com.qiuqiu.want}")
    private  String want;

    @RequestMapping("/hello")
    public String hello(){
        return name+","+want;
    }
}

      屬性不少時，一個個綁定到屬性字段上太麻煩，官方提倡綁定一個對象的bean，這裏咱們建一個ConfigBean.java類，頂部須要使用註解@ConfigurationProperties(prefix = 「XXX」)來指明使用哪一個  

@ConfigurationProperties(prefix = "com.qiuqiu")
public class ConfigBean {
    private String name;
    private String want;

    // 省略getter和setter
}

        Spring Boot 會自動轉換類型，當使用List的時候須要注意在配置中對List進行初始化！Spring Boot 還支持嵌套屬性注入。

name=Isea533
servers[0]=dev.bar.com
servers[1]=foo.bar.com
jdbc.username=root
jdbc.password=root

@ConfigurationProperties
public class Config {
    private String name;
    private List<String> servers = new ArrayList<String>();
    private Jdbc jdbc;
    // 省略getter和setter

    class Jdbc {
        private String username;
        private String password;
        // 省略getter和setter
    }
}

      另一種使用配置文件屬性的方式，在@Bean方法上使用@ConfigurationProperties

@ConfigurationProperties(prefix = "com.qiuqiu")
@Bean
public ConfigBean configBean() {
    ...
}

2 屬性佔位符

      例如：

app.name=MyApp
app.description=${app.name} is a Spring Boot application

      能夠在配置文件中引用前面配置過的屬性（優先級前面配置過的這裏都能用）。經過如${app.name:默認名稱}方法還能夠設置默認值，當找不到引用的屬性時，會使用默認的屬性。因爲${}方式會被Maven處理。若是你pom繼承的spring-boot-starter-parent，Spring Boot 已經將maven-resources-plugins默認的${}方式改成了@ @方式，例如@name@。若是你是引入的Spring Boot，你能夠修改使用其餘的分隔符。

      經過屬性佔位符還能縮短命令參數

      例如修改web默認端口須要使用--server.port=9090方式，若是在配置中寫上：

server.port=${port:8080}

      那麼就可使用更短的--port=9090，當不提供該參數的時候使用默認值8080。

3 使用自定義配置文件

      有時咱們不但願把全部配置都放在application.properties裏面，這時候咱們能夠另外定義一個，這裏咱們定義一個名爲test.properties配置文件，路徑跟也放在src/main/resources下面。

com.md.name="球球"
com.md.want="祝你們雞年大吉"

@Configuration
@ConfigurationProperties(prefix = "com.md") 
@PropertySource("classpath:test.properties")
public class ConfigTestBean {
    private String name;
    private String want;
    // 省略getter和setter
}

注：若是你使用的是1.5之前的版本，那麼能夠經過locations指定properties文件的位置，這樣：
@ConfigurationProperties(prefix = "config2",locations="classpath:test.properties")
可是1.5版本以後就沒有這個屬性，須要添加@Configuration和@PropertySource(「classpath:test.properties」)後才能夠讀取。

4 隨機值配置

      配置文件中${random.*} 能夠用來生成各類不一樣類型的隨機值，從而簡化了代碼生成的麻煩，例如 生成 int 值、long 值或者 string 字符串。

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

5 外部配置-命令行參數配置

      Spring Boot是基於jar包運行的，打成jar包的程序能夠直接經過下面命令運行：

java -jar xx.jar

      能夠如下命令修改tomcat端口號：

java -jar xx.jar --server.port=9090

      能夠看出，命令行中連續的兩個減號--就是對application.properties中的屬性值進行賦值的標識。
因此java -jar xx.jar --server.port=9090等價於在application.properties中添加屬性server.port=9090。
若是你怕命令行有風險，可使用SpringApplication.setAddCommandLineProperties(false)禁用它。

      實際上，Spring Boot應用程序有多種設置途徑，Spring Boot能從多重屬性源得到屬性，包括以下幾種：

• 根目錄下的開發工具全局設置屬性(當開發工具激活時爲~/.spring-boot-devtools.properties)。
• 測試中的@TestPropertySource註解。
• 測試中的@SpringBootTest#properties註解特性。
• 命令行參數
• SPRING_APPLICATION_JSON中的屬性(環境變量或系統屬性中的內聯JSON嵌入)。
• ServletConfig初始化參數。
• ServletContext初始化參數。
• java:comp/env裏的JNDI屬性
• JVM系統屬性
• 操做系統環境變量
• 隨機生成的帶random.* 前綴的屬性（在設置其餘屬性時，能夠應用他們，好比${random.long}）
• 應用程序之外的application.properties或者appliaction.yml文件
• 打包在應用程序內的application.properties或者appliaction.yml文件
• 經過@PropertySource標註的屬性源
• 默認屬性(經過SpringApplication.setDefaultProperties指定).

      這裏列表按組優先級排序，也就是說，任何在高優先級屬性源裏設置的屬性都會覆蓋低優先級的相同屬性，例如咱們上面提到的命令行屬性就覆蓋了application.properties的屬性。

6 配置文件優先級

      application.properties和application.yml文件能夠放在如下四個位置：

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

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

   此外，若是你在相同優先級位置同時有application.properties和application.yml，那麼application.properties裏的屬性裏面的屬性就會覆蓋application.yml。

7 profile-多環境配置

      當應用程序須要部署到不一樣運行環境時，一些配置細節一般會有所不一樣，最簡單的好比日誌，生產日誌會將日誌級別設置爲WARN或更高級別，並將日誌寫入日誌文件，而開發的時候須要日誌級別爲DEBUG，日誌輸出到控制檯便可。
      若是按照之前的作法，就是每次發佈的時候替換掉配置文件，這樣太麻煩了，Spring Boot的Profile就給咱們提供瞭解決方案，命令帶上參數就搞定。
      在Spring Boot中多環境配置文件名須要知足application-{profile}.properties的格式，其中{profile}對應你的環境標識，好比：

• application-dev.properties：開發環境
• application-prod.properties：生產環境

      想要使用對應的環境，只須要在application.properties中使用spring.profiles.active屬性來設置，值對應上面提到的{profile}，這裏就是指dev、prod這2個。
      固然你也能夠用命令行啓動的時候帶上參數：

java -jar xxx.jar --spring.profiles.active=dev

      除了能夠用profile的配置文件來分區配置咱們的環境變量，在代碼裏，咱們還能夠直接用@Profile註解來進行配置，例如數據庫配置，這裏咱們先定義一個接口 :

public  interface DBConnector {
    public  void  configure(); 
}

      定義倆個實現類來實現它:

/**
  * 測試數據庫
  */
@Component
@Profile("testdb")
public class TestDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("testdb");
    }
}
/**
 * 生產數據庫
 */
@Component
@Profile("devdb")
public class DevDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("devdb");
    }
}

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

spring.profiles.active=testdb

      而後就能夠以下方使用：

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

    @Autowired DBConnector connector ;

    @RequestMapping(value = "/hello")
    public String helloTask(){

        connector.configure(); //最終打印testdb     
        return "hello task !! myage is " + myage;
    }
}

      除了spring.profiles.active來激活一個或者多個profile以外，還能夠用spring.profiles.include來疊加profile。

spring.profiles.active=testdb  
spring.profiles.include=proddb,prodmq

8 讀取系統環境變量和application配置文件中的屬性

• 實現EnvironmentAware接口

import org.springframework.boot.bind.RelaxedPropertyResolver;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;

@Configuration
public class MyEnvironmentAware implements EnvironmentAware {
	/**
	 * 注意重寫的方法 setEnvironment是在系統啓動的時候被執行。
	 */
	@Override
	public void setEnvironment(Environment environment) {
		// 經過 environment 獲取到系統屬性.
		System.out.println(environment.getProperty("JAVA_HOME"));

		// 經過 environment 一樣能獲取到application.properties配置的屬性.
		System.out.println(environment.getProperty("spring.datasource.url"));

		// 獲取到前綴是"spring.datasource." 的屬性列表值.
		RelaxedPropertyResolver relaxedPropertyResolver = new RelaxedPropertyResolver(environment,
				"spring.datasource.");
		System.out.println("spring.datasource.url=" + relaxedPropertyResolver.getProperty("url"));
		System.out.println("spring.datasource.driverClassName=" + relaxedPropertyResolver.getProperty("driverClassName"));
	}
}

• 實現ApplicationContextAware接口

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;

@Component
public class SpringCtxHolder implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    private static Environment env;

    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringCtxHolder.applicationContext = applicationContext;
        env = applicationContext.getEnvironment();
    }

    public static Environment getEnv() {
        return env;
    }

    public static void setEnv(Environment env) {
        SpringCtxHolder.env = env;
    }

    public static String getProperty(String key) {
        if (StringUtils.isEmpty(key)) {
            return "";
        }
        return env.getProperty(key);
    }
}

SpringCtxHolder.getProperty("spring.datasource.url");