2
授人以鱼不如授人以渔。大家好,我是Java课代表。今天跟大家分享一下SpringBoot基于profile的一些配置。
想要获取更多Java信息,请关注公众号:Java课代表

0 痛点

开发过程中,我们一般会有若干个不同的环境,如:开发环境,生产环境。一般情况下,不同环境下的程序配置是不同的。如果每次切换环境都去修改配置文件,一是比较麻烦,二是容易出错。

例如:开发阶段,我们可以采用嵌入式的H2数据库,但生产环境中使用mysql。

1 YAML文件

SpringBoot采用YAML(/ˈjæməl/)文件来管理配置,其优点是简洁明了,可读性好。

实现多配置有两种方式:

  1. 单个yml配置文件中编写不同配置
  2. 编写多个yml文件,代表不同的配置

单个yml文件

在一个yml文件中,通过 --- 分隔多个不同配置,根据spring.profiles.active 的值来决定启用哪个配置,例如:

#公共配置
spring:
  profiles:
    active: pro #使用名为pro的配置,这里可以切换成dev
  datasource:
    url: jdbc:mysql://localhost:3306/test_db?serverTimezone=UTC&useSSL=false&allowPublicKeyRetrieval=true
    password: 123456
    username: root
---
#开发环境配置
spring:
  profiles: dev #profiles属性代表配置的名称

server:
  port: 8080
---
#生产环境配置
spring:
  profiles: pro

server:
  port: 80

多个yml文件

将配置编写在多个yml文件中,根据spring.profiles.active 的值来决定启用哪个配置。

配置文件规则如下:

  1. 文件命名需要符合application-{profile}.yml的格式,如:application-dev.yml
  2. 相同配置写到application.yml中,不同的环境配置写到不同的yml文件中

例如:

application.yml

#公共配置
spring:
  profiles:
    active: pro #使用名为pro的配置,这里可以切换成dev
  datasource:
    url: jdbc:mysql://localhost:3306/test_db?serverTimezone=UTC&useSSL=false&allowPublicKeyRetrieval=true
    password: 123456
    username: root

application-dev.yml

server:
  port: 8080

application-pro.yml

server:
  port: 80

2 选择配置

有了YAML文件的配置,不同环境的不同配置终于不用改来改去了,但提交代码时还是要注意指定spring.profiles.active的值,否则还有提错配置的风险,有没有一劳永逸的办法呢?

我们在启动应用时通过环境变量的方式指定使用哪个配置,具体如下:

java -jar xxx.jar --spring.profiles.active=pro

通过这样的配置,我们就可以指定,在开发环境使用dev配置,在生产环境使用pro配置,从而一次解决提错配置文件的问题,而且还很优雅!

3 注意事项

  • 两种配置方式根据个人喜好使用,但如果配置很多,建议拆成多个yml文件,即方式二。便于维护
  • 注意区分二者的不同,不能混用

4 参考资料

  • Spring实战(第五版)
  • Spring官方文档

【推荐阅读】
RabbitMQ教程
Freemarker 教程(一)-模板开发手册
下载的附件名总乱码?你该去读一下 RFC 文档了!
深入浅出 MySQL 优先队列(你一定会踩到的order by limit 问题)


码字不易,欢迎点赞关注和分享。
搜索:【Java课代表】,关注公众号,每日一更,及时获取更多Java干货。


Java课代表
640 声望1k 粉丝

JavaWeb一线开发,5年编程经验