Spring Boot 屬性配置和使用

Spring Boot 允許通過外部配置讓你在不同的環境使用同一應用程式的程式碼，簡單說就是可以通過配置檔案來注入屬性或者修改預設的配置。這些方式優先順序如下：

1.命令列引數

(1).通過java -jar app.jar –name=”Spring” –server.port=9090方式來傳遞引數。引數用–xxx=xxx的形式傳遞。

(2).可以使用的引數可以是我們自己定義的，也可以是Spring Boot中預設的引數。

(3).注意：命令列引數在app.jar的後面！
可以通過SpringApplication.setAddCommandLineProperties(false)禁用命令列配置。

2.來自java:comp/env的JNDI屬性

J2EE上下文環境變數字首,一般有如下幾種:
java:/comp/env/jdbc
java:/comp/env/url
java:/comp/env/mail
java:/comp/env/jms
在部署和執行EJB中,容器將在java:/comp/env/處建立一個JNDI上下文環境,在該環境中,可以查詢獲得
在ejb-jar.xml中定義的變數,通過在程式中用JNDI的lookup()方法查詢java:/comp/env/後面的變數名得到的.這些值是隻讀的,也只供本地J2EE元件使用,而客戶機無法獲取這些值.

3.Java系統屬性（System.getProperties()）

(1).注意Java系統屬性位置java -Dname=”demo” -jar app.jar，可以配置的屬性都是一樣的，優先順序不同。

(2).例如java -Dname=”demo” -jar app.jar –name=”Spring!”中name值為Spring!

4.作業系統環境變數

配置過JAVA_HOME的應該都瞭解這一個。同一樣的，如果在統環境變數環境變數這增加PRO_ENV=test的環境變數，則下面的配置會生效，即讀取application-{profile}.properties或application-{profile}.yml並且profile為test的配置檔案,而不是profile為local的配置檔案。

spring:
  profiles: 
    active: ${PRO_ENV,local}

5.RandomValuePropertySource配置的random.*屬性值

系統中用到隨機數的地方，例如：

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

random.int()支援value引數和max引數，當提供max引數的時候，value就是最小值。

6.jar包外部的application-{profile}.properties或application.yml(帶spring.profile)配置檔案

(1).在properties配置檔案中直接寫：

name=demo

server.port=8080

: (2).yml格式的配置檔案如：

name: demo
server:
  port: 8080

當有字首的情況下，使用.yml格式的配置檔案更簡單。

注意：使用.yml時，屬性名的值和冒號中間必須有空格，如name: demo正確，name:demo就是錯的。

(3).屬性配置檔案的位置

spring會從classpath下的/config目錄或者classpath的根目錄查詢application.properties或application.yml。/config優先於classpath根目錄

7.jar包內部的application-{profile}.properties或application.yml(帶spring.profile)配置檔案

具體配置同上。

8.jar包外部的application.properties或application.yml(不帶spring.profile)配置檔案

具體配置同上。

9.jar包內部的application.properties或application.yml(不帶spring.profile)配置檔案

具體配置同上。

[email protected]註解類上的@PropertySource

這個註解可以指定具體的屬性配置檔案，優先順序比較低。

11.通過SpringApplication.setDefaultProperties指定的預設屬性

SpringApplication application = new SpringApplication(Application.class);
Map<String, Object> defaultMap = new HashMap<String, Object>();
defaultMap.put("spring.profiles.active", "local");
//還可以是Properties物件
application.setDefaultProperties(defaultMap);
application.run(args);

12.spring boot配置屬性的使用

(1)[email protected](“${xxx}”)

這種方式是最簡單的，通過@Value註解可以將屬性值注入進來。

(2)[email protected]

Spring Boot 可以方便的將屬性注入到一個配置物件中。例如：

spring:
  datasource:
    druid:
      driverClassName: com.mysql.jdbc.Driver
      url: jdbc:mysql://localhost:3306/ddemo?useUnicode=true&characterEncoding=utf-8
      username: root
      password: 555222
      filters: stat
      connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000

對應物件：

@ConfigurationProperties(prefix = "spring.datasource.druid")
public class DatasourceProperties {

    private String driverClassName;

    private String url;

    private String username;

    private String password;

    private String filters;

    private String connectionProperties;

    // ... getters and setters
}

Spring Boot 會自動將prefix=”spring.datasource.druid”字首為my的屬性注入進來。

Spring Boot 會自動轉換型別，當使用List的時候需要注意在配置中對List進行初始化！

:(3).Spring Boot 還支援巢狀屬性注入，例如：

name=isea533
jdbc.username=root
jdbc.password=root
...

對應的配置類：

@ConfigurationProperties
public class Config {
    private String name;
    private Jdbc jdbc;
    class Jdbc {
        private String username;
        private String password;
        //getter...
    }

    public Integer gePort(){
        return this.port;
    }
    public Jdbc getJdbc() {
        return this.jdbc;
    }
}

jdbc開頭的屬性都會注入到Jdbc物件中。

13.屬性佔位符

例如：

app:
  name: demo
  description: ${app.name} is a Spring Boot application

可以在配置檔案中引用前面配置過的屬性（優先順序前面配置過的這裡都能用）。

(1).通過如${app.name:預設名稱}方法還可以設定預設值，當找不到引用的屬性時，會使用預設的屬性。

由於方式會被Maven處理。如果你pom繼承的spring−boot−starter−parent，SpringBoot已經將maven−resources−plugins默認的{}方式改為了@ @方式，例如@[email protected]。

(2)如果你是引入的Spring Boot，你可以修改使用其他的分隔符

通過屬性佔位符還能縮短命令引數
例如修改web預設埠需要使用–server.port=9090方式，如果在配置中寫上：

server:
  port: ${port:8080}

那麼就可以使用更短的–port=9090，當不提供該引數的時候使用預設值8080。

14.屬性名匹配規則

例如有如下配置物件：

@Component
@ConfigurationProperties(prefix="person")
public class ConnectionSettings {
    private String firstName;
}

firstName可以使用的屬性名如下：

1>.person.firstName，標準的駝峰式命名
2>.person.first-name，虛線（-）分割方式，推薦在.properties和.yml配置檔案中使用
3>.PERSON_FIRST_NAME，大寫下劃線形式，建議在系統環境變數中使用

15.屬性驗證

可以使用JSR-303註解進行驗證，例如：

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