首页手记 Springboot应用的多环境打包学习

Springboot应用的多环境打包学习

标签：

SpringBoot

概述

本文将详细介绍如何在Spring Boot应用中进行多环境打包，包括环境配置文件的创建与使用、打包命令参数配置以及部署应用时的环境切换方法。通过学习，你将能够掌握Springboot应用的多环境打包学习。

Spring Boot简介及环境搭建

Spring Boot简介

Spring Boot 是由 Pivotal 团队提供的基于 Spring 平台的微服务开发框架。它极大地简化了基于 Spring 的应用开发过程。Spring Boot 可以独立运行，提供了一整套脚手架功能，能够自动配置，开箱即用。开发者无需定义大量的 XML 或者注解进行配置，只需将主要的精力放在编写业务代码上。

Spring Boot 通过约定优于配置的思想，使开发者能够在极短的时间内快速搭建一个基于 Spring 的应用。它提供的自动配置功能能够根据在application.properties或者application.yml文件中的配置自动完成环境配置。此外，Spring Boot 还能够很好地与 Spring Cloud、Spring Data、Spring Security 等多个 Spring 生态系统项目进行整合，实现微服务架构下的应用开发。

Spring Boot 提供了多种启动器（Starter），如 Spring Web、Spring Data JPA、Spring Security 等，通过引入这些启动器可以快速地添加所需的依赖，避免手动声明每一个依赖项。

开发环境搭建

安装 JDK
- 确保已经安装了 JDK 8 或更高版本，JDK 是 Spring Boot 应用运行的基础。
- 如果没有安装，可以从 Oracle 官网下载 JDK，或使用 OpenJDK。
安装 IDE
- 推荐使用 IntelliJ IDEA 或 Eclipse，它们都提供了对 Spring Boot 的良好支持。
- 路径：File -> New -> Project，选择 Spring Initializr。
创建 Spring Boot 项目
- 使用 Spring Initializr 创建一个新的 Spring Boot 项目。
- 在 Spring Initializr 中选择所需的依赖项，如 Web、Actuator 等。
- 下载并导入项目到本地 IDE 中。
安装 Maven 或 Gradle
- Maven 或 Gradle 是构建工具，用于管理项目的依赖和构建过程。
- Maven 路径：File -> Settings -> Build, Execution, Deployment -> Build Tools -> Maven
- Gradle 路径：File -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle

创建 Spring Boot 项目后，项目目录结构如下：

spring-boot-app/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com.example.demo/
│   │   │       ├── DemoApplication.java
│   │   │       └── controller/
│   │   │           └── HelloController.java
│   │   └── resources/
│   │       ├── application.properties
│   │       └── application.yml
│   └── test/
│       └── java/
│           └── com.example.demo/
│               └── DemoApplicationTests.java
└── pom.xml

DemoApplication.java：应用主类，包含 @SpringBootApplication 注解。
HelloController.java：一个简单的控制器类。
application.properties：默认配置文件。
pom.xml：Maven 构建文件。

示例代码

创建一个简单的 Spring Boot 应用：

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);
    }
}

HelloController.java

package com.example.demo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @GetMapping("/")
    public String home() {
        return "Hello, World!";
    }
}

pom.xml

<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>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <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>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

多环境配置文件的创建与使用

配置文件的基本结构

Spring Boot 支持多种格式的配置文件，如 application.properties 和 application.yml。这些配置文件通常位于 src/main/resources 目录下。

配置文件的基本结构如下：

application.properties

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/db
spring.datasource.username=root
spring.datasource.password=root

application.yml

server:
  port: 8080
spring:
  datasource:
  url: jdbc:mysql://localhost:3306/db
  username: root
  password: root

创建多环境配置文件

为了方便管理不同的环境配置，Spring Boot 支持将不同环境的配置文件分开存放，并通过 spring.profiles.active 属性来指定当前激活的环境。常见的环境包括 dev（开发环境）、test（测试环境）和 prod（生产环境）。

1. 创建环境配置文件

在 src/main/resources 目录下创建以下文件：

application-dev.properties
application-test.properties
application-prod.properties

2. 示例配置文件

application-dev.properties

server.port=8081
spring.datasource.url=jdbc:mysql://localhost:3306/devdb
spring.datasource.username=root
spring.datasource.password=root

application-test.properties

server.port=8082
spring.datasource.url=jdbc:mysql://localhost:3306/testdb
spring.datasource.username=root
spring.datasource.password=root

application-prod.properties

server.port=8083
spring.datasource.url=jdbc:mysql://localhost:3306/proddb
spring.datasource.username=root
spring.datasource.password=root

3. 激活环境配置文件

在 application.properties 或 application.yml 文件中指定激活的环境：

application.properties

spring.profiles.active=dev

application.yml

spring:
  profiles:
  active: dev

这样，Spring Boot 会根据 spring.profiles.active 的值来加载对应的环境配置文件。

配置文件的加载顺序与原理

加载顺序详解

Spring Boot 在启动时会按照一定的顺序加载配置文件。加载顺序如下：

bootstrap.properties 或 bootstrap.yml：此配置文件主要用来配置外部属性，如 Spring Cloud Config 服务器的地址。
application-{profile}.properties 或 application-{profile}.yml：针对不同环境的配置文件，其中 {profile} 是指定的环境名称，如 dev、test、prod。
application.properties 或 application.yml：默认配置文件。
application-{profile}.properties 或 application-{profile}.yml：再次加载针对不同环境的配置文件，覆盖默认配置文件中的相同配置。
application.properties 或 application.yml：再次加载默认配置文件，覆盖之前加载的所有配置。

加载原理介绍

Spring Boot 在启动时会创建一个 Environment 对象，并通过 PropertySources 来管理配置来源。配置来源包括：

System：系统属性和环境变量。
PropertySource：bootstrap.properties 或 bootstrap.yml。
PropertySource：application-{profile}.properties 或 application-{profile}.yml。
PropertySource：application.properties 或 application.yml。
PropertySource：application-{profile}.properties 或 application-{profile}.yml。
PropertySource：application.properties 或 application.yml。

Spring Boot 会按照上述顺序将配置加载到 Environment 对象中，从而为应用提供环境配置。

多环境打包的实现步骤

打包命令参数配置

Spring Boot 提供了多种命令行参数来控制打包过程。常用的打包命令包括：

mvn clean package：使用 Maven 打包。
gradle clean assemble：使用 Gradle 打包。

要在打包时指定激活的环境，可以使用 spring.profiles.active 参数：

Maven

mvn clean package -Dspring.profiles.active=dev

Gradle

./gradlew clean assemble -Dspring.profiles.active=dev

构建多环境的Maven/Gradle配置

可以使用 Maven 或 Gradle 的配置文件来管理不同的环境打包。

1. Maven

可以在 pom.xml 文件中为不同的环境配置不同的激活条件：

<profiles>
    <profile>
        <id>dev</id>
        <properties>
            <spring.profiles.active>dev</spring.profiles.active>
        </properties>
    </profile>
    <profile>
        <id>test</id>
        <properties>
            <spring.profiles.active>test</spring.profiles.active>
        </properties>
    </profile>
    <profile>
        <id>prod</id>
        <properties>
            <spring.profiles.active>prod</spring.profiles.active>
        </properties>
    </profile>
</profiles>

2. Gradle

可以在 build.gradle 文件中为不同的环境配置不同的激活条件：

def getActiveProfile() {
    def activeProfile = System.getenv('SPRING_PROFILES_ACTIVE')
    if (activeProfile == null) {
        activeProfile = System.getProperty('spring.profiles.active')
    }
    return activeProfile
}

task dev(type: Jar) {
    manifest {
        attributes('Spring-Profile': 'dev')
    }
}

task test(type: Jar) {
    manifest {
        attributes('Spring-Profile': 'test')
    }
}

task prod(type: Jar) {
    manifest {
        attributes('Spring-Profile': 'prod')
    }
}

jar.into('META-INF') {
    from('src/main/resources')
}

bootJar {
    archiveBaseName = 'spring-boot-app'
    archiveVersion = '1.0.0'
    archiveClassifier = ''
    archiveExtension = 'jar'

    if (getActiveProfile() == 'dev') {
        manifest {
            attributes('Spring-Profile': 'dev')
        }
    } else if (getActiveProfile() == 'test') {
        manifest {
            attributes('Spring-Profile': 'test')
        }
    } else if (getActiveProfile() == 'prod') {
        manifest {
            attributes('Spring-Profile': 'prod')
        }
    }
}

bootRun {
    systemProperty 'spring.profiles.active', getActiveProfile()
}

打包后的应用部署及环境切换

应用部署步骤

打包应用

使用 Maven 或 Gradle 打包应用：

mvn clean package -Dspring.profiles.active=dev

或

./gradlew clean assemble -Dspring.profiles.active=dev

部署应用

将打包后的 JAR 文件部署到目标服务器。
```
java -jar target/spring-boot-app-1.0.0.jar
```

环境切换方法

为了方便切换不同环境，可以在启动应用时通过命令行参数指定激活的环境：

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

也可以在部署脚本中动态切换环境：

if [ "$ENV" == "prod" ]; then
    java -jar target/spring-boot-app-1.0.0.jar --spring.profiles.active=prod
elif [ "$ENV" == "test" ]; then
    java -jar target/spring-boot-app-1.0.0.jar --spring.profiles.active=test
else
    java -jar target/spring-boot-app-1.0.0.jar --spring.profiles.active=dev
fi

常见问题及解决方法

配置文件丢失或错误

问题描述

配置文件丢失或错误，导致应用启动失败。

解决方法

检查配置文件路径：确保配置文件路径正确，通常位于 src/main/resources 目录下。
检查配置文件内容：确保配置文件内容正确，没有语法错误。
检查激活环境：确保 spring.profiles.active 属性值正确，且配置文件存在。

打包失败解决方案

问题描述

打包时出现失败，如依赖冲突、配置错误等。

解决方法

检查依赖配置：确保 pom.xml 或 build.gradle 中的依赖配置正确。
清理项目：运行 mvn clean 或 ./gradlew clean 清理项目。
更新依赖：更新依赖版本，解决依赖冲突。

例如，如果依赖冲突导致打包失败，可以在 pom.xml 中使用 <dependencyManagement> 来管理依赖版本：


<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.3.0.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
``

通过上述方法，可以有效地解决 Spring Boot 应用的多环境打包问题。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

元芳怎么了

手记
篇

粉丝

5

获赞与收藏

21

关注作者，订阅最新文章

阅读免费教程

后端通用面试教程

41个小节 30936 346

网络编程入门教程

20个小节 12729 240

Pandas 入门教程

25个小节 18626 342

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

Springboot应用的多环境打包学习

Spring Boot简介

开发环境搭建

示例代码

配置文件的基本结构

创建多环境配置文件

1. 创建环境配置文件

2. 示例配置文件

3. 激活环境配置文件

加载顺序详解

加载原理介绍

打包命令参数配置

构建多环境的Maven/Gradle配置

1. Maven

2. Gradle

应用部署步骤

环境切换方法

配置文件丢失或错误

问题描述

解决方法

打包失败解决方案

问题描述

解决方法

阅读免费教程