使用Maven配置文件激活Spring Boot配置文件

素颜马尾好姑娘i 2021-11-22 11:02 531阅读 0赞

## 使用Maven配置文件激活Spring Boot配置文件 ##

转载自[http://dolszewski.com/spring/spring-boot-properties-per-maven-profile/][http_dolszewski.com_spring_spring-boot-properties-per-maven-profile]

有些团队更喜欢[为每个应用程序运行时环境][Link 1]提供[单独的Maven构建配置文件][Link 1]，例如dev，test，prod等。在本文中，我将向您展示如何使用Spring Boot配置文件连接Maven配置文件。您将学习如何使用Maven的*pom.xml*文件设置活动的Spring配置文件。

### Spring配置文件的单独application.properties ###

您将使用[Spring Boot application.properties文件][Spring Boot application.properties]来激活其中一个配置文件。如果您的应用程序资源中没有该文件，则现在是创建该文件的正确时机。

通常，我们希望**使用Maven选择活动的Spring配置文件来构建具有所选配置文件的JAR / WAR文件**。该演示将向您展示如何做到这一点。

首先，创建两个额外的配置文件。文件名应与模式*application- \{profile\} .properties*匹配。将文件添加到Maven项目的*src / main / resources*目录中，位于主application.properties文件旁边。

![img][]

### Maven配置 ###

然后是时候修改你的*pom.xml了*。您创建了两个配置文件，因此现在需要定义两个Maven配置文件。

在两个Maven配置文件中，定义一个自定义属性并调用它，例如，*activateProperties*。这个名字并不重要。更重要的是它的价值。

**自定义Maven属性的值应与要**使用相应Maven配置文件**激活的Spring配置文件匹配**。在我们的示例中，我们将它们称为*dev*和*release*。

此外，您可以标记默认情况下运行的一个Maven配置文件。如果您不自行选择一个配置文件，则以下示例将激活第一个配置文件。

<profile>
        <id>dev</id>
        <properties>
            <activatedProperties>dev</activatedProperties>
        </properties>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
    </profile>
    <profile>
        <id>release</id>
        <properties>
            <activatedProperties>release</activatedProperties>
        </properties>
    </profile>

### Maven资源过滤 ###

让我们留在pom.xml片刻。在上一步中，您定义了Maven和Spring配置文件之间的映射。但您仍需要**将配置文件映射传输**到Spring Boot应用程序中。

怎么样？

您将使用Maven 在*application.properties*文件中使用定义的Maven配置文件中的值设置名为*spring.profiles.active的* Spring属性。顾名思义，此属性负责激活Spring配置文件。

为此，您需要允许Maven在构建过程中操作资源文件。您可以通过在*pom.xml中*启用[Resources插件的][Resources]过滤来完成此操作。**但是，如果使用*spring-boot-starter-parent*作为*pom.xml*的父级，则可以跳过此步骤。**

<build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
        …
    </build>

现在是时候迈出最后一步了。将以下行添加到*application.properties*文件中。

spring.profiles.active=@activatedProperties@

\*@\*字符之间的值必须与Maven配置文件中的自定义属性匹配。

### 它是如何工作的？ ###

运行构建时，Resources Plugin将使用当前活动的Maven配置文件中的属性替换*application.properties中*的*activatedProperties*占位符。

启动应用程序后，Spring框架将激活已过滤的*application.properties*文件中定义的Spring配置文件。接下来，框架根据活动配置文件读取其他*application- \{profile\} .properties*文件。

**需要注意的是：** [Spring Boot 1.3替换了][Spring Boot 1.3]过滤值[的默认Resources Plugin语法][Spring Boot 1.3]。框架使用\*@ activatedProperties @*而不是*$ \{activatedProperties\}\*表示法。

### 总结 ###

新建application-prod.yml, application-dev.yml, application-test.yml

内容如下:

#application-dev.yml
    server:
      port: 8081
      
    #application-test.yml
    server:
      port: 8082
      
    #application-prod.yml
    server:
      port: 8083

在pom文件中添加:

application.yml中添加

spring:
      profiles:
        active: @profileActive@ #这个必须和pom中自定义字段意义

使用下图设置启动方式:  
![在这里插入图片描述][20190724205319798.png]

这是我们设置的是启动id为test的配置, 这时@profileActive@被替换成test

[http_dolszewski.com_spring_spring-boot-properties-per-maven-profile]: http://dolszewski.com/spring/spring-boot-properties-per-maven-profile/
[Link 1]: http://dolszewski.com/spring/dual-jar-war-build-for-spring-boot/
[Spring Boot application.properties]: http://dolszewski.com/spring/spring-boot-application-properties-file/
[img]: /images/20211122/4c0c8c33ccf8442ca29ff1cb4dbc2d77.png
[Resources]: https://maven.apache.org/plugins/maven-resources-plugin/
[Spring Boot 1.3]: https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-1.3-Release-Notes#maven-resources-filtering
[20190724205319798.png]: /images/20211122/1bf18d199f1744af8a2651fcb0984dc1.png