Tomcat 快速入门

Tomcat 快速入门

简介

Tomcat 是什么

Tomcat 是由 Apache 开发的一个 Servlet 容器，实现了对 Servlet 和 JSP 的支持，并提供了作为Web服务器的一些特有功能，如Tomcat管理和控制平台、安全域管理和Tomcat阀等。
由于 Tomcat 本身也内含了一个 HTTP 服务器，它也可以被视作一个单独的 Web 服务器。但是，不能将 Tomcat 和 Apache HTTP 服务器混淆，Apache HTTP 服务器是一个用 C 语言实现的 HTTP Web 服务器；这两个 HTTP web server 不是捆绑在一起的。Tomcat 包含了一个配置管理工具，也可以通过编辑XML格式的配置文件来进行配置。

Tomcat 重要目录

• /bin - Tomcat 脚本存放目录（如启动、关闭脚本）。 *.sh 文件用于 Unix 系统； *.bat 文件用于 Windows 系统。
• /conf - Tomcat 配置文件目录。
• /logs - Tomcat 默认日志目录。
• /webapps - webapp 运行的目录。

  web 工程发布目录结构

  一般 web 项目路径结构

  |-- webapp                         # 站点根目录
    |-- META-INF                   # META-INF 目录
    |   `-- MANIFEST.MF            # 配置清单文件
    |-- WEB-INF                    # WEB-INF 目录
    |   |-- classes                # class文件目录
    |   |   |-- *.class            # 程序需要的 class 文件
    |   |   `-- *.xml              # 程序需要的 xml 文件
    |   |-- lib                    # 库文件夹
    |   |   `-- *.jar              # 程序需要的 jar 包
    |   `-- web.xml                # Web应用程序的部署描述文件
    |-- <userdir>                  # 自定义的目录
    |-- <userfiles>                # 自定义的资源文件

  webapp：工程发布文件夹。其实每个 war 包都可以视为 webapp 的压缩包。
  META-INF：META-INF 目录用于存放工程自身相关的一些信息，元文件信息，通常由开发工具，环境自动生成。
  WEB-INF：Java web应用的安全目录。所谓安全就是客户端无法访问，只有服务端可以访问的目录。
  /WEB-INF/classes：存放程序所需要的所有 Java class 文件。
  /WEB-INF/lib：存放程序所需要的所有 jar 文件。
  /WEB-INF/web.xml：web 应用的部署配置文件。它是工程中最重要的配置文件，它描述了 servlet 和组成应用的其它组件，以及应用初始化参数、安全管理约束等。

  安装

  前提条件

  Tomcat 8.5 要求 JDK 版本为 1.7 以上。
  进入 Tomcat 官方下载地址 选择合适版本下载，并解压到本地。

  Windows

  添加环境变量 CATALINA_HOME ，值为 Tomcat 的安装路径。
  进入安装目录下的 bin 目录，运行 startup.bat 文件，启动 Tomcat。

  Linux / Unix

  下面的示例以 8.5.24 版本为例，包含了下载、解压、启动操作。
  启动后，访问 http://localhost:8080 ，可以看到 Tomcat 安装成功的测试页面。
  

  配置

  本节将列举一些重要、常见的配置项。详细的 Tomcat8 配置可以参考 Tomcat 8 配置官方参考文档 。

  Server

  Server 元素表示整个 Catalina servlet 容器。 因此，它必须是 conf/server.xml 配置文件中的根元素。它的属性代表了整个 servlet 容器的特性。

属性表

Service

Service元素表示一个或多个连接器组件的组合，这些组件共享一个用于处理传入请求的引擎组件。Server 中可以有多个 Service。

属性表

实例 - conf/server.xml 配置文件示例

<?xml version="1.0" encoding="UTF-8"?>
<Server port="8080" shutdown="SHUTDOWN">
  <Service name="xxx">
  ...
  </Service>
</Server>

Executor

Executor表示可以在Tomcat中的组件之间共享的线程池。

属性表

<Service name="xxx">
  <Executor name="tomcatThreadPool" namePrefix="catalina-exec-" maxThreads="300" minSpareThreads="25"/>
</Service>

Connector

Connector代表连接组件。Tomcat 支持三种协议：HTTP/1.1、HTTP/2.0、AJP。

属性表

以下属性在标准的Connector(NIO, NIO2 和 APR/native)中有效:

Context

Context元素表示一个Web应用程序，它在特定的虚拟主机中运行。每个Web应用程序都基于Web应用程序存档（WAR）文件，或者包含相应的解包内容的相应目录，如Servlet规范中所述。

属性表

Engine

Engine元素表示与特定的Catalina服务相关联的整个请求处理机器。它接收并处理来自一个或多个连接器的所有请求，并将完成的响应返回给连接器，以便最终传输回客户端。

属性表

Host

Host元素表示一个虚拟主机，它是一个服务器的网络名称（如“www.mycompany.com”）与运行Tomcat的特定服务器的关联。

属性表

Cluster

由于在实际开发中，我从未用过Tomcat集群配置，所以没研究。

启动

部署方式

这种方式要求本地必须安装 Tomcat 。
将打包好的 war 包放在 Tomcat 安装目录下的 webapps 目录下，然后在 bin 目录下执行 startup.bat 或 startup.sh ，Tomcat 会自动解压 webapps 目录下的 war 包。
成功后，可以访问 http://localhost:8080/xxx （xxx 是 war 包文件名）。

注意 以上步骤是最简单的示例。步骤中的 war 包解压路径、启动端口以及一些更多的功能都可以修改配置文件来定制 （主要是 server.xml 或 context.xml 文件）。

嵌入式

API 方式

在 pom.xml 中添加依赖

<dependency>
  <groupId>org.apache.tomcat.embed</groupId>
  <artifactId>tomcat-embed-core</artifactId>
  <version>8.5.24</version>
</dependency>

添加 SimpleEmbedTomcatServer.java 文件，内容如下：

import java.util.Optional;
import org.apache.catalina.startup.Tomcat;
public class SimpleTomcatServer {
    private static final int PORT = 8080;
    private static final String CONTEXT_PATH = "/javatool-server";
    public static void main(String[] args) throws Exception {
        // 设定 profile
        Optional<String> profile = Optional.ofNullable(System.getProperty("spring.profiles.active"));
        System.setProperty("spring.profiles.active", profile.orElse("develop"));
        Tomcat tomcat = new Tomcat();
        tomcat.setPort(PORT);
        tomcat.getHost().setAppBase(".");
        tomcat.addWebapp(CONTEXT_PATH, getAbsolutePath() + "src/main/webapp");
        tomcat.start();
        tomcat.getServer().await();
    }
    private static String getAbsolutePath() {
        String path = null;
        String folderPath = SimpleEmbedTomcatServer.class.getProtectionDomain().getCodeSource().getLocation().getPath()
                .substring(1);
        if (folderPath.indexOf("target") > 0) {
            path = folderPath.substring(0, folderPath.indexOf("target"));
        }
        return path;
    }
}

成功后，可以访问 http://localhost:8080/javatool-server 。

说明 本示例是使用 org.apache.tomcat.embed 启动嵌入式 Tomcat 的最简示例。 这个示例中使用的是 Tomcat 默认的配置，但通常，我们需要对 Tomcat 配置进行一些定制和调优。为了加载配置文件，启动类就要稍微再复杂一些。这里不想再贴代码，有兴趣的同学可以参考： 示例项目

使用 maven 插件启动（不推荐）

不推荐理由：这种方式启动 maven 虽然最简单，但是有一个很大的问题是，真的很久很久没发布新版本了（最新版本发布时间：2013-11-11）。且貌似只能找到 Tomcat6 、Tomcat7 插件。

使用方法

在 pom.xml 中引入插件

<plugin>
  <groupId>org.apache.tomcat.maven</groupId>
  <artifactId>tomcat7-maven-plugin</artifactId>
  <version>2.2</version>
  <configuration>
    <port>8080</port>
    <path>/${project.artifactId}</path>
    <uriEncoding>UTF-8</uriEncoding>
  </configuration>
</plugin>

运行 mvn tomcat7:run 命令，启动 Tomcat。
成功后，可以访问 http://localhost:8080/xxx （xxx 是 ${project.artifactId} 指定的项目名）。

IDE 插件

常见 Java IDE 一般都有对 Tomcat 的支持。
以 Intellij IDEA 为例，提供了 Tomcat and TomEE Integration 插件（一般默认会安装）。
使用步骤

• 点击 Run/Debug Configurations > New Tomcat Server > local ，打开 Tomcat 配置页面。
• 点击 Confiure… 按钮，设置 Tomcat 安装路径。
• 点击 Deployment 标签页，设置要启动的应用。
• 设置启动应用的端口、JVM 参数、启动浏览器等。
• 成功后，可以访问 http://localhost:8080/（当然，你也可以在 url 中设置上下文名称）。

说明 个人认为这个插件不如 Eclipse 的 Tomcat 插件好用，Eclipse 的 Tomcat 插件支持对 Tomcat xml 配置文件进行配置。而这里，你只能自己去 Tomcat 安装路径下修改配置文件。

资料

• Tomcat 官方网站
• Tomcat Wiki
• Tomee 官方网站
• Creating a Web App with Bootstrap and Tomcat Embedded

  推荐

  文中的嵌入式启动示例可以参考我的示例项目