在Spring Boot 2.0中推出了Relaxed Binding 2.0,对原有的属性绑定功能做了非常多的改进以帮助我们更容易的在Spring应用中加载和读取配置信息。下面本文就来说说Spring Boot 2.0中对配置的改进。
在Spring Boot 2.0中对配置属性加载的时候会除了像1.x版本时候那样移除特殊字符外,还会将配置均以全小写的方式进行匹配和加载。所以,下面的4种配置方式都是等价的:
properties格式:
yaml格式:
Tips:推荐使用全小写配合<code>-</code>分隔符的方式来配置,比如:<code>spring.jpa.database-platform=mysql</code>
在properties文件中使用<code>[]</code>来定位列表类型,比如:
也支持使用逗号分割的配置方式,上面与下面的配置是等价的:
而在yaml文件中使用可以使用如下配置:
也支持逗号分割的方式:
注意:在Spring Boot 2.0中对于List类型的配置必须是连续的,不然会抛出<code>UnboundConfigurationPropertiesException</code>异常,所以如下配置是不允许的:
在Spring Boot 1.x中上述配置是可以的,<code>foo[1]</code>由于没有配置,它的值会是<code>null</code>
Map类型在properties和yaml中的标准配置方式如下:
注意:如果Map类型的key包含非字母数字和<code>-</code>的字符,需要用<code>[]</code>括起来,比如:
简单类型
在环境变量中通过小写转换与<code>.</code>替换<code>_</code>来映射配置文件中的内容,比如:环境变量<code>SPRING_JPA_DATABASEPLATFORM=mysql</code>的配置会产生与在配置文件中设置<code>spring.jpa.databaseplatform=mysql</code>一样的效果。
List类型
由于环境变量中无法使用<code>[</code>和<code>]</code>符号,所以使用<code>_</code>来替代。任何由下划线包围的数字都会被认为是<code>[]</code>的数组形式。比如:
另外,最后环境变量最后是以数字和下划线结尾的话,最后的下划线可以省略,比如上面例子中的第一条和第三条等价于下面的配置:
系统属性与文件配置中的类似,都以移除特殊字符并转化小写后实现绑定,比如下面的命令行参数都会实现配置<code>spring.jpa.databaseplatform=mysql</code>的效果:
系统属性的绑定也与文件属性的绑定类似,通过<code>[]</code>来标示,比如:
同样的,他也支持逗号分割的方式,比如:
上文介绍了Spring Boot 2.0中对属性绑定的内容,可以看到对于一个属性我们可以有多种不同的表达,但是如果我们要在Spring应用程序的environment中读取属性的时候,每个属性的唯一名称符合如下规则:
通过<code>.</code>分离各个元素
最后一个<code>.</code>将前缀与属性名称分开
必须是字母(a-z)和数字(0-9)
必须是小写字母
用连字符<code>-</code>来分隔单词
唯一允许的其他字符是<code>[</code>和<code>]</code>,用于List的索引
不能以数字开头
所以,如果我们要读取配置文件中<code>spring.jpa.database-platform</code>的配置,可以这样写:
而下面的方式是无法获取到<code>spring.jpa.database-platform</code>配置内容的:
注意:使用<code>@Value</code>获取配置内容的时候也需要这样的特点
在Spring Boot 2.0中增加了新的绑定API来帮助我们更容易的获取配置信息。下面举个例子来帮助大家更容易的理解:
例子一:简单类型
假设在propertes配置中有这样一个配置:<code>com.didispace.foo=bar</code>
我们为它创建对应的配置类:
接下来,通过最新的<code>Binder</code>就可以这样来拿配置信息了:
例子二:List类型
如果配置内容是List类型呢?比如:
要获取这些配置依然很简单,可以这样实现:
本文的相关例子可以查看下面仓库中的<code>Chapter2-2-1</code>目录:
<a href="https://github.com/dyc87112/SpringBoot-Learning">Github:https://github.com/dyc87112/SpringBoot-Learning</a>
<a href="https://gitee.com/didispace/SpringBoot-Learning">Gitee:https://gitee.com/didispace/SpringBoot-Learning</a>