首页手记 Springboot应用的多环境打包入门教程

Springboot应用的多环境打包入门教程

标签：

SpringBoot

概述

本文介绍了如何通过配置profile和使用打包工具实现Spring Boot应用在开发、测试和生产环境中的灵活部署。文章详细讲解了如何使用Maven或Gradle进行多环境打包，并提供了实战演练和部署步骤，帮助开发者快速掌握Spring Boot应用的多环境打包技巧。

Spring Boot简介

什么是Spring Boot

Spring Boot是一个用于简化新Spring应用初始搭建及开发过程的框架。它通过约定优于配置的方式，使得开发者只需少量配置就能快速搭建一个独立运行的Spring应用。当前推荐使用的版本为Spring Boot 2.x系列，该版本提供了大量开箱即用的默认配置，解决了Spring应用中繁琐的配置问题，极大地提高了开发效率。

Spring Boot的优点

快速构建应用：Spring Boot提供了自动配置功能，开发者只需专注于业务逻辑，而无需过多关注框架的配置。
独立运行：Spring Boot应用可以作为独立的可执行jar运行，内置了Tomcat、Jetty等应用服务器，简化了部署过程。
无代码生成：无需额外的配置文件，如web.xml，因此减少了配置步骤。
简化Maven/Gradle配置：提供了默认的Maven/Gradle配置，减少了依赖管理的复杂性。
全面的自动配置：Spring Boot根据应用类路径中的jar包和类自动配置应用，简化了应用的搭建和运行。
内嵌式部署：可以生成独立的可执行jar文件，包含运行时所需的一切内容（如Tomcat、Jetty等）。

Spring Boot的核心概念

Starter依赖：Spring Boot通过Starter依赖来简化应用的依赖管理。例如，spring-boot-starter-web提供了构建Web应用所需的所有依赖。
自动配置：Spring Boot通过@SpringBootApplication注解自动配置应用，可以扫描组件并配置Spring容器。通过application.properties或application.yml配置文件，可以进一步控制自动配置的行为。
命令行接口：Spring Boot提供了一个命令行接口，可以方便地运行和调试应用，例如运行mvn spring-boot:run或gradle bootRun。
Actuator端点：Spring Boot Actuator提供了大量有助于监控和管理Spring Boot应用的端点，例如/health用于检查应用健康状况，/metrics用于查看度量信息等。

准备工作

开发环境搭建

安装Java开发工具包（JDK）
- 首先，在本地计算机上安装JDK。推荐使用JDK 8或更高版本。
- 检查JDK是否安装成功：
```
java -version
```

安装Maven或Gradle

Maven和Gradle是常用的构建工具。这里以Maven为例进行演示。

下载并安装Maven：

wget http://mirrors.estointernet.in/apache/maven/maven-3/3.8.6/binaries/apache-maven-3.8.6-bin.tar.gz
tar xvf apache-maven-3.8.6-bin.tar.gz
export MAVEN_HOME=/path/to/apache-maven-3.8.6
export PATH=$MAVEN_HOME/bin:$PATH

检查Maven安装是否成功：
```
mvn -version
```

安装IDE
- 推荐使用IntelliJ IDEA或Eclipse等IDE来开发Spring Boot应用。

创建Spring Boot项目

创建Spring Boot项目

使用Spring Initializr在线工具（https://start.spring.io/）创建项目。
输入项目名称，选择语言（Java）和依赖（Web）。
下载并解压项目，导入到IDE中。

使用命令行方式创建项目（以Maven为例）：

mvn archetype:generate -DgroupId=com.example -DartifactId=springbootdemo -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
cd springbootdemo
mvn spring-boot:run

示例：完整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>springbootdemo</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<name>springbootdemo</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.3</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</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。
- application.properties：基于键值对的配置文件，适用于简短配置。
- application.yml：使用YAML格式的配置文件，适用于更复杂的配置。
- 示例：application.properties
```
server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=secret
```
- 示例：application.yml
```
server:
port: 8080
spring:
datasource:
 url: jdbc:mysql://localhost:3306/test
 username: root
 password: secret
```

环境配置文件的使用

介绍application.yml和application.properties

配置文件的结构
- application.properties和application.yml都是基于键值对的配置文件，但格式不同。
- application.properties是基于键值对的配置文件，适用于简短配置。
- application.yml是基于YAML格式的配置文件，适用于更复杂的配置。
- 示例：application.yml
```
server:
port: 8080
spring:
datasource:
 url: jdbc:mysql://localhost:3306/test
 username: root
 password: secret
```
profile的概念
- Spring Boot通过profile来区分不同的环境，如开发环境、测试环境和生产环境。
- 可以通过spring.profiles.active属性来激活特定的环境配置。
- 例如，spring.profiles.active=dev将会激活application-dev.yml或application-dev.properties配置文件。

如何使用profile区分不同的环境

配置多个profile
- 可以在application.yml或application.properties文件中定义多个profile。
- 示例：application.yml
```
spring:
profiles:
 active: @spring.profiles.active@
```
- 在实际项目中，可以定义多个环境的配置文件，例如application-dev.yml、application-test.yml和application-prod.yml。
激活profile的方式
- 通过命令行参数激活profile：
```
mvn spring-boot:run -Dspring.profiles.active=dev
```
- 在IDE中，可以在运行配置中设置激活的profile。
- 通过环境变量激活profile，例如：
```
export SPRING_PROFILES_ACTIVE=dev
```

实际案例：配置不同环境下的数据库连接

创建多环境配置文件

创建application-dev.yml、application-test.yml和application-prod.yml三个文件。

示例：application-dev.yml

spring:
datasource:
 url: jdbc:mysql://localhost:3306/dev
 username: devuser
 password: devpass

示例：application-test.yml

spring:
datasource:
 url: jdbc:mysql://localhost:3306/test
 username: testuser
 password: testpass

示例：application-prod.yml

spring:
datasource:
 url: jdbc:mysql://remote-server:3306/prod
 username: produser
 password: prodpwd

在代码中引用配置

在Spring Boot应用中，可以通过@Value注解或@ConfigurationProperties来引用配置文件中的属性。

示例：使用@Value注解引用数据库URL

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class DataSourceConfig {
 @Value("${spring.datasource.url}")
 private String dbUrl;

 public String getDbUrl() {
     return dbUrl;
 }
}

多环境打包的实现

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

Maven打包

在pom.xml中配置多环境打包。

示例：pom.xml

<build>
 <plugins>
     <plugin>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-maven-plugin</artifactId>
         <configuration>
             <classifier>exec</classifier>
         </configuration>
     </plugin>
 </plugins>
</build>

添加profile配置

<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>

打包时指定profile：
```
mvn clean package -Pdev
```

Gradle打包
- 在build.gradle中配置多环境打包。
- 示例：build.gradle
```
bootJar {
 archiveClassifier.set('dev')
}
project.ext.profile = "dev"
```
- 打包时指定profile：
```
gradle bootJar --profile test
```

配置打包时指定环境参数

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>

Gradle配置文件

示例：build.gradle

bootJar {
 archiveClassifier.set(project.ext.profile)
}
project.ext.profile = "dev"

实战演练：打包生产环境和测试环境的Spring Boot应用

使用Maven打包生产环境
- 执行命令：
```
mvn clean package -Pprod
```
- 打包后生成的jar文件名为springbootdemo-1.0.0-exec.jar，其中-prod表示production环境。
使用Gradle打包测试环境
- 执行命令：
```
gradle bootJar --profile test
```
- 打包后生成的jar文件名为springbootdemo-1.0.0-test.jar，其中-test表示测试环境。

部署和运行

部署到不同环境的步骤

准备环境
- 确保目标环境已安装Java运行时环境（JRE）。
- 配置环境变量，确保Java命令可用。
- 确保目标环境可以访问数据库等资源。
部署应用
- 将打包好的jar文件上传到目标服务器。
- 使用命令行运行应用：
```
java -jar springbootdemo-1.0.0-exec.jar
```

启动Spring Boot应用的方式

命令行启动
- 可以使用命令行直接运行打包好的jar文件：
```
java -jar springbootdemo-1.0.0-exec.jar
```
- 可以使用Maven或Gradle运行应用：
```
mvn spring-boot:run
```
  或者
```
gradle bootRun
```
配置文件启动
- 可以通过配置文件中的spring.profiles.active属性来指定启动环境。
- 示例：application.properties
```
spring.profiles.active=prod
```

环境变量启动

可以通过设置环境变量来指定启动环境：

export SPRING_PROFILES_ACTIVE=prod
java -jar springbootdemo-1.0.0-exec.jar

管理不同环境下的日志输出

日志配置文件

可以通过application.yml或application.properties文件来配置日志输出。

示例：application.yml

logging:
level:
 root: INFO
 com.example: DEBUG

也可以指定不同的日志配置文件，例如logback-spring.xml。

示例：logback-spring.xml

<configuration>
 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
     <encoder>
         <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
     </encoder>
 </appender>

 <logger name="com.example" level="DEBUG"/>

 <root level="info">
     <appender-ref ref="STDOUT"/>
 </root>
</configuration>

根据profile配置日志
- 可以在不同的配置文件中定义不同环境的日志配置。
- 示例：application-dev.yml
```
logging:
level:
 root: DEBUG
 com.example: TRACE
```
- 示例：application-prod.yml
```
logging:
level:
 root: INFO
 com.example: WARN
```

常见问题及解决方法

配置文件加载失败的解决方法

检查配置文件路径
- 确保配置文件放置在正确的目录中，例如src/main/resources。
- 确保配置文件的命名正确，例如application.properties或application.yml。
- 确保配置文件的路径正确，例如classpath:/。
- 示例：application.properties
```
server.port=8080
```
检查配置文件的格式
- 确保配置文件的格式正确，例如application.yml中的键值对格式正确。
- 示例：application.yml
```
server:
port: 8080
```

打包时遇到的问题及解决办法

Maven打包失败

确保pom.xml文件中的依赖配置正确。
检查打包时的命令参数是否正确。

示例：pom.xml

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

示例：打包命令
```
mvn clean package -DskipTests
```

Gradle打包失败
- 确保build.gradle文件中的依赖配置正确。
- 检查打包时的命令参数是否正确。
- 示例：build.gradle
```
dependencies {
 implementation 'org.springframework.boot:spring-boot-starter-web'
}
```
- 示例：打包命令
```
gradle build
```

运行时环境变量配置错误的解决方案

检查环境变量设置
- 确保环境变量SPRING_PROFILES_ACTIVE设置正确。
- 示例：设置环境变量
```
export SPRING_PROFILES_ACTIVE=dev
```
- 示例：检查环境变量
```
echo $SPRING_PROFILES_ACTIVE
```

检查代码中引用配置的方式

确保在代码中正确引用了配置文件中的属性。

示例：使用@Value注解引用配置

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class DataSourceConfig {
 @Value("${spring.datasource.url}")
 private String dbUrl;

 public String getDbUrl() {
     return dbUrl;
 }
}

点击查看更多内容

为 TA 点赞

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

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

汪汪一只猫

手记
篇

粉丝

130

获赞与收藏

719

关注作者，订阅最新文章

阅读免费教程

后端通用面试教程

41个小节 30787 345

网络编程入门教程

20个小节 12720 239

Pandas 入门教程

25个小节 18599 341

推荐

评论

收藏

共同学习，写下你的评论



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

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

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

支付方式

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

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

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

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

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

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

作者：

免费赠送

兑换码：1111222211 复制

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

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

热搜

最近搜索清空

Springboot应用的多环境打包入门教程

Spring Boot简介

什么是Spring Boot

Spring Boot的优点

Spring Boot的核心概念

准备工作

开发环境搭建

创建Spring Boot项目

环境配置文件的使用

介绍application.yml和application.properties

如何使用profile区分不同的环境

实际案例：配置不同环境下的数据库连接

多环境打包的实现

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

配置打包时指定环境参数

实战演练：打包生产环境和测试环境的Spring Boot应用

部署和运行

部署到不同环境的步骤

启动Spring Boot应用的方式

管理不同环境下的日志输出

常见问题及解决方法

配置文件加载失败的解决方法

打包时遇到的问题及解决办法

运行时环境变量配置错误的解决方案

阅读免费教程