3.5 Tomcat 虚拟主机配置

3.5 Tomcat 虚拟主机配置

3.5 Tomcat 虚拟主机配置

在深入了解 Tomcat 的安装与配置之后，虚拟主机配置是提升 Tomcat 服务器应用灵活性的关键一步。通过虚拟主机，我们可以在 同一台 Tomcat 服务器上托管多个独立的网站或应用程序，每个网站或应用程序都拥有独立的域名和配置，如同运行在独立的服务器上一般。这不仅能有效利用服务器资源，还能简化多站点管理和维护。

3.5.1 虚拟主机概述

虚拟主机（Virtual Host）是一种在单一服务器或服务器集群上运行多个网站的技术。在 Web 服务器领域，虚拟主机允许管理员使用 同一个 Web 服务器、同一个 IP 地址，甚至 同一个端口号，来托管和运行多个不同的网站。每个网站都拥有独立的域名，用户通过不同的域名访问时，会被路由到不同的网站内容。

虚拟主机的优势：

• 资源节约: 显著降低硬件成本，无需为每个网站单独配置服务器。

• 易于管理: 集中管理多个网站，简化维护和更新流程。

• 提高效率: 快速部署和扩展网站，无需复杂的服务器配置。

• 灵活性: 可以根据需求灵活配置每个虚拟主机的资源和特性。

Tomcat 中的虚拟主机:

在 Tomcat 中，虚拟主机是通过配置 <Host> 元素来实现的。每个 <Host> 元素代表一个虚拟主机，可以配置不同的域名、应用程序根目录、日志文件等。Tomcat 会根据用户请求的域名，将请求路由到相应的 <Host> 进行处理。

虚拟主机的类型 (在 Tomcat 中主要关注域名型):

虽然理论上虚拟主机可以基于 IP 地址、端口号或域名进行区分，但在 Tomcat 环境下，我们主要关注 基于域名的虚拟主机。因为通常情况下，我们的 Tomcat 服务器只有一个公网 IP 地址，而需要托管多个域名不同的网站。

• 基于域名的虚拟主机 (Name-based Virtual Hosts): 最常见的类型。通过配置不同的域名与不同的 <Host> 元素关联，Tomcat 根据请求头中的 Host 字段来识别访问哪个虚拟主机。

• 基于 IP 地址的虚拟主机 (IP-based Virtual Hosts): 需要服务器拥有多个公网 IP 地址。每个 IP 地址对应一个虚拟主机。Tomcat 根据请求到达的 IP 地址来识别虚拟主机。这种方式在云服务器环境中较少使用，因为 IP 地址通常较为宝贵。

• 基于端口的虚拟主机 (Port-based Virtual Hosts): 使用不同的端口号来区分不同的虚拟主机。例如，一个虚拟主机使用 80 端口，另一个使用 8080 端口。这种方式在公网环境中不太常用，因为用户访问时需要在域名后显式指定端口号。

本章节重点关注基于域名的虚拟主机配置。

3.5.2 Tomcat 虚拟主机配置核心元素

Tomcat 虚拟主机的配置主要涉及 server.xml 文件中的 <Host> 元素。理解 <Host> 元素的属性以及相关子元素是掌握虚拟主机配置的关键。

核心配置文件：server.xml

Tomcat 的主要配置文件是 conf/server.xml。虚拟主机的配置信息就定义在这个文件中。我们需要修改 server.xml 文件来添加和配置虚拟主机。

<Host> 元素:

<Host> 元素是 server.xml 中用于定义虚拟主机的核心元素。一个 <Host> 元素代表一个虚拟主机。

<Host> 元素的常用属性：

• name (必需): 虚拟主机的域名。当用户通过此域名访问 Tomcat 服务器时，Tomcat 会将请求路由到此 <Host> 进行处理。例如：www.example.com。 重要: name 属性必须与你的域名解析记录（DNS）指向 Tomcat 服务器 IP 地址的域名一致。可以配置多个域名，用逗号分隔，例如 name="www.example.com, example.com".

• appBase (可选): 虚拟主机的应用程序根目录。指定此虚拟主机部署的 Web 应用程序的存放位置。可以是绝对路径或相对于 Tomcat catalina.base 目录的相对路径。默认值为 webapps。 重要: 每个 <Host> 应该有独立的 appBase，以隔离不同虚拟主机的应用程序。

• unpackWARs (可选): 是否自动解压 WAR 文件。当设置为 true 时（默认值），Tomcat 会自动解压 appBase 目录下的 WAR 文件。设置为 false 时，则不自动解压。

• autoDeploy (可选): 是否自动部署应用程序。当设置为 true 时（默认值），Tomcat 会定期检查 appBase 目录，自动部署新添加或更新的 Web 应用程序。设置为 false 时，则不自动部署。

• xmlValidation (可选): 是否启用 XML 验证。当设置为 true 时，Tomcat 会验证 Web 应用程序的 web.xml 和 context.xml 文件。默认值为 false。

• xmlNamespaceAware (可选): 是否启用 XML 命名空间支持。当设置为 true 时，Tomcat 会启用 XML 命名空间支持。默认值为 false。

• errorReportValveClassName (可选): 指定错误报告 Valve 的类名。用于自定义错误报告处理。

<Context> 元素 (可选，但常用):

<Context> 元素定义了部署在虚拟主机上的 Web 应用程序的上下文路径、文档根目录等信息。虽然 <Host> 可以直接部署位于 appBase 下的应用程序，但使用 <Context> 可以更灵活地控制应用程序的部署和配置。

• path (可选): Web 应用程序的上下文路径。例如，path="/myapp" 表示应用程序的访问路径为 http://www.example.com/myapp。如果 path="" 或 path="/"，则表示应用程序部署在虚拟主机的根路径。

• docBase (可选): Web 应用程序的文档根目录。指定 Web 应用程序的静态资源文件（HTML, CSS, JavaScript, 图片等）存放的位置。可以是绝对路径或相对于 <Host> 的 appBase 目录的相对路径。如果未指定 docBase，则默认为 appBase 目录下的与 <Context path> 同名的目录或 WAR 文件。

• reloadable (可选): 是否启用自动重新加载。当设置为 true 时，Tomcat 会监视 Web 应用程序的 /WEB-INF/classes 和 /WEB-INF/lib 目录下的文件，当文件发生更改时，Tomcat 会自动重新加载应用程序。生产环境中不建议启用，会影响性能。开发环境可以方便热部署。

<Valve> 元素 (可选，用于扩展功能):

<Valve> 元素用于向请求处理管道中添加自定义的处理组件，可以实现诸如访问日志、安全控制、请求转发等功能。在虚拟主机配置中，<Valve> 常用于配置虚拟主机级别的访问日志。

• className (必需): Valve 的类名。指定要使用的 Valve 的类名。例如，org.apache.catalina.valves.AccessLogValve 用于配置访问日志。

mermaid graph TD 图解 <Host> 和 <Context> 的关系:

图表解释:

• Tomcat Server: 表示整个 Tomcat 服务器实例。

• Engine: Tomcat 的引擎，负责处理请求。一个 Tomcat 服务器通常只有一个 Engine。

• Host (www.example.com, www.another-example.com): 代表两个不同的虚拟主机，分别对应不同的域名。

• appBase (目录): 每个 Host 都有自己的 appBase 目录，用于存放该虚拟主机的 Web 应用程序。

• Context (/, /app1, /app2): 每个 Host 可以部署多个 Context，每个 Context 代表一个 Web 应用程序，通过 path 属性定义访问路径，docBase 属性指定应用程序的文档根目录。

• ClientRequest/ClientResponse: 客户端请求和服务器响应的流程。

3.5.3 配置虚拟主机的步骤和代码实践

配置 Tomcat 虚拟主机的主要步骤如下：

1. 准备域名并解析: 拥有要使用的域名，并将域名解析到 Tomcat 服务器的公网 IP 地址。

2. 修改 server.xml 文件: 编辑 Tomcat 的 conf/server.xml 文件，添加或修改 <Host> 元素，配置虚拟主机。

3. 创建虚拟主机的应用程序目录: 在 Tomcat 的 webapps 目录下（或者自定义的 appBase 目录），创建与虚拟主机域名对应的目录，用于存放虚拟主机的 Web 应用程序。

4. 部署 Web 应用程序: 将 Web 应用程序（WAR 文件或展开的目录）部署到虚拟主机的应用程序目录中。

5. 重启 Tomcat 服务器: 重启 Tomcat 服务器使配置生效。

代码实践示例：配置两个基于域名的虚拟主机

假设我们需要在 Tomcat 服务器上配置两个虚拟主机，分别对应域名 www.example.com 和 www.another-example.com。

1. 修改 server.xml 文件:

打开 Tomcat 的 conf/server.xml 文件，找到 <Engine> 元素，在 <Engine> 元素内部添加两个 <Host> 元素。

<Engine name="Catalina" defaultHost="localhost">
  <!-- 默认的 Host，用于处理未匹配到虚拟主机的请求 -->
  <Host name="localhost"  appBase="webapps"
        unpackWARs="true" autoDeploy="true">
    <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
           prefix="localhost_access_log" suffix=".txt"
           pattern="%h %l %u %t &quot;%r&quot; %s %b" />
  </Host>
  <!-- 第一个虚拟主机：www.example.com -->
  <Host name="www.example.com"  appBase="webapps-example.com"  <!-- 自定义 appBase -->
        unpackWARs="true" autoDeploy="true">
    <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
           prefix="example_access_log" suffix=".txt"
           pattern="%h %l %u %t &quot;%r&quot; %s %b" />
  </Host>
  <!-- 第二个虚拟主机：www.another-example.com -->
  <Host name="www.another-example.com" appBase="webapps-another-example.com" <!-- 自定义 appBase -->
        unpackWARs="true" autoDeploy="true">
    <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
           prefix="another_example_access_log" suffix=".txt"
           pattern="%h %l %u %t &quot;%r&quot; %s %b" />
  </Host>
</Engine>
​

配置说明:

• defaultHost="localhost": 设置默认的 Host 为 localhost。当请求的域名没有匹配到任何 <Host> 的 name 属性时，Tomcat 会使用默认 Host 进行处理。

• <Host name="www.example.com" ...>: 定义第一个虚拟主机，name 属性设置为 www.example.com，表示该虚拟主机处理域名为 www.example.com 的请求。

• <Host name="www.another-example.com" ...>: 定义第二个虚拟主机，name 属性设置为 www.another-example.com。

• appBase="webapps-example.com" 和 appBase="webapps-another-example.com": 为每个虚拟主机指定了独立的 appBase 目录。建议为每个虚拟主机使用独立的 appBase 目录，以隔离应用程序。

• <Valve ...> (AccessLogValve): 为每个虚拟主机配置了独立的访问日志，通过 prefix 属性设置不同的日志文件名前缀，方便区分不同虚拟主机的访问日志。

2. 创建虚拟主机的应用程序目录:

在 Tomcat 的 webapps 目录下（或者你指定的 catalina.base 的 webapps 目录下），创建以下目录：

webapps/
├── webapps-example.com/  <-- www.example.com 的 appBase
│   └── ROOT/            <--  www.example.com 的根应用程序
│       └── index.jsp
├── webapps-another-example.com/ <-- www.another-example.com 的 appBase
│   └── ROOT/            <-- www.another-example.com 的根应用程序
│       └── index.html
└── ... (其他默认的 webapps 目录下的内容)
​

目录结构说明:

• webapps-example.com 和 webapps-another-example.com: 分别对应 server.xml 中配置的 appBase 目录。

• ROOT 目录: 在 appBase 目录下创建 ROOT 目录，表示部署根应用程序（访问域名时直接访问的应用程序）。

• index.jsp 和 index.html: 简单的示例首页文件，用于测试虚拟主机是否配置成功。

index.jsp (webapps-example.com/ROOT/index.jsp) 示例:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Welcome to www.example.com</title>
</head>
<body>
    <h1>Hello from www.example.com!</h1>
    <p>This is the index page of the www.example.com virtual host.</p>
</body>
</html>
​

index.html (webapps-another-example.com/ROOT/index.html) 示例:

<!DOCTYPE html>
<html>
<head>
    <title>Welcome to www.another-example.com</title>
</head>
<body>
    <h1>Hello from www.another-example.com!</h1>
    <p>This is the index page of the www.another-example.com virtual host.</p>
</body>
</html>
​

3. 部署 Web 应用程序:

将你的 Web 应用程序 (WAR 文件或展开的目录) 放到 webapps-example.com 和 webapps-another-example.com 目录下。在本示例中，我们使用了简单的 index.jsp 和 index.html 作为根应用程序。

4. 重启 Tomcat 服务器:

重启 Tomcat 服务器，使 server.xml 的配置生效。

5. 测试虚拟主机:

• 确保域名解析生效: 确保 www.example.com 和 www.another-example.com 已经解析到你的 Tomcat 服务器的公网 IP 地址。

• 浏览器访问: 在浏览器中分别输入 http://www.example.com 和 http://www.another-example.com，应该分别看到 index.jsp 和 index.html 的内容，表明虚拟主机配置成功。

• 查看访问日志: 检查 Tomcat 的 logs 目录，应该生成了 example_access_log.txt 和 another_example_access_log.txt 两个日志文件，分别记录了 www.example.com 和 www.another-example.com 的访问日志。

3.5.4 配置 Context Path (可选但常用)

在虚拟主机中，除了部署根应用程序 (ROOT Context)，我们还可以部署多个应用程序，并为每个应用程序指定不同的 Context Path。

示例：在 www.example.com 虚拟主机下部署两个应用程序

假设我们要在 www.example.com 虚拟主机下部署两个应用程序：

• myapp1: Context Path 为 /app1

• myapp2: Context Path 为 /app2

1. 修改 server.xml 文件:

在 www.example.com 的 <Host> 元素中，添加 <Context> 元素来定义应用程序的 Context Path 和 docBase。

<Host name="www.example.com"  appBase="webapps-example.com"
      unpackWARs="true" autoDeploy="true">
    <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
           prefix="example_access_log" suffix=".txt"
           pattern="%h %l %u %t &quot;%r&quot; %s %b" />
    <!-- 部署 myapp1 应用程序，Context Path 为 /app1 -->
    <Context path="/app1" docBase="myapp1" reloadable="true" />
    <!-- 部署 myapp2 应用程序，Context Path 为 /app2 -->
    <Context path="/app2" docBase="myapp2" reloadable="true" />
</Host>
​

配置说明:

• <Context path="/app1" docBase="myapp1" ...>: 定义一个 Context，path 属性设置为 /app1，表示应用程序的访问路径为 http://www.example.com/app1。docBase="myapp1" 表示应用程序的文档根目录为 webapps-example.com/myapp1 目录。

• <Context path="/app2" docBase="myapp2" ...>: 类似地，定义了 Context Path 为 /app2 的应用程序。

2. 创建应用程序目录:

在 webapps-example.com 目录下，创建 myapp1 和 myapp2 目录，用于存放应用程序的文件。

webapps/
└── webapps-example.com/
    ├── ROOT/
    ├── myapp1/    <-- myapp1 应用程序目录
    │   └── index.jsp
    └── myapp2/    <-- myapp2 应用程序目录
        └── index.html
​

index.jsp (webapps-example.com/myapp1/index.jsp) 示例:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Welcome to myapp1 on www.example.com</title>
</head>
<body>
    <h1>Hello from myapp1!</h1>
    <p>This is myapp1 application on www.example.com.</p>
</body>
</html>
​

index.html (webapps-example.com/myapp2/index.html) 示例:

<!DOCTYPE html>
<html>
<head>
    <title>Welcome to myapp2 on www.example.com</title>
</head>
<body>
    <h1>Hello from myapp2!</h1>
    <p>This is myapp2 application on www.example.com.</p>
</body>
</html>
​

3. 重启 Tomcat 服务器并测试:

重启 Tomcat 服务器后，可以通过以下 URL 访问应用程序：

• http://www.example.com/app1 (访问 myapp1)

• http://www.example.com/app2 (访问 myapp2)

3.5.5 虚拟主机访问日志配置

为了更好地监控和分析虚拟主机的访问情况，为每个虚拟主机配置独立的访问日志非常重要。我们在之前的示例中已经使用了 <Valve> 元素配置了虚拟主机级别的访问日志。

回顾访问日志配置:

在 <Host> 元素内部添加 <Valve> 元素，并配置 className 为 org.apache.catalina.valves.AccessLogValve，可以启用访问日志功能。

<Host name="www.example.com"  appBase="webapps-example.com" ...>
    <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
           prefix="example_access_log" suffix=".txt"
           pattern="%h %l %u %t &quot;%r&quot; %s %b" />
</Host>
​

访问日志 Valve 常用属性:

• directory: 日志文件存放目录。

• prefix: 日志文件名前缀。

• suffix: 日志文件名后缀。

• pattern: 日志格式模式。常用的模式包括：

  • %h: 客户端主机名 (或 IP 地址)。

  • %l: 远程逻辑用户名 (总是 -)。

  • %u: 远程用户认证名 (如果已认证)。

  • %t: 日期和时间。

  • "%r": 请求行 (请求方法、URI、协议)。

  • %s: 状态码。

  • %b: 响应内容字节数 (不包括 HTTP Header)。

  • %D: 处理请求的时间 (毫秒)。

  • %T: 处理请求的时间 (秒)。

  • %I: 当前线程名。

自定义访问日志格式:

可以根据需求自定义 pattern 属性，配置更详细或更简洁的访问日志格式。例如，添加 %D 和 %T 可以记录请求处理时间，方便性能分析。

3.5.6 虚拟主机配置最佳实践和注意事项

• 域名解析: 确保虚拟主机的域名正确解析到 Tomcat 服务器的 IP 地址。

• 独立的 appBase 目录: 为每个虚拟主机配置独立的 appBase 目录，隔离应用程序，避免互相干扰。

• 合理的应用程序目录结构: 在 appBase 目录下，按照域名或项目名称组织应用程序目录，方便管理。

• 配置虚拟主机级别的访问日志: 为每个虚拟主机配置独立的访问日志，方便监控和分析。

• 安全考虑: 根据虚拟主机的需求，配置必要的安全措施，例如 SSL/TLS 加密、访问控制等。

• 性能优化: 根据虚拟主机的访问量和资源需求，进行性能优化配置，例如 JVM 参数调优、连接器配置等。

• 避免在默认 Host (localhost) 部署重要应用: 默认 Host 主要用于处理未匹配到虚拟主机的请求，不建议在其下部署重要的应用程序。

• 定期检查和维护配置: 定期检查 server.xml 文件，确保虚拟主机配置正确有效，并及时更新和维护配置。

• 使用版本控制管理 server.xml: 将 server.xml 文件纳入版本控制系统 (如 Git) 管理，方便追踪修改历史和回滚配置。

3.5.7 总结

Tomcat 虚拟主机配置是 Tomcat 服务器管理和多站点托管的重要技术。通过合理配置 <Host> 和 <Context> 元素，我们可以轻松地在同一台 Tomcat 服务器上运行多个独立的网站和应用程序，有效利用服务器资源，简化管理维护。

本章节详细介绍了 Tomcat 虚拟主机的概念、配置方法、代码实践以及最佳实践，希望能够帮助您掌握 Tomcat 虚拟主机配置的核心技术，并在实际应用中灵活运用。掌握虚拟主机配置，将使您能够更加高效地使用 Tomcat 服务器，满足各种 Web 应用部署的需求。