springboot配置多项目下统一切换不同环境变量profile办法

朱雀 2023-10-02 16:59 3阅读 0赞

#### springboot配置多项目下统一切换不同环境变量profile办法 ####

`springboot` 适合于微服务那种多项目开发，每一个小项目就是一个`springboot` 项目，比如我们这样：  
![这里写图片描述][70]

###### 问题发生： ######

我们知道`springboot` 项目中的配置文件`application.properties` ，几乎我们的配置信息都写在了这边，非常方便，但常常我们会多环境应用，比如`开发环境` 、`测试环境` 、`正式环境` 等不同的配置信息，前一段时间，对我们公司的一个项目，在多个省进行了部署，我改来改去差点疯了，同事的提醒，也深刻体会到，如果单用一个配置文件，绝对不行。

###### 配置办法： ######

对于上边的贴出的那个例子，介绍如下：  
![这里写图片描述][70 1]  
当然`springboot` 项目默认为`jar` ，但是有时候我们也会像上边一样，以`war` 包运行。针对于不同的包类型，我发现配置是不同的。

###### 1、每一个子项目中创建`dev` 、`product` 等多个不同的配置文件 ######

大家这里可能说是不是太麻烦，每个子项目都要配一个，其实是可以都配置到父`pom.xml` 里的，只不过我嫌看起来不直观，所以都每个环境都给搞了一个，后边我会写上直接一个配置文件搞定的写法。  
如上图所示，在两个子项目`springboot-study-rest` 、`springboot-study-service` 中的`resources` 下，分别都创建`application-dev.properties` 和`application-product.properties` 两个文件。  
然后在它们原有的`application.properties` 文件中都填写下边这种配置：

#多环境配置
    spring.profiles.active=@activatedProperties@

上边的`activatedProperties` 会在下边`第二步` 中提到。  
然后对于`dev` 、`product` 的不同环境下的配置，分别写到对应的配置文件中即可。

###### 2、父`pom` 添加`profiles` ######

首先找到项目的父`pom.xml` ,如果你单项目，那就找它自己就行了，找到后，加上如下配置：

<profiles>
            
            <profile>
                
                <id>dev</id>
                
                <properties>
                    
                    <activatedProperties>dev</activatedProperties>
                </properties>
                <activation>
                    
                    <activeByDefault>true</activeByDefault>
                </activation>
            </profile>
            
            <profile>
                <id>product</id>
                <properties>
                    <activatedProperties>product</activatedProperties>                
                </properties>
            </profile>
        </profiles>

上边中你会看到在`第一步` 中配置的那个`activatedProperties`，它们是一一对应的，并且两边添加上`@@` 即可。  
上边这段，我是放置在父`pom.xml` 的下边这个位置,位置无所谓的：  
![这里写图片描述][70 2]

###### 3、`war` 包的，子`pom` 添加`resources` 如下： ######

<build>
            <finalName>springboot-study-rest</finalName>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <executions>
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-war-plugin</artifactId>
                    <configuration>
                        <failOnMissingWebXml>false</failOnMissingWebXml>
                    </configuration>
                </plugin>
            </plugins>
            <resources>
                
                <resource>
                    
                    <directory>src/main/webapp</directory>
                    
                    <targetPath>META-INF/resources</targetPath>
                    <includes>
                        <include>**/**</include>
                    </includes>
                </resource>
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/**</include>
                    </includes>
                    
                    <filtering>true</filtering>
                </resource>
            </resources>
        </build>

上边这段是我把整个`pom.xml` 里\`\` 标签中的东西贴上了，大家可以参照，这里只说`resources` ,注意下边有一个：

**一定要设置成**`true` ，否则项目运行的时候，`application.properties` 文件中的引用变量值变不过来。

###### 3、`jar` 包的，子`pom` 中不需要加`resource`： ######

我亲自试过，下边是我的jar包中,`pom.xml` 中的\`\` 标签内容：

<build>
            <plugins>
                
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>1.5.1.RELEASE</version>
                    <executions>
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
                
                    
                    
                    
                    
                        
                        
                    
                
                
                    
                    
                    
                    
                        
                    
                
            </plugins>
            
                
                    
                    
                        
                    
                    
                
                
                    
                    
                        
                    
                
            
    </build>

上边我已经把其他东西都注释掉了，只留下一个`plugins` 标签。编译之后，就可以替换成功。而`war` 包却不能那样，必须要有`resources` 标签，并且对其中的`filter` 设置成`true`才可以。

到此，可以直接运行项目，如果都出现下边这行，即配置完成。  
![这里写图片描述][70 3]  
如果上图的位置中还是`@activatedProperties@` 说明没有成功。

##### 下边说一下一个配置文件搞定的办法 #####

其实通过以上的配置，大家估计也看出来了，如何只使用一个配置文件，配置除去`第一步` ，其他，跟上边是一样的，只不过需要把你对于不同环境的配置信息，都移到了父`pom.xml` 中即可。

###### 1、配置信息写到父`pom.xml`中 ######

<profiles>
            
            <profile>
                
                <id>dev</id>
                
                <properties>
                    
                     <restport>8076</restport>
                     <serviceport>8089</serviceport>
                    <zkHost>http://localhost:8983/solr</zkHost>
                    <driverclass>oracle.jdbc.driver.OracleDriver</driverclass>
                </properties>
                <activation>
                    
                    <activeByDefault>true</activeByDefault>
                </activation>
            </profile>
            
            <profile>
                <id>product</id>
                <properties>
                     <restport>30000</restport>
                     <serviceport>30001</serviceport>
                    <zkHost>http://113.11.11.11:8983/solr</zkHost>
                    <driverclass>com.microsoft.sqlserver.jdbc.SQLServerDriver</driverclass>
                </properties>
            </profile>
        </profiles>

即把我们的配置，都写到了每一个`profiles`下的`properties` 中了。

###### 2、`application.properties` 文件引用 ######

`springboot-study-rest` 项目中的`application.properties` 文件中如下：

server.port=@restport@
    spring.data.solr.zk-host=@zkHost@

`springboot-study-service`项目中的`application.properties` 文件中如下：

server.port=@serviceport@
    spring.datasource.driver-class-name=@driverclass@

###### 3、配置完成后，运行项目。 ######

配置完成后，运行项目，因为现在没有了`dev` 、`product` 的`properties` 文件了，那运行后的日志会是这样的，即`default` ,没关系，意思就是说使用的是`application.properties` 文件中的内容。  
![这里写图片描述][70 4]

###### 4、其他配置参照上边那种配置方法即可 ######

对于其他的关于各个项目的`pom.xml` 配置，就参照上边写的吧，都一样了。  
这样看来，下边的这种配置方式更加简洁。可能大部分人会更偏向于接受后边的这种配置。

##### 配置失败的原因分析 #####

可能我写的不够详细，大家在配置中会遇到失败的问题，我觉得最可能引起错误的原因主要有下边这几个：  
1、`maven` 的配置没有更新，因为我们改了些配置，即需要重新更新下`maven` 配置即可。  
2、`项目未编译` ，如果你配置正确，还没有启动成功，十之八九的原因在这里，你只需要对项目重新`clean install` 即可。即把旧的class文件及配置全部清除掉，再重新编译打包即可。  
3、`配置对应的名称写错，不对应` ,即类似于我们在`properties` 文件中的引用,`@@` 之间的内容必须与`profile` 中的`properties` 标签中的名字对应，如果错了就替换不成功的，如果没有那肯定也是替换不了的。  
4、`war` 包中的`resources` 下的`filter` 未设置成`true` 。

[70]: https://img-blog.csdn.net/20180712195418777?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dvaGFxaXlp/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70
[70 1]: https://img-blog.csdn.net/2018071220052012?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dvaGFxaXlp/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70
[70 2]: https://img-blog.csdn.net/20180713074646451?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dvaGFxaXlp/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70
[70 3]: https://img-blog.csdn.net/20180713081829454?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dvaGFxaXlp/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70
[70 4]: https://img-blog.csdn.net/20180713084024100?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dvaGFxaXlp/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70