Spring Boot 組態檔型別properties 格式與yml 格式

2022-05-18 16:02:16

一組態檔型別

Spring Boot預設支援properties和yml兩種格式的組態檔。yml格式是天然的樹狀介面，相對於properties，yml更加的一目瞭然。這也是我們推薦的組態檔格式。

properties 格式舉例：

server.port=8090
server.session-timeout=30
server.tomcat.max-threads=0
server.tomcat.uri-encoding=UTF-8

spring.datasource.url=jdbc:mysql://localhost:3306/newbirds
spring.datasource.username=root
spring.datasource.password=mymysql
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.jpa.database=MYSQL
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=update
spring.jpa.hibernate.naming-strategy=org.hibernate.cfg.ImprovedNamingStrategy
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect

yml 格式舉例：

server:
  port: 8090
  session-timeout: 30
  tomcat.max-threads: 0
  tomcat.uri-encoding: UTF-8
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/newbirds
    username: root
    password: mymysql
    driverClassName: com.mysql.jdbc.Driver
  jpa:
    database: MYSQL
    show-sql: true
    hibernate:
      ddl-auto: update
      naming-strategy: org.hibernate.cfg.ImprovedNamingStrategy
    properties:
      hibernate:
      dialect : org.hibernate.dialect.MySQL5Dialect

二組態檔

2.1 核心組態檔

Spring Boot預設支援兩種核心組態檔:bootstrap.yml(bootstrap.properties)、application.yml(application.properties)。bootsrap先載入。

2.1.1 bootstrap.yml(bootstrap.properties)

bootstrap.yml用於應用程式上文的引導節點，由父Spring ApplicationContext載入。我們可以簡單的把bootstrap裡面的設定資訊理解成系統級別的引數。這些引數輕易是不會改變的。

bootstrap組態檔有以下幾個應用場景：

使用Spring Cloud Config的時候，需要將spring.application.name和spring.cloud.config.server.git.uri寫入bootstrap.yml。
一些固定的不能被覆蓋的屬性。
一些加密/解密的場景。會把encryption/decryption（加密/解密）儲存在bootstrap.yml裡面。

一旦bootStrap.yml 被載入，則內容不會被覆蓋，即便後期載入的application.yml的內容標籤與bootstrap的標籤一致，application 也不會覆蓋bootstrap。

2.1.2 application.yml(application.properties)

application.yml是我們用的最多的一個組態檔.一般設定應用級別的設定，比如資料庫的連線設定，如果我們用到了redis可能會寫一些redis相關的設定等等。

2.2 自定義組態檔

為了不破壞核心檔案的原生態，但又需要有自定義的設定資訊存在，一般情況下會選擇自定義組態檔來放這些自定義資訊,比如我們在resource目錄下建立一個product.properties檔案.

resources/product.properties檔案內容如下：

ppid = 1000
mmid = 1
ccid = 10

三組態檔讀取

3.1 讀取核心組態檔資訊

讀取核心組態檔資訊值的是讀取bootstrap.yml(bootstrap.properties)、application.yml(application.properties)檔案裡面的資訊.

3.1.1 Environment方式

這種方式是依賴注入Evnironment來完成，在建立的成員變數private Environment env上加上@Autowired註解即可完成依賴注入，然後使用env.getProperty("鍵名")即可讀取出對應的值。比如如下的程式碼.

application.yml檔案裡面新增我們自定義的屬性：

# 自定義的一些屬性
user:
  info:
    name: tuacy
    age: 27

Environment方式讀取設定資訊：

@RunWith(SpringRunner.class)
@SpringBootTest()
public class PropertiesTest {
    private Environment environment;
    @Autowired
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }
    @Test
    public void test() {
        String name = environment.getProperty("user.info.name");
        Integer age = environment.getProperty("user.info.age", Integer.class);
        System.out.println("name = " + name + "; age = " + age);
        
    }
}

3.1.2 @Value方式

在@Value的${}中包含的是核心組態檔中的鍵名就可以得到對應的值.

@RunWith(SpringRunner.class)
@SpringBootTest()
public class PropertiesTest {
    @Value("${user.info.name}")
    private String name;
    @Value("${user.info.age}")
    private int age;
    @Test
    public void test() {
        System.out.println("name = " + name + "; age = " + age);
    }
}

3.1.3 @ConfigurationProperties方式

@ConfigurationProperties使用的時候對應的屬性類一定要記得加上@Configuration或者在任何一個設定類(推薦啟動類上)通過@EnableConfigurationProperties註解指定自定義的屬性類.推薦直接在屬性類上新增@Configuration註解.

@Configuration
@ConfigurationProperties(prefix = "user.info")
public class UserInfo {
    private int age;
    private String name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

3.2 讀取自定義組態檔資訊

3.2.1 @PropertySource + @Value

@PropertySource + @Value使用於讀取property根式組態檔的資訊.@PropertySource指定組態檔路徑和編碼格式,@Value指定組態檔裡面的key值.

自定義的組態檔 product.properties：

ppid = 1000
mmid = 1
ccid = 10

對應的讀取方式：

@Configuration
@PropertySource(value = "classpath:product.properties", encoding = "utf-8")
public class ProductInfo {
    @Value("${ppid}")
    private int pid;
    @Value("${mmid}")
    private int mid;
    @Value("${ccid}")
    private int cid;
    public int getPid() {
        return pid;
    }
    public void setPid(int pid) {
        this.pid = pid;
    }

    public int getMid() {
        return mid;
    }

    public void setMid(int mid) {
        this.mid = mid;
    }

    public int getCid() {
        return cid;
    }

    public void setCid(int cid) {
        this.cid = cid;
    }
}

3.2.2 @ConfigurationProperties + @PropertySource + @Value

@ConfigurationProperties + @PropertySource + @Value適用於讀取yml格式組態檔資訊.@PropertySource指定組態檔路徑和編碼格式,@ConfigurationProperties和@Value指定組態檔裡面的key值.

組態檔：

admin:
  user:
    name: tuacy
    age: 25

對應組態檔的讀取方式：

@Configuration
@PropertySource(value = "classpath:role.yml")
@ConfigurationProperties(prefix = "admin.user")
public class RoleUserInfo {

    @Value("${name}")
    private String name;
    @Value("${age}")
    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

四組態檔的載入順序

優先順序由高到底，高優先順序的設定會覆蓋低優先順序的設定,
全部載入組態檔並互補設定.

4.1 專案內部組態檔載入順序

SpringBoot組態檔可以放置在多種路徑下，不同路徑下的設定優先順序有所不同。可放置目錄(優先順序從高到低)

當前專案根目錄下的config目錄下。
當前專案根目錄下。
resources目錄下的config目錄下。
resource目錄下。

4.2 專案外部組態檔載入順序

優先順序由高到低：

命令列引數
來自java:comp/env的JNDI屬性
Java系統屬性（System.getProperties()）
作業系統環境變數
RandomValuePropertySource設定的random.*屬性值
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指定的預設屬性

到此這篇關於Spring Boot 組態檔型別properties 格式與yml 格式的文章就介紹到這了,更多相關Spring Boot 組態檔內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！