SpringBoot配置文件

1.1 SpringBoot配置文件類型

1.1.1 SpringBoot配置文件類型和作用

SpringBoot是基於約定的，所以很多配置都有默認值，但如果想使用自己的配置替換默認配置的話，就可以使用application.properties或者application.yml（application.yaml）進行配置。

SpringBoot默認會從Resources目錄下加載application.properties或application.yml（application.yaml）文件

其中，application.properties文件是鍵值對類型的文件，之前一直在使用，所以此處不在對properties文件的格式進行闡述。除了properties文件外，SpringBoot還可以使用yml文件進行配置，下面對yml文件進行講解。

1.1.2 application.yml配置文件

1.1.2.1 yml配置文件簡介

YML文件格式是YAML (YAML Aint Markup Language)編寫的文件格式，YAML是一種直觀的能夠被電腦識別的的數據數據序列化格式，並且容易被人類閱讀，容易和腳本語言交互的，可以被支持YAML庫的不同的編程語言程序導入，比如： C/C++, Ruby, Python, Java, Perl, C#, PHP等。YML文件是以數據爲核心的，比傳統的xml方式更加簡潔。

YML文件的擴展名可以使用.yml或者.yaml。

1.1.2.2 yml配置文件的語法

1.1.2.2.1 配置普通數據

• 語法： key: value

• 示例代碼：

• name: haohao

• 注意：value之前有一個空格

1.1.2.2.2 配置對象數據

• 語法：

  ​ key:

  ​ key1: value1

  ​ key2: value2

  ​ 或者：

  ​ key: {key1: value1,key2: value2}

• 示例代碼：

• person:
    name: haohao
    age: 31
    addr: beijing
  
  #或者
  
  person: {name: haohao,age: 31,addr: beijing}

• 注意：key1前面的空格個數不限定，在yml語法中，相同縮進代表同一個級別

1.1.2.2.2 配置Map數據

同上面的對象寫法

1.1.2.2.3 配置數組（List、Set）數據

• 語法：

  ​ key:

  ​ - value1

  ​ - value2

  或者：

  ​ key: [value1,value2]

• 示例代碼：

• city:
    - beijing
    - tianjin
    - shanghai
    - chongqing
    
  #或者
  
  city: [beijing,tianjin,shanghai,chongqing]
  
  #集合中的元素是對象形式
  student:
    - name: zhangsan
      age: 18
      score: 100
    - name: lisi
      age: 28
      score: 88
    - name: wangwu
      age: 38
      score: 90

• 注意：value1與之間的 - 之間存在一個空格

1.1.3 SpringBoot配置信息的查詢

上面提及過，SpringBoot的配置文件，主要的目的就是對配置信息進行修改的，但在配置時的key從哪裏去查詢呢？我們可以查閱SpringBoot的官方文檔

文檔URL：https://docs.spring.io/spring-boot/docs/2.0.1.RELEASE/reference/htmlsingle/#common-application-properties

常用的配置摘抄如下：

# QUARTZ SCHEDULER (QuartzProperties)
spring.quartz.jdbc.initialize-schema=embedded # Database schema initialization mode.
spring.quartz.jdbc.schema=classpath:org/quartz/impl/jdbcjobstore/tables_@@platform@@.sql # Path to the SQL file to use to initialize the database schema.
spring.quartz.job-store-type=memory # Quartz job store type.
spring.quartz.properties.*= # Additional Quartz Scheduler properties.

# ----------------------------------------
# WEB PROPERTIES
# ----------------------------------------

# EMBEDDED SERVER CONFIGURATION (ServerProperties)
server.port=8080 # Server HTTP port.
server.servlet.context-path= # Context path of the application.
server.servlet.path=/ # Path of the main dispatcher servlet.

# HTTP encoding (HttpEncodingProperties)
spring.http.encoding.charset=UTF-8 # Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly.

# JACKSON (JacksonProperties)
spring.jackson.date-format= # Date format string or a fully-qualified date format class name. For instance, `yyyy-MM-dd HH:mm:ss`.

# SPRING MVC (WebMvcProperties)
spring.mvc.servlet.load-on-startup=-1 # Load on startup priority of the dispatcher servlet.
spring.mvc.static-path-pattern=/** # Path pattern used for static resources.
spring.mvc.view.prefix= # Spring MVC view prefix.
spring.mvc.view.suffix= # Spring MVC view suffix.

# DATASOURCE (DataSourceAutoConfiguration & DataSourceProperties)
spring.datasource.driver-class-name= # Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.
spring.datasource.password= # Login password of the database.
spring.datasource.url= # JDBC URL of the database.
spring.datasource.username= # Login username of the database.

# JEST (Elasticsearch HTTP client) (JestProperties)
spring.elasticsearch.jest.password= # Login password.
spring.elasticsearch.jest.proxy.host= # Proxy host the HTTP client should use.
spring.elasticsearch.jest.proxy.port= # Proxy port the HTTP client should use.
spring.elasticsearch.jest.read-timeout=3s # Read timeout.
spring.elasticsearch.jest.username= # Login username.

我們可以通過配置application.poperties 或者 application.yml 來修改SpringBoot的默認配置

例如：

application.properties文件

server.port=8888
server.servlet.context-path=demo

application.yml文件

server:
  port: 8888
  servlet:
    context-path: /demo

1.2 配置文件與配置類的屬性映射方式

1.2.1 使用註解@Value映射

我們可以通過@Value註解將配置文件中的值映射到一個Spring管理的Bean的字段上

例如：

application.properties配置如下：

person:
  name: zhangsan
  age: 18

或者，application.yml配置如下：

person:
  name: zhangsan
  age: 18

實體Bean代碼如下：

@Controller
public class QuickStartController {

    @Value("${person.name}")
    private String name;
    @Value("${person.age}")
    private Integer age;


    @RequestMapping("/quick")
    @ResponseBody
    public String quick(){
        return "springboot 訪問成功! name="+name+",age="+age;
    }

}

瀏覽器訪問地址：http://localhost:8080/quick 結果如下：

1.2.2 使用註解@ConfigurationProperties映射

通過註解@ConfigurationProperties(prefix=“配置文件中的key的前綴”)可以將配置文件中的配置自動與實體進行映射

application.properties配置如下：

person:
  name: zhangsan
  age: 18

或者，application.yml配置如下：

person:
  name: zhangsan
  age: 18

實體Bean代碼如下：

@Controller
@ConfigurationProperties(prefix = "person")
public class QuickStartController {

    private String name;
    private Integer age;

    @RequestMapping("/quick")
    @ResponseBody
    public String quick(){
        return "springboot 訪問成功! name="+name+",age="+age;
    }

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

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

瀏覽器訪問地址：http://localhost:8080/quick 結果如下：

注意：使用@ConfigurationProperties方式可以進行配置文件與實體字段的自動映射，但需要字段必須提供set方法纔可以，而使用@Value註解修飾的字段不需要提供set方法