SpringBoot的多环境配置详解(上)——文件配置项版

keep thinking

已于 2024-04-06 19:06:01 修改

阅读量1k

点赞数

分类专栏： SpringBoot框架详解文章标签： spring boot spring java

于 2023-03-23 15:55:55 首次发布

本文链接：https://blog.csdn.net/CNCDXX_88/article/details/129730976

版权

SpringBoot框架详解专栏收录该内容

5 篇文章 0 订阅

订阅专栏

SpringBoot不同环境加载不同配置文件 - resource & profile

文章目录

1、 profile多配置文件

我们在使用springBoot的时候，一般都会有不同的环境需要部署：开发环境、测试环境和生产环境，而不同的环境则会有不同的配置，比如数据库连接地址。解决这个问题，我所熟悉的有两种策略：

springboot的profile参数配置
pom文件的resource & profile配置

springboot的profile配置
Spring Profiles 允许用户根据环境配置来读取不同的配置文件（dev，test，online 等）,可以通过激活、指定参数等方式快速切换环境。

在Spring Boot中多环境配置文件名需要满足application-{profile}.yml的格式，其中{profile}对应你的环境标识，比如：

application.yml：主配置文件
application-dev.yml：开发环境
application-test.yml：测试环境
application-online.yml：生产环境

至于哪个具体的配置文件会被加载，需要在application.yml文件中通过spring.profiles.active属性来设置，其值对应{profile}值。
在开发、测试、发布配置application-{profile}.yml，在使用时通过profile参数来切换。
如：可以为每个配置文件设置不同的端口和数据库连接串

application-dev.yml

#开发环境
server:
  port: 8081
spring:
  datasource:
    durid:
      url:jdbc:mysql://aaaaaaa

application-test.yml

#测试环境
server:
  port: 8081
spring:
  datasource:
    durid:
      url:jdbc:mysql://bbbbb

application-online.yml

#线上环境
server:
  port: 8081
spring:
  datasource:
    durid:
      url:jdbc:mysql://ccccc

这个时候需要里面切换到开发环境，则可以在主配置文件中使用如下指令:

#本地环境
server:
  port: 8080
#切换到线上环境
spring:
  profiles:
    active: online

多文件配置

在这里插入图片描述
当然在Spring Boot中多环境配置文件名也可以通过application-{profile}.properties的格式，其中{profile}对应你的环境标识，比如：

application.properties：默认配置
application-dev.properties：开发环境
application-test.properties：测试环境
application-prod.properties：生产环境
在这里插入图片描述
至于哪个具体的配置文件会被加载，需要在application.properties文件中通过spring.profiles.active属性来设置，其值对应{profile}值。

如：spring.profiles.active=test就会加载application-test.properties配置文件内容
下面，以不同环境配置不同的服务端口为例，进行样例实验。

针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties 在这三个文件均都设置不同的server.port属性，如：dev环境设置为8080，test环境设置为9090，prod环境设置为80、application.properties中设置spring.profiles.active=dev，就是说默认以dev环境设置。

如：spring.profiles.active=hello-world,sender,dev 有三个参数，其中 dev正好匹配下面配置中的application-dev.properties配置文件，所以app启动时，项目会先从application-dev.properties加载配置，再从application.properties配置文件加载配置，如果有重复的配置，则会以application-dev.properties的配置为准。

补充：如果是application.yml,application.properties配置文件同时存在，会以application.properties配置文件为准，因为后加载的配置文件中重复的配置项会覆盖先加载的配置项。两者中如果用spring.profiles.active指定其他配置文件，最终重复项以spring.profiles.active指定的配置文件为准。

2、 profile单配置文件

在 xxx.properties 配置文件中，每使用一个 — 分割代表分割成了一个文档块，可以在不同的文档块中进行配置，并在第一个文档块对配置进行切换

配置一个多文档块的配置文件
server:
    port: 8080
spring:
    profiles:
        active: test    # 切换配置
 
---
# 开发环境
server:
    port: 8081
spring:
    profiles: dev
 
---
# 测试环境
server:
    port: 8082
spring:
    profiles: test
 
---
# 生产环境
server:
    port: 8083
spring:
    profiles: online

3、maven的profiles策略

maven的pom文件里面也有一个配置profiles的功能，这个profiles配合resources可以实现打包时根据配置的生效profiles的路径进行打包。
第一步：
创建配置文件，config目录下有三个文件夹：dev（开发）、test（测试）、online（生产）。
在这里插入图片描述
第二步：

配置pom文件

   <!-- activation指定生效的profile -->
    <profiles>                                          <!-- profile组 -->
        <profile>                                       <!-- 一个profile -->
            <id>dev</id>                                <!-- id，不能重复 -->
            <activation>                                <!-- 指定生效的profile -->
                <activeByDefault>true</activeByDefault>
            </activation>
            <properties>                                <!-- 该profile映射的路径 -->
                <env.name>dev</env.name>
                <resource.env.name>dev</resource.env.name>
            </properties>
        </profile>
        <profile>
            <id>test</id>    
            <properties>
                <env.name>${env}</env.name>
                <resource.env.name>test</resource.env.name>
            </properties>
        </profile>
        <profile>
            <id>online</id>
            <properties>
                <env.name>${env}</env.name>
                <resource.env.name>online</resource.env.name>
            </properties>
        </profile>
    </profiles>
 
    <build>
        <!-- 配置文件打包时的映射路径，profiles.active获取当前生效的profile路径 -->
        <resources>                                          <!-- resources组 -->
            <resource>                                       <!-- 一个resource -->
                <directory>src/main/resources</directory>    <!-- 需要处理的路径 -->
            </resource>
            <resource>
                <directory>src/main/resources/config/${resource.env.name}</directory>                                                 <!-- 打包文件所在的路径，profiles.active就是profiles里面生效的路径 -->
                <targetPath>.</targetPath>                   <!-- 可有可无 -->
            </resource>
        </resources>
    </build>

当工程本地启动时，会默认激活获取dev环境的参数配置，当线上或者测试环境启动时可以将环境标env作为参数传递进来，这样就可以达到灵活配置获取配置文件了。

4、spring.profiles.active=@profiles.active@用法

spring.profiles.active=@profiles.active@的含义
spring.profiles.active=@profiles.active@ ，其实是配合 maven profile进行选择不同配置文件进行启动。

当执行mvn clean package -P test命令时， @profiles.active@ 会替换成 test

————————————————
假设目前有三个环境dev、test和prod，那么需要在pom.xml进行配置：

 <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
 </build>
 <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>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
        </profile>
        <profile>
            <!-- 生产环境 -->
            <id>prod</id>
            <properties>
                <profiles.active>prod</profiles.active>
            </properties>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
        </profile>
    </profiles>

上述默认使用dev配置。配置后需要点击刷新按钮来刷新maven，然后会看到如下的几种选择：
在这里插入图片描述
当我们在Profiles文件夹下的几个选项框中勾选不同的选项时，就会激活不同的开发环境。比如勾选prod，则默认会激活prod环境。

首先创建application.properties文件，其内容为：

spring.profiles.active=@profiles.active@

创建application-dev.properties：

server.port=8888
name=dev

创建application-test.properties：

server.port=9999
name=test

创建application-prod.properties：

server.port=8080
name=prod

启动项目，查看控制台启动日志，启动端口是8888，然后关闭。

在Propfiles中勾选test，取消勾选dev，再启动项目，此时启动端口是9999，其他环境同理，打包也是类似的方式。

注意：若切换时还是使用上一次环境或报错，那么需要刷新一下maven再重启项目。

若是maven命令打包，其方式如下：

mvn clean package -P prod

使用-P指定使用的配置文件即可。无论是自动打包还是使用maven命令打包，最终的环境名称会配置给application.properties中，即：

spring.profiles.active=@profiles.active@  //这里假设是prod环境打包的，@profiles.active@ 会替换成 prod

也就是说，免去了频繁修改配置文件的操作。

编写一个测试案例

当我们切换到不同的环境时，访问hello接口时就会返回不同的值
@RestController
public class HelloController {

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

    @RequestMapping(value = {"/hello"},method = RequestMethod.GET)
    public String say(){
        return "Hello！我是："+name;
    }
}