歡迎光臨
每天分享高質量文章

SpringBoot | 第三章:springboot 配置詳解

(點擊上方公眾號,可快速關註)


來源:oKong ,

blog.lqdev.cn/2018/07/14/springboot/chapter-third/

基於springboot的約定優於配置的原則,在多數情況下,啟動一個應用時,基本上無需做太多的配置,應用就能正常啟動。但在大部分開發環境下,添加額外配置是無所避免的,比如自定義應用端口號(比較在機器比較少的情況下,一臺機器還是需要部署多個應用的,當然利用docker的話,是可避免的,這是後話了)、mq的服務地址、快取服務的服務地址、資料庫的配置等,都或多或少的需要一些外部的配置項。

配置檔案格式簡要說明

springboot預設的全域性配置檔案名為application.properties或者application.yml(spring官方推薦使用的格式是.yml格式,目前官網都是實體都是使用yml格式進行配置講解的),應用啟動時會自動加載此檔案,無需手動引入。除此之外還有一個bootstrap的全域性檔案,它的加載順序在application配置檔案之前,主要是用於在應用程式背景關係的引導階段,在後期講解springCloudCofnig時,主要是利用此特性,進行配置檔案的動態修改,在此不表,在通常情況下,此兩個配置檔案是沒有差別的,所以一般上都只需要配置application即可。

自定義屬性值

application.properties配置檔案支持自定義屬性的支持,比如

blog.address=https://blog.lqdev.cn

blog.author=oKong

然後可通過@Value(“${blog.author}”)的形式獲取屬性值。

@RestController

public class DemoController {

 

    @Value(“${blog.address}”)

    String address;

 

    @Value(“${blog.author}”)

    String author;

 

    @Value(“${blog.desc}”)    

    String desc;

 

    @RequestMapping(“/”)

    public String demo() {

        return desc;

    }

}

這裡提醒下,在填寫一些預設的比如,資料庫屬性時,可使用alt+/的方式,IDE會自動顯示提示,避免了手動嵌入屬性值或者忘記屬性的尷尬。

關於自定義屬性時,特別是一些公用包,會使用到屬性值時,建議在創建additional-spring-configuration-metadata.json屬性元檔案,這樣在使用上述快捷方式時,會進行提示,包括屬性名和屬性說明,這樣也方便呼叫者詢問屬性名是啥。

相關configuration-metadata說明可查看:https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html

屬性取用

在配置檔案中,各個屬性引數可進行取用的,比如:

blog.address=https://blog.lqdev.cn

blog.author=oKong

blog.desc=${blog.author},${blog.address}

最後blog.desc的值即可:oKong,https://blog.lqdev.cn。利用此特性,並可實現一些特殊的功能。比如後期講解spring cloud時,註冊eurka註冊中心的實體名時,並會使用類似如下配置,使得實體名一眼就知道哪台服務地址:

eureka.instance.instance-id=${spring.cloud.client.ipAddress}:${server.port}

這裡需要註意,由於springboot在讀取properties檔案時,使用的是PropertiesPropertySourceLoader類進行讀取,預設讀取的編碼是ISO 8859-1,故在預設的配置檔案中使用中文時,會出現亂碼,此時可以將中文轉成Unicode編碼或者使用yml配置格式(預設就支持utf-8),再不濟可以將作為配置寫入到一個自定義配置檔案,利用@PropertySource註解的encoding屬性指定編碼

隨機數

Spring Boot的屬性配置檔案中可以通過${random}來產生int值、long值或者string字串,來支持屬性的隨機值。

# 隨機字串

.blog.value=${random.value}

# 隨機int

.blog.number=${random.int}

# 隨機long

.blog.bignumber=${random.long}

# 10以內的隨機數

.blog.test1=${random.int(10)}

# 1-20的隨機數

.blog.test2=${random.int[1,20]}

自定義配置檔案

在多數情況下,配置信息基本上都是放入application.properties檔案中,但在一些場景下,比如某個配置項比較多時,為了分開存放,也可自定義配置檔案,如my.properties。由於自定義的檔案,系統不會自動加載,這個時候就需要手動引入了。 利用@PropertySource註解既可以引入配置檔案,需要引入多個時,可使用@PropertySources設置陣列,引入多個檔案。

@SpringBootApplication

@PropertySource(value=”classpath:my.properties”,encoding=”utf-8″)

public class Chapter3Application {

 

    public static void main(String[] args) {

        SpringApplication.run(Chapter3Application.class, args);

    }

}

配置系結物件

雖然使用@Value()方式,能方便的引入自定義的屬性值,但在多某個配置項屬於某一配置時,希望對應到一個物體配置類中,springboot也提供了支持。利用@ConfigurationProperties屬性,即可完成 my.properties配置檔案:

config.code=code

config.name=趔趄的猿

config.hobby[0]=看電影

config.hobby[1]=旅游

物體類:

@Component

//@EnableConfigurationProperties(value= {Config.class})

@ConfigurationProperties(prefix=”config”)

@Data

public class Config {

 

    String code;

 

    String name;

 

    List hobby;

}

這裡可直接加入@Component使其在啟動時被自動掃描到,或者使用@EnableConfigurationProperties註解註冊此物體bean. 其次,在引入@ConfigurationProperties時,IDE會提示你引入spring-boot-configuration-processor依賴,前面提到,在自定義屬性時,創建additional-spring-configuration-metadata.json可進行屬性提示,而此依賴功能類似,會編譯時自動生成spring-configuration-metadata.json檔案,此檔案主要給IDE使用,用於提示使用。添加後在配置檔案點擊屬性時,會自動跳轉到對應系結的物體類中

陣列形式

配置了以下配置,然後利用List就能獲取hobby的值了。

config.code=code

config.name=趔趄的猿

config.hobby[0]=看電影

config.hobby[1]=旅游

【關於投稿】


如果大家有原創好文投稿,請直接給公號發送留言。


① 留言格式:
【投稿】+《 文章標題》+ 文章鏈接

② 示例:
【投稿】《不要自稱是程式員,我十多年的 IT 職場總結》:http://blog.jobbole.com/94148/

③ 最後請附上您的個人簡介哈~



系列


看完本文有收穫?請轉發分享給更多人

關註「ImportNew」,提升Java技能

赞(0)

分享創造快樂