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

关于spring读取配置的顺序和读取配置的位置,开发中大多不关注,故此忽略,如有兴趣,请参看源文档。
源文档地址: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

这点告诉我们可以接受命令行参数作为属性,会覆盖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

不同环境应用不同的配置,通过 application-{profile}.properties,应该都很熟悉了。
目前大多数项目都使用配置中心实现这个功能,了解一下可以了。

5. Placeholders in Properties

就想下面这样,用占位符取属性。

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

6. Encrypting Properties

spring没有提供加密属性的方法,但是提供了 EnvironmentPostProcessor 接口,可以在启动完成前环境准备之后更改属性。这个接口显然不能通过bean的方式配置,需要通过SPI的方式加载。

7.Using YAML Instead of Properties

可以使用yaml作为配置文件,这个也司空见惯了,基本都是这样子用的。

8. Type-safe Configuration Properties

即通过@ConfigurationProperties 直接注入一组属性到配置类中,比起@Value注解,对于层次化的属性来说更为友好。无论做架构还是业务代码都很常用,重点了解。

  • @ConfigurationProperties并不会被spring扫描配置成bean,若想托管到spring,请使用-@Component或者@ConfigurationPropertiesScan
  • 使用构造器绑定@ConstructorBinding,可以创建不可变配置。
  • 可以配合@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
//传统 camel 
acme.myProject.person.firstName
acme.my_project.person.first_name
//推荐系统环境变量的写法
ACME_MYPROJECT_PERSON_FIRSTNAME

不同属性源的绑定规则:

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类型,重复定义的属性合并的规则。
    PS:开发时请尽量不要重复,具体想了解规则请查阅源文档。
  • Properties Conversion
    属性类型转化,可以基于Converters 注册,也有其他的解决方案。
    spring 支持以下这三种类型的属性转化:
    java.time.Duration 持续时间
    java.time.Period 周期
    org.springframework.util.unit.DataSize 数据大小
    具体想了解可以查阅源文档,用的不多。
  • @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开发人员才会获取meta data,基础框架建设者可以提供ide识别的json数据,普通程序员还是洗洗睡吧。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,734评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,931评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,133评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,532评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,585评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,462评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,262评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,153评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,587评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,792评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,919评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,635评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,237评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,855评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,983评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,048评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,864评论 2 354