SpringBoot2.x基础篇:灵活的使用外部化配置信息

知识改变命运,撸码使我快乐,2020继续游走在开源界

点赞再看,养成习惯

给我来个Star吧,点击了解下基于SpringBoot的组件化接口服务落地解决方案

SpringBoot提供了内部配置application.yml文件的方式来进行全局配置,还支持使用profiles来激活不同环境下使用不同的配置文件,而这种方式毕竟是已经打包完成了,因此存在一定的局限性,像数据库特殊敏感配置也可能存在泄露的风险,如何解决这种问题呢?我们来看看本章要讲到的外部配置的方式吧!!!

推荐阅读

前言

SpringBoot提供了多种的外部化配置方式,主要是为了方便在不同的环境中运行相同的代码。

我们可以通过Properties文件YAML文件环境变量命令行参数等来配置,获取配置的值时可以通过@Value注解进行注入,也可以使用@ConfigurationProperties注解进行层级结构化绑定到实体类的字段中。

加载顺序

SpringBoot配置参数存在一定的顺序,当然对相同名称的属性配置,会因为加载的优先级存在覆盖,顺序如下所示:

  1. DevTools全局设置属性
  2. @TestPropertySource注解
  3. properties测试中的属性
  4. 命令行参数
  5. SPRING_APPLICATION_JSON属性配置(嵌入在环境变量或者系统属性中的嵌入式JSON字符串)
  6. ServletConfig初始化参数
  7. ServletContext初始化参数
  8. JNDI属性java:comp/env
  9. Java系统属性
  10. 操作系统环境变量
  11. 打包在jar内的配置文件(application.propertiesYAML文件)
  12. @PropertySource注解
  13. 默认属性(通过SpringApplication.setDefaultProperties设置)

配置示例

我们从上面挑选几种来进行测试下配置输出,首先创建一个名为LoadConfig的配置类,内容如下所示:

/**
 * 加载配置类
 *
 * @author 恒宇少年
 */
@Configuration
public class LoadConfig {
    /**
     * 配置读取name属性,不存在时使用空字符为默认值
     */
    @Value("${name:''}")
    private String name;

    public String getName() {
        return name;
    }
}

LoadConfig配置类中,我们添加了一个name字段,由于该字段使用了@Value注解,所以它的值会从配置环境中加载名为name的属性值(配置的方式并没有限制)。

为了方便演示,我们在应用程序启动时通过实现CommandLineRunner接口在启动成功后输出name的值,SpringBootApplication入口类代码如下所示:

/**
 * 启动类入口
 */
@SpringBootApplication
public class SpringBootBasicExternalizedConfigurationApplication implements CommandLineRunner {
    /**
     * 注入配置类{@link LoadConfig}
     */
    @Autowired
    private LoadConfig loadConfig;

    public static void main(String[] args) {
        SpringApplication.run(SpringBootBasicExternalizedConfigurationApplication.class, args);
    }


    @Override
    public void run(String... args) throws Exception {
        System.out.println("name config value:" + loadConfig.getName());
    }
}

YAML文件配置

这种我们在开发应用程序中最常用的方式,只需要在src/main/resources目录下创建一个名为application.yml的配置文件,然后在该文件内添加对应属性名称的配置,如下所示:

# 配置name属性
name:
  default

我们如果直接启动应用程序,会在控制台输出name的值为default

注意事项:application.ymlapplication.properties作用、优先级相同,只是配置的展现形式不一样而已,我个人更喜欢YAML文件的形式,层级分明,阅读性高一些。

命令行环境变量配置

在执行java -jar启动应用程序时,可以通过添加SPRING_APPLICATION_JSON配置来进行自定义属性配置,该配置是一个JSON字符串的形式,使用方式如下所示:

SPRING_APPLICATION_JSON='{"name":"system_env"}' java -jar spring-boot-basic-externalized-configuration-0.0.1-SNAPSHOT.jar

运行结果:这种方式启用应用程序时,会在控制台输出name的值为system_env

命令行参数配置

命令行参数这种方式也比较常用,通过--进行配置,比较常见的命令--spring.profiles.active,启动时用于修改激活的profile,而我们如果想要修改name属性配置的值,如下所示:

java -jar spring-boot-basic-externalized-configuration-0.0.1-SNAPSHOT.jar --name=hengboy

或者使用--spring.application.json方式也可以配置,如下所示:

java -jar spring-boot-basic-externalized-configuration-0.0.1-SNAPSHOT.jar --spring.application.json='{"name":"hengboy"}'

运行结果:以上两种方式都可以,控制台都会输出name的值为hengboy

Java系统属性配置

Java系统属性的方式进行配置时,不仅使用@Value可以获取到属性值,使用java.lang.System#getProperty(java.lang.String)方法也是可以获取到的,通过-D进行配置,如下所示:

java -Dname=JavaSystemConfig -jar spring-boot-basic-externalized-configuration-0.0.1-SNAPSHOT.jar

或者使用-Dspring.application.json方式配置(这种方式使用System.getProperty方法无法获取到属性值),如下所示:

java -Dspring.application.json='{"name":"JavaSystemConfig"}' -jar spring-boot-basic-externalized-configuration-0.0.1-SNAPSHOT.jar

运行结果:以上两种方式启动应用程序,控制台会输出name的值为JavaSystemConfig

注意事项:Java属性配置必须在-jar xxx.jar之前,配置在后面无法读取到属性值。

总结

多样化的配置属性的方式,使SpringBoot变的是那么的灵活,如果有兴趣可以把上面全部的配置方式都尝试一遍,你会有意想不到的收获的。

代码示例

如果您喜欢本篇文章请为源码仓库点个Star,谢谢!!!
本篇文章示例源码可以通过以下途径获取,源码分支为2.x,目录为spring-boot-basic-externalized-configuration

作者个人 博客
使用开源框架 ApiBoot 助你成为Api接口服务架构师

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

推荐阅读更多精彩内容