【运维篇】二、配置文件与多环境控制

墨蓝 2023-10-16 08:47 39阅读 0赞

#### 文章目录 ####

*  1、临时属性
 *  2、IDEA中的临时属性
 *  3、配置文件4级分类
 *  4、关于四级分类的思考
 *  5、自定义配置文件
 *  6、多环境开发（yaml版）
 *  7、配置文件按环境分类
 *  8、include与group再细粒度
 *  9、一点思考
 *  10、多环境开发兼容问题

![请添加图片描述][85ecfb6cd25140b1888668448d2ee9f3.gif]

## 1、临时属性 ##

jar包或者镜像已经打完了，想修改下服务的配置，如何实现？ ⇒ 临时属性

![在这里插入图片描述][7c352061d5504ecab3060b35fe68cf23.png]

如修改服务的端口：

java –jar springboot.jar --server.port=80

携带多个属性启动SpringBoot，属性间使`用空格分隔`：

java –jar springboot.jar --server.port=80  --spring.datasource.druid.password = admin123

以上能生效的原因，是因为命令行的参数优先级高于配置文件，配置文件中的配置被覆盖，关于优先级，可查看[这里][Link 1]：

![在这里插入图片描述][1b470923d9eb49e3a6c88c4d0b2a668a.png]  
**总结即：**

*  `临时属性添加方式：java –jar 工程名.jar –-属性名=值`
 *  临时属性必须是当前boot工程中有的属性，否则`设置无效（不会报错）`

## 2、IDEA中的临时属性 ##

![在这里插入图片描述][aed68edfdd7041e99f3f075b7c6a8d27.png]

而在IDEA中，想加临时属性可以编辑配置，修改Environment.Program.arguments

![在这里插入图片描述][9c9d8095928740df999dbf16b7b1117c.png]

上面的这个参数，会被读取到程序启动的main方法参数args中：

![在这里插入图片描述][30f84a4f486d4dc09743a5a817551ecf.png]

因此，也可以在这里以代码的形式加入相关参数。

public static void main(String[] args) {
        
    
    	String[] arg = new String[1];
    	arg[0] = "--server.port=8080";
    	SpringApplication.run(SSMPApplication.class, arg);	
    	
    }

但为了安全性，一般在启动boot程序时断开读取外部临时配置对应的入口，也就是run方法不传args参数。

public static void main(String[] args) {
        
    
    	SpringApplication.run(SSMPApplication.class);  //不传args
    	
    }

## 3、配置文件4级分类 ##

对于开发自己调试的配置和上线后的配置，参数值不同，特别的，对于一些涉密系统，如银行系统，数据库信息在开发阶段更不可能拿到，另外，总不能每次启动都像上面加参数用临时属性来覆盖，再者数据库信息总不能被丢到外面的参数里吧，因此出现配置文件的4级分类，给不同阶段的人使用。  
![在这里插入图片描述][d92285fbdd0b4e00a7e3abd359da7091.png]

>  *  `1级： file ：config/application.yml 【最高】`
>  *  `2级： file ：application.yml`
>  *  `3级：classpath：config/application.yml`
>  *  `4级：classpath：application.yml 【最低】`

其中：

*  1级与2级留做系统**打包后设置通用属性**，1级常用于运维经理进行线上整体项目部署方案调控
 *  3级与4级用于系统**开发阶段**设置通用属性，3级常用于项目经理进行整体项目属性调控

关于各级的位置：

![在这里插入图片描述][1afda9c757ff4e6abbaf1a5ffd1b8bca.png]

而工程路径file，即和jar包或者模块目录同级的目录：

![在这里插入图片描述][1584b9bafba24597a63c506900f725aa.png]  
多层级配置文件间的属性采用**叠加并覆盖**的形式作用于程序，即不同的取并集，相同的按优先级来覆盖。

## 4、关于四级分类的思考 ##

既然**工程路径file，是和jar包或者模块目录同级的目录**，那我在项目project目录下建个application.yml文件，岂不是成了所有模块的公共配置了？

![在这里插入图片描述][2c2e8b2eba224f9c9a4940de91ec34b8.png]

这一点以后应该用得到！！

## 5、自定义配置文件 ##

除了以上配置，也可以自定义配置文件，properties与yml文件格式均支持，如：

![在这里插入图片描述][2f83c548a3be4f09aa5fab67b27783d6.png]

然后通过启动参数加载配置文件（无需书写配置文件扩展名)：

![在这里插入图片描述][3bf0a58653b346069ea76641a196e533.png]  
也可通过配置文件位置–spring.config.location来生效：

![在这里插入图片描述][ad8b99e85b7741c69567c089aaa6c776.png]

有多个配置文件时，逗号隔开就好。

![在这里插入图片描述][ddb1c44ef75b4425bc40eb223454ea23.png]

## 6、多环境开发（yaml版） ##

实际开发中，生产、测试、开发三个环境配置各不相同，因此要进行多环境的配置开发：

![在这里插入图片描述][085fa188fdb74ea49ed01bffcb1e0fd7.png]

yml文件写法：使用三个横线来分割文件

![在这里插入图片描述][5efd054b458b49f78f4c7ef5c17bf78c.png]

含义解释：

![在这里插入图片描述][a18eef9b5397454f9d0843172f180971.png]  
spring.profiles是过时写法，可改可不改：

![在这里插入图片描述][429244ac1a8a4634ac56e3ac38c0607b.png]

## 7、配置文件按环境分类 ##

按上面，所有环境的配置写在一起，拿分隔符分开，显然不合理，继续做改善：

![在这里插入图片描述][60b0519bb31641b7acfa8da0c5751a78.png]  
即：

*  主配置文件中设置公共配置（全局），以及active决定来启用哪一个配置
 *  环境分类配置文件中常用于设置冲突属性，也就是自己独有的属性（局部）

![在这里插入图片描述][a6e4061d7b99449aa07223bb729cfe6a.png]

若使用properties文件来进行多环境启动，则需要多文件，注意文件命名：

![在这里插入图片描述][8bc791327c58423ea0e43c9801588695.png]

## 8、include与group再细粒度 ##

> **include：**

根据功能对配置文件中的信息进行拆分，并制作成独立的配置文件，如：

*  application-devDB.yml
 *  application-devRedis.yml
 *  application-devMVC.yml

此时，写主配置文件就使用include属性在激活指定环境的情况下，同时对多个环境进行加载使其生效，多个环境间使用逗号分隔

spring:
      profiles:
        active: dev
        include: devDB,devRedis,devMVC

此时，加载了四个文件，即application-dev.yml带下面的这三个，当这四个文件有属性设置冲突时，以后面的为准，最后加载的环境属性生效。

> **group：**

上面的include的写法，有个不好的体验，我从dev切到test，那除了active字段外，include字段的所有值都给改一遍，繁琐，因此，从Spring2.4版开始使用group属性替代include属性，降低了配置书写量

spring:
      profiles:
        active: dev
        group:
    	  "dev": devDB,devRedis,devMVC
    	  "pro": proDB,proRedis,proMVC
    	  "test": testDB,testRedis,testMVC

此时，切环境就只改active字段就好。

## 9、一点思考 ##

写到这儿，想起之前有个需求，要在配置里适配Redis的三种模式的连接，即单机、集群、哨兵。当时想着在一个yaml中去实现，但yaml是文本语言，没法if判断，因此以为不能实现，现在引入include，就`可以实现一个服务同时适配三种Redis的连接模式`。

*  首先定义好三种模式的配置文件

![在这里插入图片描述][c2d5ed3fb97e49f48cf6e225cdf3c79a.png]  
![在这里插入图片描述][a1159f339b6946e18dfc6015ca66b5f9.png]  
![在这里插入图片描述][d5b84ac1bd2a49428b23c509d4a101fb.png]  
在主配置中include一个文件名带变量的动态文件，变量值由一个环境变量控制且给个默认值。目前项目使用k8s部署，那就在deploy中加一个环境变量。改这个环境变量就实现了切换redis模式。

![在这里插入图片描述][479111dc37e34a808788df80b3122b07.png]

当然，SpringBoot还有

spring:
      config:
        import:
        # 导入classpath下default目录下的default.properties配置文件
        - classpath:/default/default.properties

nacos还有`shared-configs`：

spring:
      cloud:
        nacos:
          config:
            server-addr: localhost:8848
            file-extension: yml
            shared-configs:
              - application-dev.yml
            namespace: dev

以及官网的其他引入配置的方式，都是实现思路。

## 10、多环境开发兼容问题 ##

当maven的pom文件中也配置了多环境开发，且与SpringBoot冲突，如一个默认测试，一个默认开发，此时以Maven为主：

![在这里插入图片描述][203bd9941ac4457bb7b51649c5064752.png]

实现兼容：

*  Maven中设置了多环境属性，activeByDefault属性为true，即默认使用这个

![在这里插入图片描述][9711da8c4f164b839553eb1a030f17c3.png]

*  SpringBoot配置文件中引用Maven属性@key@

![在这里插入图片描述][66fe3c9c8b2b4fc2aefa0b78a5a09955.png]

*  执行Maven打包指令package，并在生成的boot打包文件.jar文件中查看对应信息，看到引用成功。

--------------------

Tip1：

有的引用Maven属性仍然用dollar大括号：

![在这里插入图片描述][dcf2a842dd61469e9dc9c2a3b1f33871.png]

此时直接打包，Maven指令执行结束后，生成jar包，但**类参与了编译而配置文件没有参与编译**，而是复制到包中，**$\{\}未被解析**  
![在这里插入图片描述][4a114246826c446e91c018967725f9ee.png]

此时需要加插件，对资源文件开启对默认占位符的解析  
![在这里插入图片描述][94bc63b74dd34a9486c2d505117df045.png]

Tip2：改完activeByDefault后，即使maven clean，active的文件也不对

基于SpringBoot读取Maven配置属性的前提下，如果在Idea下测试工程时，pom.xml每次更新后，需要手动执行`compile`（编译）方可生效

![在这里插入图片描述][f454a6171c034ef698a505973995ca6e.png]

[85ecfb6cd25140b1888668448d2ee9f3.gif]: https://img-blog.csdnimg.cn/85ecfb6cd25140b1888668448d2ee9f3.gif
[7c352061d5504ecab3060b35fe68cf23.png]: https://img-blog.csdnimg.cn/7c352061d5504ecab3060b35fe68cf23.png
[Link 1]: https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config
[1b470923d9eb49e3a6c88c4d0b2a668a.png]: https://img-blog.csdnimg.cn/1b470923d9eb49e3a6c88c4d0b2a668a.png
[aed68edfdd7041e99f3f075b7c6a8d27.png]: https://img-blog.csdnimg.cn/aed68edfdd7041e99f3f075b7c6a8d27.png
[9c9d8095928740df999dbf16b7b1117c.png]: https://img-blog.csdnimg.cn/9c9d8095928740df999dbf16b7b1117c.png
[30f84a4f486d4dc09743a5a817551ecf.png]: https://img-blog.csdnimg.cn/30f84a4f486d4dc09743a5a817551ecf.png
[d92285fbdd0b4e00a7e3abd359da7091.png]: https://img-blog.csdnimg.cn/d92285fbdd0b4e00a7e3abd359da7091.png
[1afda9c757ff4e6abbaf1a5ffd1b8bca.png]: https://img-blog.csdnimg.cn/1afda9c757ff4e6abbaf1a5ffd1b8bca.png
[1584b9bafba24597a63c506900f725aa.png]: https://img-blog.csdnimg.cn/1584b9bafba24597a63c506900f725aa.png
[2c2e8b2eba224f9c9a4940de91ec34b8.png]: https://img-blog.csdnimg.cn/2c2e8b2eba224f9c9a4940de91ec34b8.png
[2f83c548a3be4f09aa5fab67b27783d6.png]: https://img-blog.csdnimg.cn/2f83c548a3be4f09aa5fab67b27783d6.png
[3bf0a58653b346069ea76641a196e533.png]: https://img-blog.csdnimg.cn/3bf0a58653b346069ea76641a196e533.png
[ad8b99e85b7741c69567c089aaa6c776.png]: https://img-blog.csdnimg.cn/ad8b99e85b7741c69567c089aaa6c776.png
[ddb1c44ef75b4425bc40eb223454ea23.png]: https://img-blog.csdnimg.cn/ddb1c44ef75b4425bc40eb223454ea23.png
[085fa188fdb74ea49ed01bffcb1e0fd7.png]: https://img-blog.csdnimg.cn/085fa188fdb74ea49ed01bffcb1e0fd7.png
[5efd054b458b49f78f4c7ef5c17bf78c.png]: https://img-blog.csdnimg.cn/5efd054b458b49f78f4c7ef5c17bf78c.png
[a18eef9b5397454f9d0843172f180971.png]: https://img-blog.csdnimg.cn/a18eef9b5397454f9d0843172f180971.png
[429244ac1a8a4634ac56e3ac38c0607b.png]: https://img-blog.csdnimg.cn/429244ac1a8a4634ac56e3ac38c0607b.png
[60b0519bb31641b7acfa8da0c5751a78.png]: https://img-blog.csdnimg.cn/60b0519bb31641b7acfa8da0c5751a78.png
[a6e4061d7b99449aa07223bb729cfe6a.png]: https://img-blog.csdnimg.cn/a6e4061d7b99449aa07223bb729cfe6a.png
[8bc791327c58423ea0e43c9801588695.png]: https://img-blog.csdnimg.cn/8bc791327c58423ea0e43c9801588695.png
[c2d5ed3fb97e49f48cf6e225cdf3c79a.png]: https://img-blog.csdnimg.cn/c2d5ed3fb97e49f48cf6e225cdf3c79a.png
[a1159f339b6946e18dfc6015ca66b5f9.png]: https://img-blog.csdnimg.cn/a1159f339b6946e18dfc6015ca66b5f9.png
[d5b84ac1bd2a49428b23c509d4a101fb.png]: https://img-blog.csdnimg.cn/d5b84ac1bd2a49428b23c509d4a101fb.png
[479111dc37e34a808788df80b3122b07.png]: https://img-blog.csdnimg.cn/479111dc37e34a808788df80b3122b07.png
[203bd9941ac4457bb7b51649c5064752.png]: https://img-blog.csdnimg.cn/203bd9941ac4457bb7b51649c5064752.png
[9711da8c4f164b839553eb1a030f17c3.png]: https://img-blog.csdnimg.cn/9711da8c4f164b839553eb1a030f17c3.png
[66fe3c9c8b2b4fc2aefa0b78a5a09955.png]: https://img-blog.csdnimg.cn/66fe3c9c8b2b4fc2aefa0b78a5a09955.png
[dcf2a842dd61469e9dc9c2a3b1f33871.png]: https://img-blog.csdnimg.cn/dcf2a842dd61469e9dc9c2a3b1f33871.png
[4a114246826c446e91c018967725f9ee.png]: https://img-blog.csdnimg.cn/4a114246826c446e91c018967725f9ee.png
[94bc63b74dd34a9486c2d505117df045.png]: https://img-blog.csdnimg.cn/94bc63b74dd34a9486c2d505117df045.png
[f454a6171c034ef698a505973995ca6e.png]: https://img-blog.csdnimg.cn/f454a6171c034ef698a505973995ca6e.png