Spring?Boot怎么配置文件類型的properties格式與yml格式

本篇內容介紹了“Spring Boot怎么配置文件類型的properties格式與yml格式”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

一 配置文件類型

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格式”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！