Spring Boot 特性(二)外部化配置

關于spring讀取配置的順序和讀取配置的位置沿猜,開發(fā)中大多不關注枚荣,故此忽略,如有興趣啼肩,請參看源文檔橄妆。
源文檔地址:Externalized Configuration

1. Configuring Random Values

隨機配置,基于RandomValuePropertySource 祈坠,在配置文件里可以寫隨機值

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

2. Accessing Command Line Properties

這點告訴我們可以接受命令行參數(shù)作為屬性害碾,會覆蓋aplication配置里的屬性。
比如啟動命令加上 --server.port=9000

3. Application Property Files

Spring加載配置文件的位置赦拘,按順序從以下四個次序:

  • A /config subdirectory of the current directory
  • The current directory
  • A classpath /config package
  • The classpath root
    可以更改配置文件地址慌随,名稱,不過意義不大躺同。有興趣可以看源文檔阁猜。

4. Profile-specific Properties

不同環(huán)境應用不同的配置,通過 application-{profile}.properties蹋艺,應該都很熟悉了剃袍。
目前大多數(shù)項目都使用配置中心實現(xiàn)這個功能,了解一下可以了捎谨。

5. Placeholders in Properties

就想下面這樣民效,用占位符取屬性。

app.name=MyApp
app.description=${app.name} is a Spring Boot application

6. Encrypting Properties

spring沒有提供加密屬性的方法涛救,但是提供了 EnvironmentPostProcessor 接口研铆,可以在啟動完成前環(huán)境準備之后更改屬性。這個接口顯然不能通過bean的方式配置州叠,需要通過SPI的方式加載。

7.Using YAML Instead of Properties

可以使用yaml作為配置文件凶赁,這個也司空見慣了咧栗,基本都是這樣子用的。

8. Type-safe Configuration Properties

即通過@ConfigurationProperties 直接注入一組屬性到配置類中虱肄,比起@Value注解致板,對于層次化的屬性來說更為友好。無論做架構還是業(yè)務代碼都很常用咏窿,重點了解斟或。

  • @ConfigurationProperties并不會被spring掃描配置成bean,若想托管到spring集嵌,請使用-@Component或者@ConfigurationPropertiesScan
  • 使用構造器綁定@ConstructorBinding萝挤,可以創(chuàng)建不可變配置御毅。
  • 可以配合@EnableConfigurationProperties,把配置屬性與配置類@Configuration綁定怜珍。
  • 以下是配置類和對應配置文件的綁定
@ConfigurationProperties("acme")
@Component
public class AcmeProperties {
    @Getter
    @Setter
    private boolean enabled;
    @Getter
    @Setter
    private InetAddress remoteAddress;
    @Getter
    private final Security security = new Security();

    @Getter
    @Setter
    public static class Security {
        private String username;
        private String password;
        private List<String> roles = new ArrayList<>(Collections.singleton("USER"));

    }
}
# application.yml

acme:
    enabled:true
    remote-address: 192.168.1.1
    security:
        username: admin
        roles:
          - USER
          - ADMIN

# additional configuration as required
  • Third-party Configuration
    可以使用@Bean注解在配置bean的時候給三方類注入屬性
@ConfigurationProperties(prefix = "another")
@Bean
public AnotherComponent anotherComponent() {
  ...
}
  • Relaxed Binding 寬松綁定
@ConfigurationProperties(prefix="acme.my-project.person")
public class OwnerProperties {
    private String firstName;
}

屬性綁定并不十分嚴格端蛆,支持各種風格的寫法。
對于上面這個類酥泛,一下四種都可以注入 firstName今豆。

//推薦 .properties .yml
acme.my-project.person.first-name
//傳統(tǒng) camel 
acme.myProject.person.firstName
acme.my_project.person.first_name
//推薦系統(tǒng)環(huán)境變量的寫法
ACME_MYPROJECT_PERSON_FIRSTNAME

不同屬性源的綁定規(guī)則:

Property Source Simple List
Properties Files a_b 或者 a-b 或者 aB a.b[1]或者,
YAML Files a_b 或者 a-b 或者 aB -或者,
Environment Variables A_B A_B_1
System properties a_b 或者 a-b 或者 aB a.b[1]或者柔袁,

Map綁定:使用[]才會保留所有字符呆躲,否則會去掉特殊字符

acme:
  map:
    "[/key1]": value1  => /key1
    "[/key2]": value2  => /key2
    /key3: value3      => key3 
  • Merging Complex Types
    對于List,Map類型捶索,重復定義的屬性合并的規(guī)則插掂。
    PS:開發(fā)時請盡量不要重復,具體想了解規(guī)則請查閱源文檔情组。
  • Properties Conversion
    屬性類型轉化燥筷,可以基于Converters 注冊,也有其他的解決方案院崇。
    spring 支持以下這三種類型的屬性轉化:
    java.time.Duration 持續(xù)時間
    java.time.Period 周期
    org.springframework.util.unit.DataSize 數(shù)據(jù)大小
    具體想了解可以查閱源文檔肆氓,用的不多。
  • @ConfigurationProperties Validation
    屬性配置校驗,直接使用@Validated底瓣,例子如下谢揪。用的很多了,不在贅述捐凭。
@ConfigurationProperties(prefix="acme")
@Validated
public class AcmeProperties {
    @NotNull
    private InetAddress remoteAddress;
    @Valid
    private final Security security = new Security();
    // ... getters and setters
    public static class Security {
        @NotEmpty
        public String username;
        // ... getters and setters
    }

}
  • @ConfigurationProperties vs. @Value
    兩種屬性配置的對比:
Feature @ConfigurationProperties @Value
Relaxed binding Yes Limited (see note below)
Meta-data support Yes No
SpEL evaluation No Yes

ps:關于 Meta-data,原文介紹如下:

Spring Boot jars include metadata files that provide details of all supported configuration properties. The files are designed to let IDE developers offer contextual help and “code completion” as users are working with application.properties or application.yml files.
只有ide開發(fā)人員才會獲取meta data拨扶,基礎框架建設者可以提供ide識別的json數(shù)據(jù),普通程序員還是洗洗睡吧茁肠。

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末患民,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子垦梆,更是在濱河造成了極大的恐慌匹颤,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,252評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件托猩,死亡現(xiàn)場離奇詭異印蓖,居然都是意外死亡,警方通過查閱死者的電腦和手機京腥,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評論 3 399
  • 文/潘曉璐 我一進店門赦肃,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事他宛〈啵” “怎么了?”我有些...
    開封第一講書人閱讀 168,814評論 0 361
  • 文/不壞的土叔 我叫張陵堕汞,是天一觀的道長勺爱。 經(jīng)常有香客問我,道長讯检,這世上最難降的妖魔是什么琐鲁? 我笑而不...
    開封第一講書人閱讀 59,869評論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮人灼,結果婚禮上围段,老公的妹妹穿的比我還像新娘。我一直安慰自己投放,他們只是感情好奈泪,可當我...
    茶點故事閱讀 68,888評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著灸芳,像睡著了一般涝桅。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上烙样,一...
    開封第一講書人閱讀 52,475評論 1 312
  • 那天冯遂,我揣著相機與錄音,去河邊找鬼谒获。 笑死蛤肌,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的批狱。 我是一名探鬼主播裸准,決...
    沈念sama閱讀 41,010評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼赔硫!你這毒婦竟也來了炒俱?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,924評論 0 277
  • 序言:老撾萬榮一對情侶失蹤爪膊,失蹤者是張志新(化名)和其女友劉穎向胡,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體惊完,經(jīng)...
    沈念sama閱讀 46,469評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,552評論 3 342
  • 正文 我和宋清朗相戀三年处硬,在試婚紗的時候發(fā)現(xiàn)自己被綠了小槐。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,680評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖凿跳,靈堂內(nèi)的尸體忽然破棺而出件豌,到底是詐尸還是另有隱情,我是刑警寧澤控嗜,帶...
    沈念sama閱讀 36,362評論 5 351
  • 正文 年R本政府宣布茧彤,位于F島的核電站,受9級特大地震影響疆栏,放射性物質發(fā)生泄漏曾掂。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 42,037評論 3 335
  • 文/蒙蒙 一壁顶、第九天 我趴在偏房一處隱蔽的房頂上張望珠洗。 院中可真熱鬧,春花似錦若专、人聲如沸许蓖。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽膊爪。三九已至,卻和暖如春嚎莉,著一層夾襖步出監(jiān)牢的瞬間米酬,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評論 1 274
  • 我被黑心中介騙來泰國打工萝喘, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留淮逻,地道東北人。 一個月前我還...
    沈念sama閱讀 49,099評論 3 378
  • 正文 我出身青樓阁簸,卻偏偏與公主長得像爬早,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子启妹,可洞房花燭夜當晚...
    茶點故事閱讀 45,691評論 2 361