Springboot应用的多环境打包教程-原创手记-慕课网

概述

本文详细介绍了如何通过不同的配置文件和构建工具实现SpringBoot应用在开发、测试和生产环境中的多环境打包。内容涵盖开发环境搭建、多环境配置文件的创建和使用、以及使用Maven或Gradle进行多环境打包的具体步骤和命令。通过本文，读者可以轻松掌握如何在不同环境中进行SpringBoot应用的打包和运行。

引入Springboot多环境打包的概念

SpringBoot是一个简化Spring应用开发的框架，通过约定优于配置的方式帮助开发者快速构建独立的、生产级别的应用。然而，在实际开发中，我们往往需要在不同的环境下运行应用，比如开发环境、测试环境和生产环境。每个环境下的配置可能会有所不同，例如数据库连接信息、服务器端口等。因此，我们需要一种方法来支持多环境的配置。SpringBoot 支持通过不同的配置文件来实现多环境的配置，同时我们可以使用Maven或Gradle等构建工具来生成适用于不同环境的可执行Jar包。

准备工作：搭建开发环境

在开始编写SpringBoot应用之前，需要确保已经搭建了开发环境。以下是所需的技术栈和工具：

Java开发环境：安装JDK，建议使用最新版本的JDK 17或更高版本。
IDE：建议使用Spring Initializer或Spring Boot CLI工具来初始化项目，或者直接使用IntelliJ IDEA或Eclipse等集成开发环境。
构建工具：选择Maven或Gradle作为构建工具。如果选择Maven，确保安装了Maven并配置好环境变量；如果选择Gradle，确保安装了Gradle并配置好环境变量。
Spring Boot版本：选择一个稳定的Spring Boot版本。通常，使用最新的稳定版本会是最优选择。

接下来，我们创建一个新的Spring Boot项目。这里我们以IntelliJ IDEA为例：

打开IntelliJ IDEA，点击“File” > “New” > “Project”。
在弹出的对话框中，选择Spring Initializr，然后点击“Next”。
输入所需的项目信息（如项目名、组名和版本），选择需要的Spring Boot版本和语言（Java）。
在“Dependencies”列表中添加所需的依赖，例如Web、Test等。
点击“Next”，然后点击“Finish”完成项目创建。

项目的目录结构如下：

src
└── main
    ├── java
    │   └── com
    │       └── example
    │           └── demo
    │               ├── DemoApplication.java
    │               └── DemoApplicationTests.java
    └── resources
        ├── application.yml
        ├── application-dev.yml
        ├── application-test.yml
        └── application-prod.yml

这里，DemoApplication.java 是主启动类，而 application.yml 是默认的应用配置文件，其他环境的配置文件分别是 application-dev.yml、application-test.yml 和 application-prod.yml。

例如，在 DemoApplication.java 中，可以添加简单的启动逻辑：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

配置多环境的application.yml文件

为了支持多环境配置，我们需要在项目的src/main/resources目录下创建多个配置文件，分别为开发环境、测试环境和生产环境。每个配置文件中可以包含特定环境下的配置信息。

首先，创建四个配置文件：

application.yml：默认配置文件
application-dev.yml：开发环境配置文件
application-test.yml：测试环境配置文件
application-prod.yml：生产环境配置文件

每个配置文件中的内容如下：

# application.yml (默认配置文件)
spring:
  profiles:
    active: dev

# application-dev.yml (开发环境配置文件)
server:
  port: 8080
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb_dev
    username: root
    password: password

# application-test.yml (测试环境配置文件)
server:
  port: 8081
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb_test
    username: root
    password: password

# application-prod.yml (生产环境配置文件)
server:
  port: 8082
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb_prod
    username: root
    password: password

在 application.yml 中，我们指定了默认激活的配置文件为 dev。这表示在没有指定其他配置文件的情况下，应用将默认使用 application-dev.yml 中的配置。

使用Maven或Gradle进行多环境打包

在SpringBoot项目中，我们可以使用Maven或Gradle来构建适用于不同环境的可执行Jar包。以下是如何使用这两种构建工具进行多环境打包的步骤。

使用Maven进行打包

在使用Maven进行打包时，我们可以在构建命令中指定不同的配置文件。首先，确保项目中已经正确配置了Maven依赖。在项目的pom.xml文件中，通常会有以下内容：

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

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

要进行多环境打包，可以在命令行中使用Maven的 -Dspring.profiles.active 参数来指定激活的配置文件。例如，以下命令将生成适用于开发环境的可执行Jar包：

mvn clean package -Dspring.profiles.active=dev

生成的Jar包将位于项目的target目录下。

使用Gradle进行打包

在使用Gradle进行打包时，Gradle的构建脚本通常位于build.gradle文件中。在该文件中，我们需要配置Spring Boot插件，并指定构建任务。例如：

plugins {
  id 'org.springframework.boot' version '2.7.10'
  id 'io.spring.dependency-management' version '1.0.11.RELEASE'
  id 'java'
}

dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-web'
  testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

bootJar {
  archiveBaseName = 'demo'
  archiveVersion = '1.0.0'
}

要进行多环境打包，可以在命令行中使用Gradle的-P参数来指定激活的配置文件。例如，以下命令将生成适用于开发环境的可执行Jar包：

./gradlew bootJar -Pspring.profiles.active=dev

生成的Jar包将位于项目的build/libs目录下。

测试打包后的应用是否正常运行

为了确保生成的可执行Jar包在不同的环境下能够正常运行，我们需要在不同的环境中启动并测试应用。

启动开发环境应用

在开发环境的配置文件application-dev.yml中，已经指定了端口为8080。运行生成的开发环境Jar包：

java -jar target/demo-1.0.0.jar --spring.profiles.active=dev

访问 http://localhost:8080，查看应用是否正常。

启动测试环境应用

在测试环境的配置文件application-test.yml中，已经指定了端口为8081。运行生成的测试环境Jar包：

java -jar target/demo-1.0.0.jar --spring.profiles.active=test

访问 http://localhost:8081，查看应用是否正常。

启动生产环境应用

在生产环境的配置文件application-prod.yml中，已经指定了端口为8082。运行生成的生产环境Jar包：

java -jar target/demo-1.0.0.jar --spring.profiles.active=prod

访问 http://localhost:8082，查看应用是否正常。

总结与常见问题解答

通过上述步骤，我们已经成功地搭建了一个多环境配置的SpringBoot项目，并使用Maven或Gradle生成了适用于不同环境的可执行Jar包。每个环境的配置文件中包含了特定环境下的配置信息，通过激活不同的配置文件，可以确保应用在不同环境下使用正确的配置。

常见问题解答

如何更改默认激活的配置文件？

在application.yml文件中，可以通过修改spring.profiles.active属性来设置默认激活的配置文件。
如何在运行应用时动态切换配置文件？

在启动应用时，可以通过命令行参数--spring.profiles.active来指定激活的配置文件，例如：
```
java -jar target/demo-1.0.0.jar --spring.profiles.active=dev
```
如果应用运行时需要根据环境动态切换配置，但忘记在命令行中指定--spring.profiles.active参数怎么办？

如果忘记指定--spring.profiles.active参数，应用将使用默认配置文件application.yml中指定的环境配置。如果默认配置文件中没有指定环境，应用将默认使用dev环境配置。
在实际的生产环境中，如何管理不同的配置文件？

在生产环境中，通常不会将配置文件直接放在代码库中，而是从外部配置文件管理工具（如Spring Cloud Config、Consul或Vault）中读取配置。这样可以确保配置文件的安全性和灵活性。

通过这种方式，SpringBoot项目可以轻松地适应不同环境的需求，并确保应用在不同环境下能够稳定运行。