SpringBoot系列——利用系统环境变量与配置文件的分支选择实现“智能部署”

Posted 2021-02-10 huanzi-qch

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot系列——利用系统环境变量与配置文件的分支选择实现“智能部署”相关的知识，希望对你有一定的参考价值。

　　前言

　　通过之前的博客：SpringBoot系列——jar包与war包的部署，我们已经知道了如果实现项目的简单部署，但项目部署的时候最烦的是什么？修改成发布环境对应的配置！数据库连接地址、Eureka注册中心地址、Redis服务地址等，部署环境不一样，打包的时候就要改成对应的配置；常用的环境有本地开发环境dev，本地测试环境dev-test，生产测试环境prod-test，生产环境prod；

　　开发的时候我们用dev，项目直接运行，不用改配置；发布本地测试环境的时候，打包之前我们要先改成对应配置；上线前发布生产测试环境的时候要改成对应配置；正式上线发布生产环境的时候要改成对应配置；每次这样改很麻烦，要是不小心漏改了部分地方，还会造成报错，当换一个人来部署时，还得先告诉他需要修改的地方，麻烦；

　　那么有什么好办法能解决这个问题呢？我就是不想每次在打包之前改配置，我就直接打包、发布。下面记录一下利用系统环境变量与.yml配置文件的活跃分支实现“智能部署”；

　　想了解springboot的配置优先级可以参考这篇大佬的博客：Spring Boot 配置优先级顺序，我这里简单总结一下：

命令行参数。
通过 System.getProperties() 获取的 Java 系统参数。
操作系统环境变量。
从 java:comp/env 得到的 JNDI 属性。
通过 RandomValuePropertySource 生成的“random.*”属性。
应用 Jar 文件之外的属性文件。(通过spring.config.location参数)
应用 Jar 文件内部的属性文件。
在应用配置 Java 类（包含“@Configuration”注解的 Java 类）中通过“@PropertySource”注解声明的属性文件。
通过“SpringApplication.setDefaultProperties”声明的默认属性。

　　代码编写

　　配置选择分支

　　首先我们利用bootstrap.yml先于application.yml加载的顺序，在bootstrap.yml进行分支选择

spring:
  config:
    name: application #配置文件名
  profiles:
    active: ${HUANZI_PROFILES:dev} #选择配置分支，先读取系统环境变量，如果没有则默认值为 dev

　　在application.yml里进行写各个分支的配置，分支之间用注释 ---- 隔开

　　请看官网截图介绍：你可以在一个yml里面指定多个具体的profile配置，通过配置spring.profiles，判断使用哪个配置

##### 公共 配置 #######
server:
  port: 10086 #端口号
  servlet:
    context-path: / #访问根路径

spring:
  application:
    name: springdatejpa #应用名

---

##### dev 配置 #######
spring:
  profiles: dev

  datasource: #连接数据库
    url: jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8&characterEncoding=utf-8
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver
msg: 正在使用 dev 配置
---
##### dev-test 配置 #######
spring:
  profiles: dev-test

  datasource: #连接数据库（暂时也先用同一个库，否则项目报错起不来）
    url: jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8&characterEncoding=utf-8
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver
msg: 正在使用 dev-test 配置
---
##### prod-test 配置 #######
spring:
  profiles: prod-test

msg: 正在使用 prod-test 配置
---
##### prod 配置 #######
spring:
  profiles: prod

msg: 正在使用 prod 配置
---

　　当然也可以用后缀.properties的配置文件，来进行根据活跃的profiles分支选择

　　创建application-dev.properties，application-dev-test.properties...文件，将具体配置放在具体文件里，同样与yml效果一致

　　PS：默认情况下yml没有中文乱码问题，而properties有

　　另外，官网给出了一个yml的缺点，就是不能使用@PropertySource注释加载yml文件

　　更多yml介绍请看官网：24.7 Using YAML Instead of Properties https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-external-config-yaml

　　更多配置文件介绍请看官网：24. Externalized Configuration https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-external-config

　　　　　　　　　　　　　　　25. Profiles https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-profiles

　　配置环境变量

　　Windows配置系统环境变量，例如：dev-test

　　Linux配置系统环境变量，请看这篇文章：Linux环境变量总结，总结下代码、步骤：

　　1、vim ~/.bash_profile

　　2、export HUANZI_PROFILES=dev-test ，esc :wq保存退出

　　3、source ~/.bash_profile

　　4、查看环境变量 echo $HUANZI_PROFILES ，如果输出dev-test设置成功

　　效果

　　添加一个checkProfiles测试接口，方便检查分支使用情况：

    @Value("${msg}")
    private String msg;

    /**
     * 检查配置分支
     */
    @RequestMapping("checkProfiles")
    public String checkProfiles() {
        return msg;
    }

　　没有设置系统环境变量：默认使用dev