Spring Boot应用部署到外部Tomcat容器实战

最新推荐文章于 2025-06-22 10:27:11 发布

西域情歌

最新推荐文章于 2025-06-22 10:27:11 发布

阅读量1k

点赞数 27

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/weixin_42527589/article/details/148646277

本文还有配套的精品资源，点击获取

简介：Spring Boot简化了创建独立、生产级的Spring应用程序的过程，而Tomcat作为开源Web服务器和Servlet容器，广泛用于部署Java Web应用。本资源详细介绍了如何将Spring Boot应用以WAR包形式部署到外部Tomcat服务器上，涵盖从创建WAR包、配置Tomcat、部署应用到启动管理等实战操作，并考虑了安全性、性能优化、日志管理等生产环境因素。同时，对于大型项目，还提到了利用CI/CD工具自动化部署的过程。 springboot部署到外部tomcat容器.rar

1. Spring Boot与Tomcat简介

1.1 Spring Boot概述

1.1.1 Spring Boot的特点与优势

Spring Boot是一种约定优于配置的Java框架，旨在简化新Spring应用的初始搭建以及开发过程。其最大的优势在于快速开发和独立运行。由于集成了大量的Starter POMs，Spring Boot能够自动配置项目中常用的模块，从而让开发者专注于业务逻辑的开发。

1.1.2 Spring Boot与传统Spring框架的区别

与传统的Spring框架相比，Spring Boot消除了繁复的XML配置，取而代之的是更为直观的注解和Java配置类。它的内嵌服务器（如Tomcat, Jetty或Undertow）使得开发出的Spring应用无需部署到外部的Servlet容器即可运行，大幅提高了开发效率和便捷性。

2. WAR包与JAR包的区别

2.1 WAR包与JAR包基础

2.1.1 WAR包的结构与特点

WAR（Web Application Archive）包是Java EE规范中用于分发和部署Web应用的一种文件格式，它包含了所有的web资源，比如Servlet、JSP、JavaScript文件、HTML文件、图片以及其他Web应用程序所需的所有资源。

WAR文件的目录结构通常遵循以下格式：

/META-INF
    /MANIFEST.MF
/WEB-INF
    web.xml
    /classes
    /lib
/assets

其中， /WEB-INF 目录是核心目录，包含了部署描述符 web.xml ，可选的Java类和库文件等。 /META-INF/MANIFEST.MF 文件包含了该包的元数据信息。而 /assets 目录一般用于存放静态资源。

2.1.2 JAR包的结构与特点

JAR（Java Archive）文件是一个压缩包，用于将Java类文件和相关的元数据和资源文件打包成单个文件，便于分发和部署。JAR文件也可以包含一个清单文件（Manifest），其中可以指定主类，用于命令行运行。

JAR文件的目录结构通常比WAR简洁，主要包括：

/META-INF
    /MANIFEST.MF
/src
    ... Java源文件 ...
/lib
    ... jar包依赖的库文件 ...

JAR包适用于常规Java应用程序或库的打包。

2.2 Spring Boot构建WAR包的优势

2.2.1 针对Web应用的优化

Spring Boot通过内嵌Tomcat、Jetty或Undertow服务器，让开发者能够快速开发并运行Web应用程序。然而，对于需要使用传统Java EE容器（如Tomcat）部署的生产环境，Spring Boot提供了一种方式通过WAR包的形式部署。

依赖分离 ：WAR包可以将应用依赖和Servlet容器依赖分离，使得部署时不需要将应用服务器作为依赖一起部署，减轻部署包的大小。
更好的整合性 ：在传统的Java EE应用服务器中，Spring Boot应用可以更深入地利用服务器提供的特定服务和特性。

2.2.2 传统JAR包在Web环境中的限制

传统的Spring Boot JAR包运行在内嵌的Servlet容器中，这在很多情况下简化了开发和测试流程。然而，一旦需要迁移到专门的Servlet容器，如Tomcat，JAR包模式会有一些限制：

资源访问问题 ：JAR包的运行方式可能导致应用访问外部资源时出现问题，如文件系统访问。
应用监控困难 ：无法像WAR包一样在容器中进行应用监控和管理。

2.3 选择合适包类型的实际场景

2.3.1 开发小型应用与微服务的考量

对于小型应用和微服务架构，使用JAR包进行部署有明显优势：

快速启动 ：因为不需要部署到外部的Servlet容器，JAR包的启动速度更快。
简单配置 ：内嵌的容器简化了配置过程，特别是在自动化部署和容器化技术日益流行的今天。

2.3.2 大型企业级应用的部署选择

大型企业级应用往往需要考虑以下因素：

应用兼容性 ：WAR包更容易与企业现有的Web服务器集成。
集中监控和管理 ：部署为WAR包的应用更容易在应用服务器提供的监控工具中进行集中管理和监控。

在做出选择之前，需要根据应用的规模、资源访问需求、管理复杂度等多个维度进行综合考虑。

以上便是WAR包与JAR包在基础结构、Spring Boot构建中的优势以及选择合适包类型的实际场景分析。在下一章节，我们将具体介绍Spring Boot如何创建WAR包，并详细阐述打包的具体步骤与操作细节。

3. Spring Boot WAR包创建步骤

3.1 Spring Boot项目结构与依赖配置

3.1.1 Maven与Gradle构建工具的配置

在创建Spring Boot项目时，大多数开发者倾向于使用Maven或Gradle这样的构建工具。这些构建工具极大地简化了依赖管理、项目构建和生命周期管理。下面是使用Maven和Gradle进行项目配置的基础示例：

Maven配置：

Maven通过 pom.xml 文件管理项目依赖、插件配置以及项目构建的生命周期。下面是一个Maven的 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>springboot-war</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.0</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 其他依赖项 -->
    </dependencies>
    <!-- 插件配置 -->
</project>

在这个配置文件中， <packaging> 标签定义了项目打包的类型为WAR，表明这是一个Web应用的包。此外，通过 <parent> 标签来指定Spring Boot的父项目版本，保证依赖项的版本兼容性。

Gradle配置：

Gradle使用 build.gradle 文件来配置项目，与Maven相比，Gradle的配置文件更倾向于使用Groovy语言，提供了更高的灵活性。下面是一个基础的 build.gradle 文件配置示例：

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

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    // 其他依赖项
}

bootJar {
    archiveFileName = 'springboot-war.jar'
}

bootWar {
    enabled = true
}

在此配置中， bootWar 选项被设置为 true ，告诉Gradle构建一个WAR包而不是默认的JAR包。这对于部署到Web服务器如Tomcat来说是必须的。

3.1.2 依赖管理与排除自动配置

在Spring Boot项目中，依赖管理是自动的，但有时候需要排除某些依赖项的自动配置。在Maven中，可以通过 <dependencyManagement> 部分管理依赖项的版本，而具体排除可以通过 <exclusions> 标签实现。以下是排除特定依赖项的自动配置的示例：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>

上述配置将排除 spring-boot-starter-web 中默认包含的Tomcat依赖，这在生成WAR包时是必须的，因为WAR包将由外部服务器如Tomcat管理。

使用Gradle时，可以添加如下配置来排除依赖：

configurations {
    compileOnly 'org.springframework.boot:spring-boot-starter-tomcat:2.5.0'
}

dependencies {
    compileOnly 'org.springframework.boot:spring-boot-starter-web'
    // 其他依赖项
}

这里， compileOnly 配置项告诉Gradle，某个依赖项仅仅在编译时需要，运行时则不需要，这有助于控制最终的WAR包大小。

接下来，我们将深入了解如何通过具体的Maven插件和Gradle任务来配置打包WAR包的细节。

4. Tomcat服务器安装与配置

4.1 Tomcat的安装过程

4.1.1 下载与解压

Tomcat服务器是一种流行的开源Servlet容器，用于Java Servlet和JavaServer Pages（JSP）技术的应用服务器。安装Tomcat的第一步是从官方网站下载最新版本的压缩包。下载完成后，使用压缩工具对文件进行解压，并选择一个适当的目录存放解压后的文件。在安装过程中需要注意文件系统的权限设置，确保Tomcat有足够的权限来读写配置文件和日志。

# 以下命令展示了如何在Linux环境下解压Tomcat
tar -xvzf apache-tomcat-<version>.tar.gz -C /usr/local

4.1.2 环境变量设置与初始化

设置环境变量对于确保Tomcat可以正确运行是至关重要的。环境变量包括JAVA_HOME和CATALINA_HOME。JAVA_HOME应该指向Java开发工具包（JDK）的安装路径，而CATALINA_HOME应该设置为Tomcat安装目录的路径。

# 设置JAVA_HOME和CATALINA_HOME的示例
export JAVA_HOME=/path/to/your/jdk
export CATALINA_HOME=/path/to/apache-tomcat

设置完毕后，可以通过启动Tomcat来验证环境变量设置是否正确。

# 启动Tomcat服务器的命令
${CATALINA_HOME}/bin/startup.sh

4.2 Tomcat的配置详解

4.2.1 server.xml配置文件核心设置

Tomcat的主配置文件是 server.xml 。该文件定义了服务器的主干和组件，包括连接器（Connector）、引擎（Engine）、主机（Host）和上下文（Context）。重要配置包括端口设置、连接器配置、以及主机与应用上下文的设置。

<Connector port="8080" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443" />

4.2.2 context.xml与web.xml配置

context.xml文件通常用于设置所有部署在服务器上的应用共享的配置。而web.xml文件定义了单个Web应用的配置。在context.xml中可以配置资源、数据库连接池以及应用级别的安全性设置。web.xml则定义了Servlet初始化参数、欢迎文件列表以及各种监听器和过滤器的配置。

<!-- context.xml中的资源链接示例 -->
<Resource name="jdbc/MyDB"
          auth="Container"
          type="javax.sql.DataSource"
          maxActive="100"
          maxIdle="30"
          maxWait="10000"
          username="username"
          password="password"
          driverClassName="com.mysql.jdbc.Driver"
          url="jdbc:mysql://localhost:3306/mydb"/>

4.2.3 端口与安全配置

端口配置用于定义Tomcat监听的端口号。安全配置则包括SSL/TLS的配置、用户认证、以及访问控制列表（ACL）的设置。端口配置通常在server.xml中的Connector元素进行设置，而安全配置通常在server.xml的部分配置，以及web.xml中进行用户角色和访问权限的定义。

4.3 Tomcat管理与监控工具的使用

4.3.1 Tomcat Manager的安装与配置

Tomcat Manager是一个web应用，它允许用户远程部署、管理和监控运行在Tomcat服务器上的应用。安装Tomcat Manager通常需要将manager应用部署到Tomcat中，并在server.xml文件中添加相应的元素。

<Context docBase="path/to/tomcat-manager" privileged="true" />

4.3.2 监控与日志查看

监控Tomcat服务器的性能和健康状态是保证应用稳定运行的关键。除了使用Tomcat Manager，还可以通过查看日志文件来监控应用的运行情况。Tomcat提供了一系列的日志文件，包括catalina.out、localhost.yyyy-mm-dd.log等，这些日志文件记录了应用的启动、停止、错误以及其他相关信息。

通过以下命令可以查看实时日志输出：

tail -f ${CATALINA_HOME}/logs/catalina.out

在上述命令中，我们利用了 tail 命令的 -f 参数来实时跟踪日志文件的更新。

以上是本章节中关于Tomcat服务器安装与配置的详细步骤和注意事项。下一章节将会介绍Spring Boot应用如何打包成WAR包，以及如何部署到Tomcat服务器上。

5. Spring Boot应用部署到Tomcat

5.1 WAR包部署流程

5.1.1 Tomcat部署目录与权限设置

在将Spring Boot应用打包为WAR包并部署到Tomcat服务器之前，需要确保Tomcat的部署目录有正确的权限设置。Tomcat的默认部署目录通常是 <Tomcat安装目录>/webapps 。确保运行Tomcat的用户（例如 tomcat ）拥有对这个目录的读写权限，以便能够部署新的WAR文件并对其执行操作。

下面是一个简单的示例，展示如何使用Linux命令行来设置权限：

# 假设Tomcat安装在 /opt/tomcat 目录下
sudo chown -R tomcat:tomcat /opt/tomcat/webapps
sudo chmod -R 755 /opt/tomcat/webapps

这里使用 chown 命令改变文件所有者和组为 tomcat 用户和组， chmod 命令则设置目录的读写权限，以确保Tomcat能够正常操作部署的WAR包。

5.1.2 部署WAR包到Tomcat

部署WAR包到Tomcat涉及到将WAR文件复制到Tomcat的 webapps 目录下。在复制完成后，Tomcat会自动部署应用，这时可以通过访问Tomcat的管理界面或直接通过URL来检查应用是否已经正确部署。

下面是将WAR包 myapp.war 部署到Tomcat的步骤：

将WAR文件放置在Tomcat的 webapps 目录下：

# 假设Tomcat安装在 /opt/tomcat 目录下
cp myapp.war /opt/tomcat/webapps/

启动或重启Tomcat服务器：

# 使用Tomcat的bin目录下的启动脚本启动Tomcat
/opt/tomcat/bin/startup.sh

确认部署状态：

可以在浏览器中访问 http://localhost:8080/myapp 来检查应用是否部署成功。若显示应用的首页，则部署成功。

5.2 启动与停止Spring Boot应用

5.2.1 Tomcat启动流程解析

Tomcat启动流程涉及读取配置文件、初始化服务器组件以及加载和启动部署在其中的Web应用程序。流程主要分为以下几个步骤：

读取配置文件 ：Tomcat启动时首先会读取位于 <Tomcat安装目录>/conf 目录下的配置文件，主要包括 server.xml 、 context.xml 以及 web.xml 。
初始化Catalina（Servlet容器） ：Catalina是Tomcat的Servlet容器，负责处理所有的请求。
加载和启动应用 ：Tomcat会遍历 webapps 目录，为每一个部署的WAR包创建一个对应的 Context 对象，并加载这个Web应用程序。
监听端口 ：Tomcat启动后，会监听配置文件中定义的端口，等待外部的HTTP请求。

5.2.2 应用的启动、停止与重启操作

在实际的运维过程中，需要能够灵活地控制Tomcat的启动、停止与重启，这些操作可以通过以下方式实现：

启动Tomcat ：

# 在Tomcat的bin目录下
./startup.sh

停止Tomcat ：

# 在Tomcat的bin目录下
./shutdown.sh

重启Tomcat ：

重启Tomcat实际上是先停止Tomcat再启动它的过程。在某些情况下，例如配置文件更新后，需要重启Tomcat以使更改生效。可以通过执行下面的脚本来重启：

./shutdown.sh
sleep 10  # 等待足够的时间确保Tomcat完全停止
./startup.sh

使用 sleep 命令确保Tomcat完全停止是一个简单的预防措施，避免因为Tomcat还未完全停止就立即启动而导致的问题。

5.3 常见部署问题排查与解决

5.3.1 日志分析与错误诊断

Tomcat日志是排查部署问题的首要资源。日志文件通常位于 <Tomcat安装目录>/logs 目录下，包括 catalina.out 和 localhost.log 等。这些日志文件记录了Tomcat的启动信息、应用部署过程以及运行时的错误信息。

查看Tomcat日志 ：

tail -f /opt/tomcat/logs/catalina.out

使用 tail -f 命令可以实时查看日志文件中的最新信息，对于发现和解决部署过程中的问题十分有用。

5.3.2 解决部署过程中的常见问题

在部署Spring Boot应用到Tomcat时，可能会遇到一系列的问题，例如权限不足、端口冲突、配置错误等。以下是一些常见的问题和解决方法：

权限不足 ：确保运行Tomcat的用户拥有对所有相关目录和文件的适当权限。
端口冲突 ：检查Tomcat配置文件中的端口设置，确保没有和其他服务冲突。
配置错误 ：确认 context.xml 和 server.xml 等配置文件中设置正确，无语法错误。
应用依赖问题 ：确保所有外部依赖都已经正确地添加到项目的 lib 目录或正确配置了依赖项。

通过仔细检查上述方面，大多数部署问题都可以得到及时有效的解决。

6. 环境变量设置与server.xml配置

环境变量和Tomcat服务器的 server.xml 配置是应用部署和服务器管理中的关键组成部分。它们不仅对系统性能有着直接的影响，还与系统的安全性息息相关。本章将详细介绍环境变量的作用、 server.xml 文件的深入配置，以及如何进行性能优化和安全性配置。

6.1 环境变量在部署中的作用

6.1.1 配置环境变量的重要性

环境变量提供了在操作系统级别控制软件行为的一种方式。它们能够影响应用的执行环境，以及应用与系统资源的交互方式。合理地设置环境变量，可以提升应用性能，确保应用的正确执行，同时也为应用的安全性提供了保障。

6.1.2 常用环境变量的设置方法

操作系统通常提供了命令行工具来设置环境变量。在Windows系统中，可以在系统的"系统属性"→"高级"→"环境变量"中设置；而在类Unix系统中，可以使用 export 命令来设置环境变量。

例如，设置Java应用的运行时路径：

export JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk
export PATH=$JAVA_HOME/bin:$PATH

6.2 server.xml文件深入解析

server.xml 是Tomcat的主配置文件，通过该文件的配置可以对Tomcat服务器进行深入的定制。

6.2.1 Connector与Engine配置详解

在 server.xml 中， <Connector> 元素用于配置服务器监听客户端请求的端口，以及与连接相关的参数。而 <Engine> 元素代表整个Servlet引擎，用于处理来自 <Connector> 的请求。

例如，配置HTTP连接器以监听8080端口：

<Connector port="8080" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443" />

6.2.2 Host与Context配置细节

<Host> 元素定义了一个虚拟主机，而 <Context> 元素则定义了一个Web应用的配置信息。在部署Spring Boot应用时，通常需要正确配置这些元素以确保应用能够被正确识别和访问。

配置一个虚拟主机和Web应用示例：

<Host name="localhost"  appBase="webapps"
      unpackWARs="true" autoDeploy="true">

    <Context path="/myapp" docBase="path/to/myapp.war" />
</Host>

6.3 性能优化与安全性配置

性能优化和安全性配置是确保Web应用稳定运行和防止未授权访问的关键。

6.3.1 连接器优化设置

连接器配置包括对线程池和网络参数的调整，这些都是提升Tomcat性能的关键因素。通过合理配置 <Connector> 元素中的参数，如 maxThreads , minSpareThreads , acceptCount 等，可以优化处理请求的能力。

例如，增加最大线程数以处理更多并发请求：

<Connector port="8080" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443"
           maxThreads="150" minSpareThreads="25" acceptCount="100"/>

6.3.2 安全配置策略与实践

在安全性方面，除了设置合理的环境变量外， server.xml 中还可以配置安全相关的参数。例如，可以配置SSL/TLS，以及设置安全的认证方式。

配置SSL连接器，以启用HTTPS：

<Connector port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol"
           maxThreads="150" scheme="https" secure="true" SSLEnabled="true"
           keystoreFile="conf/localhost-rsa.jks" keystorePass="password"
           clientAuth="false" sslProtocol="TLS"/>

通过本章的介绍，您应该了解到了环境变量设置的重要性和具体操作方法，以及 server.xml 配置的细节，并掌握了一些性能优化和安全配置的策略。这些知识将对您在部署和管理Spring Boot应用时提供帮助。在下一章中，我们将探讨应用的安全性、性能优化和日志管理策略。

本文还有配套的精品资源，点击获取