springboot_多环境下如何进行动态配置详解

梦里梦外; 2024-03-31 12:55 48阅读 0赞

## 简介 ##

> 在平时的开发中，经常会有多个环境，如何管理多个环境中的配置呐？一个是我们本地的开发环境，可以称为dev，一个是测试环境，我们称为test，最后还要有生产环境，称为prod。每个环境的配置都是不一样的，如何做到快捷方便的使用各自环境的配置绝对是开发中需要着重考虑的。

## 1、如何配置多环境 ##

> 在springboot中有默认的配置文件application.properties/application.yml文件，前面几篇分享中一直都是以application.properties文件为例，继续延用该习惯，且application.properties文件的优先级高于application.yml文件。

> 在resources目录下新建application-dev.properties、application-test.properties、application-prod.properties三个配置文件，注意application.properties文件一定要存在，因为它是默认的配置文件。思考下如果没有application.properties文件，有什么方法可以实现不同环境的配置文件切换，答案是前边说的“spring.config.name”和“spring.config.location”这两个属性，不同环境配置不同的文件名即可。继续看三个配置文件，

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

application-dev.properties
    server.port=9091
    
    application-test.properties
    server.port=9092
    
    application-prod.properties
    server.port=9093
    
    另外，在application.properties的配置如下，新加了“spring.profiles.active=test”配置，
    
    server.port=9090
    spring.profiles.active=test
    看下启动效果，

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

> 可以看到这样就可以实现多环境的动态切换，只需要修改application.properites文件中的“spring.profiles.active”的值即可，注意配置文件需满足application- p r o f i l e s . p r o p e r t i e s / y m l 的格式， \{profiles\}.properties/yml的格式， profiles.properties/yml的格式，\{profiles\}=dev/test/prod/dev3…

## 2、生效多环境的多种方式 ##

> 上面，了解了如何配置多个环境的配置，下面看下如何动态使用。除了上面提到的“spring.profiles.active”还有很多意想不到的。

### 2.1、spring.config.name ###

> 上面也提到可以使用"spring.config.name"属性来决定使用哪个配置文件，“spring.config.name”可以配置在JVM参数和环境变量处，且JVM参数的优先级大于环境变量的。下面尝试下，直接配置在JVM参数处，演示下效果，

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

> 这里配置“-Dspring.config.name=application-prod”也就是使用application-prod.properties文件，那么这里的端口肯定是“9093”，看下启动日志

> 在不同环境下的多个配置文件，可以使用“spring.config.name”属性来指定使用哪个环境的文件。不过大多数情况下不建议使用该方式。

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

### 2.2、spring.profiles.active ###

> 在上面也提到了该属性“spring.profiles.active”注意该属性和“spring.config.name”的配置值是有区别的，“spring.profiles.active”配置的是application-dev.properties中的“dev“，而“spring.config.name”则配置的是”application-dev“。”spring.profiles.active“不仅可以配置在application.properites文件中，还可以配置在JVM变量和环境变量中，下面看下在配置文件和JVM变量中的优先级，

> 在application.properties文件中配置”spring.profiles.active=test“,

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

> 在JVM变量中配置”spring.profiles.active=prod“，

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

> 看下启动日志，

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

> 从上图，可以知道JVM变量的优先级大于application.properties中的配置，也就是说JVM中的”spring.profiles.active“的值会覆盖application.properties中的”spring.profiles.active“中的值。

> 我们上面说到的都是需要在启动的时候配置参数，那么有没有一种方式可以把配置文件打包在jar包里，在启动的时候不需要配置参数，直接执行jar即可。下面的这种方式或许可以实现哦。

### 2.3、pom中标签 ###

> 可以结合maven中的标签动态切换多环境的配置文件，由于这里不再使用”spring.config.name“及”spring.profiles.active“等属性，所以springboot默认读取的配置文件依然是”application.properties“文件，既然多环境下都是该文件，那如何做区分呐，看下图，

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

> 没错，通过不同的文件夹来区分不同的环境，每个文件夹下的配置文件的内容分别是dev（9091）、test（9092）、prod（9093），那么要如何加载不同的文件，这里要结合pom.xml文件，

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>org.example</groupId>
        <artifactId>springTemplate</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <version>2.3.3.RELEASE</version>
            </dependency>
        </dependencies>
        <profiles>
            
            <profile>
                <id>dev</id>
                <properties>
                    <profiles.active>dev</profiles.active>
                </properties>
                <activation>
                    <activeByDefault>true</activeByDefault>
                </activation>
            </profile>
            
            <profile>
                <id>test</id>
                <properties>
                    <profiles.active>test</profiles.active>
                </properties>
            </profile>
            
            <profile>
                <id>prod</id>
                <properties>
                    <profiles.active>prod</profiles.active>
                </properties>
            </profile>
        </profiles>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <executions>
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
            <resources>
                <resource>
                    <directory>src/main/resources/${
        profiles.active}</directory>
                </resource>
            </resources>
        </build>
    </project>

> 在pom.xml文件中加入了上面的配置，idea的”maven“界面，发生了下面的变化，默认是上面配置的”dev“，

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

> 看下选择了”dev“，服务的启动日志，

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

> 从服务启动日志可以看到在端口”9091“启动，也就是使用的是test的配置文件。注意，修改了下图中的值后，一定要先执行mvn clean，然后执行mvn compie，最后再启动项目，  
> ![在这里插入图片描述][6b7b6e07616a4dddb7593a110ebaa42f.png]  
> 使用这样的方式，在打包的时候就可以根据不同的环境选择不同的profile，每个环境的包的配置文件是不一样的。

## 3、总结 ##

> 本文主要分享了如何在springboot的项目中使用多环境配置，重点是”spring.profiles.active“属性，  
> 1）、使用”spring.profiles.actvie“属性可以指定配置文件，要指定的文件需满足application- p r o f i l e s . p r o p e r t i e s / y m l 的格式， \{profiles\}.properties/yml的格式， profiles.properties/yml的格式，\{profiles\}可以是dev、test、prod等代表不同环境的值；  
> 2）、不同环境配置不同文件，可使用"spring.profiles.active"和”spring.config.name“属性，针对”spring.profiles.active“可以配置在application.properties也可以配置在JVM中，JVM参数的优先级大于application.properties文件。其实，springboot项目中application.properties文件中可配置的属性都可以通过JVM/环境变量的方式配置；  
> 3）、多环境打包，可以使用pom中的标签，不同环境打包各自的配置文件；

## 4、mavn 打包示例 ##

> 系统中有很多的配置数据需要在配置文件中,咱们总不能全部写在application.yml中,即使写了application-dev.yml,application-test.yml,application-prod.yml这些文件,但是还是需要把所有的配置写在对应的文件中,只是环境不同,属性值不同罢了,但是这样会导致我们得配置文件中的数据会很多,比较乱!接下来使用另一种方式:

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

> logback-spring.xml 是spring需要的日志,这里没有做特殊处理,就直接按照默认的来就行了,就叫这个名字即可.  
> resource 下的config 下有三个环境,现在根据不同的环境打包不同的配置到target;  
> pom的配置如下:

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

> 我把主要的pom代码块贴出来

<build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <excludes>
                            <exclude>
                                <groupId>org.springframework.boot</groupId>
                                <artifactId>spring-boot-configuration-processor</artifactId>
                            </exclude>
                        </excludes>
                    </configuration>
                </plugin>
            </plugins>
     
            <resources>
                <resource>
                    
                    <directory>src/main/resources/config/${
        env}</directory>
                    <targetPath>${
        project.build.directory}/classes/config</targetPath>
                </resource>
     
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        
                        <include>bootstrap.yml</include>
                        
                        <include>mapper/**/*</include>
                    </includes>
                </resource>
            </resources>
        </build>
        <profiles>
            <profile>
                
                <id>dev</id>
                <properties>
                    <env>dev</env>
                </properties>
                <activation>
                    <activeByDefault>true</activeByDefault>
                </activation>
            </profile>
            
            <profile>
                <id>test</id>
                <properties>
                    <env>test</env>
                </properties>
            </profile>
     
            
            <profile>
                <id>prod</id>
                <properties>
                    <env>prod</env>
                </properties>
            </profile>
        </profiles>

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

> 由于spring默认读取application.yml,我们上面只是打包实现了把相应的文件打到target,但是application-datasource.yml 和 application-redis.yml 的数据是读不到的！因此需要在application.yml中添加包含哪些配置文件,这要是为啥要用application-xxx.yml 的格式

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

> 这样,spring的上下文环境中在启动的时候就会把我们在这里配置的相应的文件加载进上下文的属性环境中去,然后我们就能利用spring注解形式或者 springboot 的注解@ConfigurationProperties类使用我们在配置文件中配置的数据了!

> 如有不当之处,烦请大佬赐教 一个简单的方式,感谢!共同进步!

[00c76ea8170e405080afa4041acf8e3f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/1b2e2c9cc7934a348ab7288a97ee9103.png
[1cc35cc6848f4ed59fc9b184a9f9836b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/9ef942353ecc4551b44b87d76e819393.png
[07eefd1db34d43f8a27776414deb1294.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/a94440bac1014e7ebdf9f1ffe23fe880.png
[289857850c024a3d9c53cb1b03755218.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/01c95118fb5f4e5aa370ccc85be2172d.png
[0648f57b1a0c4c3da8e136acbc0741ae.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/566a1bf61dac44c5b8eebc5b8218600e.png
[a492582c97434162afe38f2acf73872a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/5d3718dc6b92439bb5d5209e9237c63a.png
[444b07a53ade4ed49b12fe809c651941.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/4a634987e6e2450680d9096159ff99e0.png
[4bf383031ded40388f3b300d053d6ccb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/a3da4394f7444c459e56b19e09019694.png
[dbfbadc62e274226a16464dc5be3fcce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/95eb5c47387944cbb1f49dedeb407fab.png
[ffb4cc65e439430cbee12c5d89b1a9a3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/86cdb1410d49466a92adf67f5ee179e6.png
[6b7b6e07616a4dddb7593a110ebaa42f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/3b94cc170232427d985816ee59e3c810.png
[1b0f6a0b9a64489faf8c51e23e6b9151.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e6862e0dc045419790f904764f8a4447.png
[0dbad04254724358b7eff4c52ad79214.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/af177a57fce64127bf0d91cdc1e0a6f1.png
[18e8fef66b354cc0b79b17e3e63eeb2f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/bb8ddfef6bd2409a8d5363ee5d6bfa9f.png
[b468bd80ce4e44e1aa1a0252dbf2ef6f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/33966f2984d34bd7ac2b6741fc27d937.png