Spring Boot 项目通过 Maven profiles 使用 -P 支持项目多环境配置打包

最新推荐文章于 2022-08-22 09:11:04 发布
最新推荐文章于 2022-08-22 09:11:04 发布
阅读量1.5k 收藏 3
点赞数 3
分类专栏： Spring boot Architecture
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u012410733/article/details/116563194
版权

在我们进行项目开发的时候，都会把一些固定的值添加到配置文件当中进行集中管理。如果更近一步就是通过配置中心进行管理，但是配置中心的地址也是需要配置在项目中的配置文件当中的。一般在项目当中分为不同的环境，比如:

  • local 环境：本地环境，一般是开发人员在本地进行开发测试的环境
  • dev 环境：开发环境，外部用户无法访问，开发人员使用，版本变动很大。
  • test 环境：测试环境，外部用户无法访问，专门给测试人员使用的，版本相对稳定。
  • uat 环境：User Acceptance Test 用户验收测试，一般用于商户对接使用
  • pre 环境：灰度环境，外部用户可以访问，但是服务器配置相对低，其它和生产一样。
  • pro环境：生产环境，面向外部用户的环境，连接上互联网即可访问的正式环境。

多个环境当中代码逻辑肯定是一样的，不同的是他们的配置文件中的配置参数肯定是不一样的。比如：数据库连接信息， Redis 连接信息，远程调用第三方 http 地址或者其它各种中间件的访问地址都是不一样的。

一般我们项目是使用 maven 来进行项目管理的，当然 gradle 也可以作为项目管理。它应该也具有类似的功能，今天我们就讨论 maven 的使用，如何对 gradle 感兴趣的朋友可以自行了解。

1、什么是 Maven

Maven 翻译为"专家"、“内行”，是 Apache 下的一个纯 Java 开发的开源项目。基于项目对象模型（缩写：POM）概念，Maven利用一个中央信息片断能管理一个项目的构建、报告和文档等步骤。

Maven 是一个项目管理工具，可以对 Java 项目进行构建、依赖管理。

Maven 也可被用于构建和管理各种项目，例如 C#，Ruby，Scala 和其他语言编写的项目。Maven 曾是 Jakarta 项目的子项目，现为由 Apache 软件基金会主持的独立 Apache 项目。

2、Maven profiles 构建配置文件

在 pom.xml 可以定义 profiles，profiles 中包含多个 profile 可以让我们定义一系列的配置信息，然后指定其激活条件。这样我们就可以定义多个 profile，然后每个 profile 对应不同的激活条件和配置信息，从而达到不同环境使用不同配置信息的效果。

<?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>profile-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <name>profile-demo</name>
    <!-- FIXME change it to the project's website -->
    <url>http://www.example.com</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.7</maven.compiler.source>
        <maven.compiler.target>1.7</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <profiles>
        <!--本地环境 -->
        <profile>
            <id>local</id>
            <properties>
                <activatedProperties>local</activatedProperties>
            </properties>
        </profile>
        <!--开发环境 -->
        <profile>
            <id>dev</id>
            <properties>
                <activatedProperties>dev</activatedProperties>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <!--测试环境 -->
        <profile>
            <id>test</id>
            <properties>
                <activatedProperties>test</activatedProperties>
            </properties>
        </profile>
        <!--uat 环境 -->
        <profile>
            <id>uat</id>
            <properties>
                <activatedProperties>uat</activatedProperties>
            </properties>
        </profile>
        <!--预发布环境 -->
        <profile>
            <id>pre</id>
            <properties>
                <activatedProperties>pre</activatedProperties>
            </properties>
        </profile>
        <!--生产环境 -->
        <profile>
            <id>prod</id>
            <properties>
                <activatedProperties>prod</activatedProperties>
            </properties>
        </profile>
    </profiles>

</project>

注意：构建配置文件采用的是 节点。

说明：上面新建了 6 个 <profile>，其中 <id>区分了不同的 <profile> 也就是构建添加不同的配置文件到项目当中，上面指定了默认的环境是 dev 也就是不通过命令指定那么默认就是 profile 就是 dev。此时构建配置文件起到了传输指定的作用，比如，通过命令行参数输入指定的 <id>。

可以通过执行命令修改 profile：

mvn package -P prod

这个时候的环境就设置成了 prod 环境。

3、Spring Boot 集成 maven 多环境

Spring Boot 项目和 maven 多环境集成有两种模式，下面我们就来分别描述一下这两种方式是如何实现的吧。

3.1 Spring Boot Profiles 与 Maven Profiles 集成

spring 内部也有自己的 profile 定义，它是通过 spring.profiles.active 这个参数来指定的。关于它我就不做过多介绍了网上的帖子很多，大家可以自行了解。

3.1.1 pom 依赖
<?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>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.5.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

    <groupId>org.example</groupId>
    <artifactId>profile-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

    <profiles>
        <!--本地环境 -->
        <profile>
            <id>local</id>
            <properties>
                <activatedProperties>local</activatedProperties>
            </properties>
        </profile>
        <!--开发环境 -->
        <profile>
            <id>dev</id>
            <properties>
                <activatedProperties>dev</activatedProperties>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <!--测试环境 -->
        <profile>
            <id>test</id>
            <properties>
                <activatedProperties>test</activatedProperties>
            </properties>
        </profile>
        <!--uat 环境 -->
        <profile>
            <id>uat</id>
            <properties>
                <activatedProperties>uat</activatedProperties>
            </properties>
        </profile>
        <!--预发布环境 -->
        <profile>
            <id>pre</id>
            <properties>
                <activatedProperties>pre</activatedProperties>
            </properties>
        </profile>
        <!--生产环境 -->
        <profile>
            <id>prod</id>
            <properties>
                <activatedProperties>prod</activatedProperties>
            </properties>
        </profile>
    </profiles>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-deploy-plugin</artifactId>
                <version>2.8.2</version>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>
3.1.2 项目结构

App 类是一个简单的 Spring Boot 项目类，它在启动成功后会打印配置文件当中配置的 env 信息
在这里插入图片描述

3.1.3 不同的配置文件

application.properties

server.port=8888
spring.profiles.active=@activatedProperties@

里面配置了服务启动的端口，最重要的是配置通过配置spring.profiles.active=@activatedProperties@ 把 spring 定义的环境与 maven 中的 profiles 结合了起来。我们通过 mvn clean package -P profile 就能够指定生效的环境。比如我们的命令是 mvn clean package -P uat 就是 application-uat.properties 生效。

下面就是代表不同环境的配置文件：

application-dev.properties

env=dev

application-local.properties

env=local

application-pre.properties

env=pre

application-prod.properties

env=prod

application-test.properties

env=test

application-uat.properties

env=uat
3.1.4 项目打包

我们以 mvn clean package -P prod 打包为例，测试打包成功的是生产环境的配置生效。

在这里插入图片描述
我们通过 Java 反编译工具可以看到 applicaiton.properties 配置文件当中的 spring.profiles.active=@activatedProperties@ 变更成我们指定的生成环境 prod。

在这里插入图片描述
然后我们再到 ${project}/taget目录里通过命令 java -jar profile-demo-1.0-SNAPSHOT.jar 运行 spring boot 项目。

在这里插入图片描述
说明我们项目当中的多环境生效的是我们指定的 prod 生产环境的配置。

3.2 Maven Profiles 直接指定资源文件

上面的方式是基于 Spring Boot 项目的特性，也有可能我们的项目并不是 Spring boot 项目。那么有没有通用的解决方案呢？答案是有的，我们可以通过 Maven Profiles 直接指定资源文件.

3.2.1 Pom 依赖
<?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>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.5.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

    <groupId>org.example</groupId>
    <artifactId>profile-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

    <profiles>
        <!--本地环境 -->
        <profile>
            <id>local</id>
            <properties>
                <activatedProperties>local</activatedProperties>
            </properties>
            <build>
                <resources>
                    <resource>
                        <directory>
                            ${project.basedir}/src/main/resources/env/local
                        </directory>
                    </resource>
                </resources>
            </build>
        </profile>
        <!--开发环境 -->
        <profile>
            <id>dev</id>
            <properties>
                <activatedProperties>dev</activatedProperties>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <build>
                <resources>
                    <resource>
                        <directory>
                            ${project.basedir}/src/main/resources/env/dev
                        </directory>
                    </resource>
                </resources>
            </build>
        </profile>
        <!--测试环境 -->
        <profile>
            <id>test</id>
            <properties>
                <activatedProperties>test</activatedProperties>
            </properties>
            <build>
                <resources>
                    <resource>
                        <directory>
                            ${project.basedir}/src/main/resources/env/test
                        </directory>
                    </resource>
                </resources>
            </build>
        </profile>
        <!--uat 环境 -->
        <profile>
            <id>uat</id>
            <properties>
                <activatedProperties>uat</activatedProperties>
            </properties>
            <build>
                <resources>
                    <resource>
                        <directory>
                            ${project.basedir}/src/main/resources/env/uat
                        </directory>
                    </resource>
                </resources>
            </build>
        </profile>
        <!--预发布环境 -->
        <profile>
            <id>pre</id>
            <properties>
                <activatedProperties>pre</activatedProperties>
            </properties>
            <build>
                <resources>
                    <resource>
                        <directory>
                            ${project.basedir}/src/main/resources/env/pre
                        </directory>
                    </resource>
                </resources>
            </build>
        </profile>
        <!--生产环境 -->
        <profile>
            <id>prod</id>
            <properties>
                <activatedProperties>prod</activatedProperties>
            </properties>
            <build>
                <resources>
                    <resource>
                        <directory>
                            ${project.basedir}/src/main/resources/env/prod
                        </directory>
                    </resource>
                </resources>
            </build>
        </profile>
    </profiles>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-deploy-plugin</artifactId>
                <version>2.8.2</version>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>
3.2.2 项目结构

App 类是一个简单的 Spring Boot 项目类，它在启动成功后会打印配置文件当中配置的 env 信息

在这里插入图片描述
这种方式就比较通用，不管是不是 Spring Boot 项目都可以采用。

3.2.3 不同的配置文件

下面就是代表不同环境的配置文件：

dev/application.properties

server.port=8888
env=dev

local/application.properties

server.port=8888
env=local

pre/application.properties

server.port=8888
env=pre

prod/application.properties

server.port=8888
env=prod

test/application.properties

server.port=8888
env=test

uat/application.properties

server.port=8888
env=uat
3.2.4 项目打包

我们以 mvn clean package -P pre 打包为例，测试打包成功的是预生产环境的配置生效。

在这里插入图片描述
我们通过反编译工具可以看到与 Spring Boot 打包了所有配置文件不同的是只有一个配置文件 application.properties，并且打包的是我们指定的 pre 预生产环境的配置文件。

在这里插入图片描述
然后我们再到 ${project}/taget目录里通过命令 java -jar profile-demo-1.0-SNAPSHOT.jar 运行 spring boot 项目。

在这里插入图片描述

carl-zhao
关注
专栏目录
Spring Boot spring-boot-maven-plugin 参数配置详解
06-17 420
默认情况下，repackage目标将使用可执行的构件来替代原始的构件。如果希望保留原是构件，并且也使用不同的分类来附属保留可执行的构件，可以配置如下：说明：如果不适用repackage目标，那么maven执行package命令生成的jar包只有一个，名称为pom.xml里面配置的name(artifactId)-version.jar。
Spring Boot项目使用maven-assembly-plugin根据不同环境打包成tar.gz或者zip
fygkchina的专栏
08-08 2303
spring-boot-assembly 在spring boot项目中使用maven profiles和maven assembly插件根据不同环境打包成tar.gz或者zip 将spring boot项目中的配置文件提取到外部config目录中 将spring boot项目中的启动jar包移动到boot目录中 将spring boot项目中的第三方依赖jar包移动到外部lib目录中 ...
Springboot Maven Profiles配置
qq_35918357的博客
04-15 3833
背景 在实际开发项目中，常常有几种环境，一般情况下最少有三种环境：开发、测试、正式，各个环境之间的参数也各不相同，于是在环境切换时我们需要修改为各环境需要的参数，就此我们可以通过maven的配置在切换环境是简化这一步骤。 实现 工程目录结构 |--- src | |--- main | | |--- resources | | | |--- application.prop...
Spring Boot Maven profile
David的博客
06-28 1257
Spring Boot Maven profile 一、配置pom.xml 配置与pom文件中与dependencies属性同级的profile <profiles> <profile> <id>dev</id> <properties> <!-- 自定义字段,这里用来代表当前环境 --> <profiles.active>dev<
SpringBoot集成Maven的profile配置
u014748504的博客
09-09 1157
一、上周知识点总结 1.1 Linux 认识Linux 虚拟机 安装VMware--创建虚拟机--安装CentOS 云主机 远程工具 xftp 文件管理 xshell 远程终端 Linux文件系统 home root etc usr Linux常用指令 文件管理 用户权限 系统操作 软件管理指令 wget
Profile之springboot、Maven
大鹏
07-17 725
什么是profile 想必大家都有这种经历，我们开发项目的时候要有多个环境，如开发环境、测试环境、生产环境，他们的配置文件一般不同，如数据库地址。当我们要向各个环境发布程序时，需要人工处理这些配置文件，这显然麻烦且易错。有了profile，一切问题就简单了。简单讲profile就是一组配置，不同profile提供不同组合的配置，程序运行时可以选择使用哪些profile来适应环境。 1. application-{profile}.properties文件 我们先来搭建一个简单的spri...
Maven管理SpringBoot Profile详解
08-28
主要介绍了Maven管理SpringBoot Profile详解,具有一定参考价值，需要的朋友可以了解下。
xmljava系统源码-spring-boot-assembly:SpringBoot项目使用maven-assembly-plugin根据不
06-06
boot项目中使用maven profiles和maven assembly插件根据不同环境打包成tar.gz或者zip 将spring boot项目中的配置文件提取到外部config目录中 将spring boot项目中的启动jar包移动到boot目录中 将spring boot项目中的...
[SpringBoot2.X]29- SpringBoot项目打包与多环境配置
最新发布
11-21
本文将详细介绍如何打包Spring Boot项目以及如何实现多环境配置。 ### 1. Spring Boot的打包插件 Spring Boot项目通常使用Maven或Gradle作为构建工具，它们都提供了方便的插件来帮助我们打包应用。对于Maven，我们...
Spring Boot Maven Plugin插件解析
娃儿回家
08-17 1628
Spring Boot Maven Plugin打包解析一. 简介二. Spring Boot Maven Plugin的引用三. Spring Boot Maven Plugin的使用1. 继承 Starter Parent POM2. 在没有 Starter Parent POM 的情况下使用 Spring Boot3. 在命令行上覆盖配置内容运行四. Spring Boot Maven Plugin中的Goals五. 打包可执行文件1. Layered Jar or War六. 打包OCI镜像 一.
Spring Boot —— Maven Profile多配置
Genius only means hard-working all one's life.
05-29 737
文章目录Spring Boot —— Maven Profile多配置前言实现步骤截图项目地址 Spring Boot —— Maven Profile多配置 前言 通过maven管理多环境，达到快速切换和部署效果。可以在Jenkins环境使用maven命令执行不同客户端，在单点Spring Boot 项目中通过Maven发布很有用！但在Cloud环境下为达到快速发布，我们使用Consul或者Do...
springboot利用maven profiles设置多环境
TAaron666的博客
07-28 744
在实际项目中通常要设置好几种环境（例如：开发dev，测试test，生产pro） 的配置文件 实现多环境两种方式： 1、 springboot profile 2、 maven profile 一、springboot profile 一个主application.properties,里面配置了工程运行环境 如果需要创建自定义的的properties文件时，可以用application-xxx.properties的命名方式： application-dev.properties applic
springboot之pom配置profiles适用于不同开发环境(亲测可用)
阿姆斯特哩的博客
12-09 1096
pom.xml <profiles> <profile> <!-- 生产环境 --> <id>prod</id> <properties> <profileActive>prod</profileActive> </properties> </profile> <profile>
springboot + maven使用profiles进行环境隔离
qq_41849234的博客
03-14 886
首先需要在pom文件增加下面的配置 pom.xml 代码片. <profiles> <profile> <id>local</id> <properties> <spring.active>local</spring.active> </properties> &
SpringBoot
P_ning的博客
03-09 97
https://gitee.com/P_n_ing/SpringBoot.git 内容 JDBC mybatis thymeleaf Servers indexandi18n interceptionandextraction
springboot 属性文件中使用 pom文件 profile 参数
weixin_43776989的博客
08-22 867
pom文件中profile参数
springboot+maven项目使用 profiles 配置多环境
weixin_42408447的博客
05-25 285
pom.xml 添加 添加多环境配置 <!-- 多环境配置 --> <profiles> <profile> <id>dev</id> <!-- 环境标识，需要与配置文件的名称相对应 --> <properties> <profiles.active>dev</profiles.a
Springboot结合Maven的profiles标签实现多环境配置
铭记：
03-27 540
Springboot结合Maven的profiles标签实现多环境配置
Spring Boot 配合Maven切换Profile
Frank的博客
05-21 537
引言 在我们的项目开发工作中，是有多种运行环境的。例如我们公司就分为：开发环境（DEV），测试环境（SIT and UAT），生产环境（PROD）。我们已经知道Spring Boot可以针对与每一个环境单独指定一个配置文件，那么如何让Spring Boot项目在不同运行环境中方便、快捷并且准确的加载对应的配置文件呢？ 实现 项目中的配置文件目录： 在Spring Boot中，Spring Boo...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值