11.類(lèi)型安全的配置屬性

  • 使用@Value("${property}")注解注入配置屬性有時(shí)可能比較笨重扎狱,特別是需要使用多個(gè)properties或你的數(shù)據(jù)本身有層次結(jié)構(gòu)。為了控制和校驗(yàn)?zāi)愕膽?yīng)用配置匠抗,Spring Boot提供一個(gè)允許強(qiáng)類(lèi)型beans的替代方法來(lái)使用properties汞贸。

示例:

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
    private String username;
    private InetAddress remoteAddress;
// ... getters and setters
}
  • 當(dāng)@EnableConfigurationProperties注解應(yīng)用到你的@Configuration時(shí)印机,任何被@ConfigurationProperties注解的beans將自動(dòng)被Environment屬性配置。這種風(fēng)格的配置特別適合與SpringApplication的外部YAML配置進(jìn)行配合使用多柑。

    # application.yml
      connection:
        username: admin
        remoteAddress: 192.168.1.1
    # additional configuration as required
    
  • 為了使用@ConfigurationProperties beans竣灌,你可以使用與其他任何bean相同的方式注入它們。

      @Service
      public class MyService {
      @Autowired
      private ConnectionSettings connection;
      //...
      @PostConstruct
      public void openConnection() {
          Server server = new Server();
          this.connection.configure(server);
      }
      }
    
  • 你可以通過(guò)在@EnableConfigurationProperties注解中直接簡(jiǎn)單的列出屬性類(lèi)來(lái)快捷的注冊(cè)@ConfigurationProperties bean的定義初嘹。

    @Configuration
    @EnableConfigurationProperties(ConnectionSettings.class)
    public class MyConfiguration {
    }
    

注:使用@ConfigurationProperties能夠產(chǎn)生可被IDEs使用的元數(shù)據(jù)文件。

第三方配置
  • 正如使用@ConfigurationProperties注解一個(gè)類(lèi)豁生,你也可以在@Bean方法上使用它漫贞。當(dāng)你需要綁定屬性到不受你控制的第三方組件時(shí)迅脐,這種方式非常有用豪嗽。

  • 為了從Environment屬性配置一個(gè)bean,將@ConfigurationProperties添加到它的bean注冊(cè)過(guò)程:

     @ConfigurationProperties(prefix = "foo")
     @Bean
     public FooComponent fooComponent() {
     ...
     }
    
  • 和上面ConnectionSettings的示例方式相同隐锭,任何以foo為前綴的屬性定義都會(huì)被映射到FooComponent上计贰。

松散的綁定(Relaxed binding)
  • Spring Boot使用一些寬松的規(guī)則用于綁定Environment屬性@ConfigurationProperties beans,所以Environment屬性名和bean屬性名不需要精確匹配荞怒。常見(jiàn)的示例中有用的包括虛線分割(比如褐桌,context--path綁定到contextPath)和將環(huán)境屬性轉(zhuǎn)為大寫(xiě)字母(比如象迎,PORT綁定port)。
    示例:

    @Component
    @ConfigurationProperties(prefix="person")
    public class ConnectionSettings {
    private String firstName;
    }
    

下面的屬性名都能用于上面的@ConfigurationProperties類(lèi):

屬性 說(shuō)明
person.firstName 標(biāo)準(zhǔn)駝峰規(guī)則
person.first-name 虛線表示啦撮,推薦用于.properties和.yml文件中
PERSON_FIRST_NAME 大寫(xiě)形式拇舀,使用系統(tǒng)環(huán)境變量時(shí)推薦
@ConfigurationProperties校驗(yàn)
  • Spring Boot將嘗試校驗(yàn)外部的配置,默認(rèn)使用JSR-303(如果在classpath路徑中)聘鳞。你可以輕松的為你的@ConfigurationProperties類(lèi)添加JSR-303 javax.validation約束注解:

    @Component
    @ConfigurationProperties(prefix="connection")
    public class ConnectionSettings {
    @NotNull
    private InetAddress remoteAddress;
    // ... getters and setters
    }
    
  • 你也可以通過(guò)創(chuàng)建一個(gè)叫做configurationPropertiesValidator的bean來(lái)添加自定義的Spring Validator。

注:spring-boot-actuator模塊包含一個(gè)暴露所有@ConfigurationProperties beans的端點(diǎn)站楚。簡(jiǎn)單地將你的web瀏覽器指向/configprops或使用等效的JMX端點(diǎn)搏嗡。具體參考Production ready features。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末旧乞,一起剝皮案震驚了整個(gè)濱河市尺栖,隨后出現(xiàn)的幾起案子烦租,更是在濱河造成了極大的恐慌,老刑警劉巖挫以,帶你破解...
    沈念sama閱讀 216,919評(píng)論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件掐松,死亡現(xiàn)場(chǎng)離奇詭異锌杀,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)量没,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,567評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)殴蹄,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人袭灯,你說(shuō)我怎么就攤上這事绑嘹。” “怎么了姨丈?”我有些...
    開(kāi)封第一講書(shū)人閱讀 163,316評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)翁潘。 經(jīng)常有香客問(wèn)我歼争,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,294評(píng)論 1 292
  • 正文 為了忘掉前任豹绪,我火速辦了婚禮申眼,結(jié)果婚禮上括尸,老公的妹妹穿的比我還像新娘病毡。我一直安慰自己,他們只是感情好啦膜,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,318評(píng)論 6 390
  • 文/花漫 我一把揭開(kāi)白布僧家。 她就那樣靜靜地躺著,像睡著了一般阵赠。 火紅的嫁衣襯著肌膚如雪肌稻。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,245評(píng)論 1 299
  • 那天枷邪,我揣著相機(jī)與錄音诺凡,去河邊找鬼药薯。 笑死童本,一個(gè)胖子當(dāng)著我的面吹牛脸候,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播泵额,決...
    沈念sama閱讀 40,120評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼携添,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了羞秤?” 一聲冷哼從身側(cè)響起左敌,我...
    開(kāi)封第一講書(shū)人閱讀 38,964評(píng)論 0 275
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤矫限,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后叼风,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,376評(píng)論 1 313
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡茵汰,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,592評(píng)論 2 333
  • 正文 我和宋清朗相戀三年经窖,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了画侣。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,764評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡配乱,死狀恐怖搬泥,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情忿檩,我是刑警寧澤,帶...
    沈念sama閱讀 35,460評(píng)論 5 344
  • 正文 年R本政府宣布沙咏,位于F島的核電站肢藐,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏吆豹。R本人自食惡果不足惜理盆,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,070評(píng)論 3 327
  • 文/蒙蒙 一熏挎、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧坎拐,春花似錦哼勇、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,697評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)湿刽。三九已至,卻和暖如春诈闺,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,846評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工刃滓, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留耸弄,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,819評(píng)論 2 370
  • 正文 我出身青樓砰诵,卻偏偏與公主長(zhǎng)得像震叮,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子苇瓣,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,665評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容