tomcat 配置文件 conf/server.xml 中的 appBase和docBase

前言

最近在 tomcat 配置和部署应用时，踩了一些坑，主要是关于在 ${CATALINA_HOME}/conf/server.xml 配置文件里的 Host 节点属性 appBase，及 Host 节点子节点 Context>的属性 docBase。

我是将项目打成 App1.war 包，然后把 war 包上传到 tomcat 的相关目录，启动部署。

部署方案

1. 默认配置，不修改 conf/server.xml 文件

把 war 包直接传到 ${CATALINA_HOME}/webapps/ 目录，启动 tomcat 后，tomcat 会自动解压这个 webapps 目录下的 war，并且部署。

例如，把 App1.war 放到 webapps 目录后，tomcat 会将 App1.war 解压为 webapps/App1 目录，然后部署。

这是默认配置，没新增 Context 子节点，让 tomcat 来解压 war 包，非常方便。

2. 修改 conf/server.xml 文件，新增 Context 节点，并设置 docBase=“App1”（错误示例）

把 App1.war 包传到 ${CATALINA_HOME}/webapps/ 目录, 并修改 conf/server.xml 文件，增加 Context 节点，并指定 Context 节点属性 docBase=“App1”。

由方案1可知，App1.war 会自动解压到 App1 目录，那么把 docBase 设置为 App1 似乎是很自然的事情。

可这会有一个坑，Host 节点指定的 appBase=“webapps”, 而 App1 就在 webapps 目录，所以 tomcat 会根据 appBase 加载一次 App1；

另 Context 子节点又设置了 docBase=“App1"，这时 tomcat 又会根据 docBase 加载一次 App1，相当于 App1 被加载了两次。

这会引起很多莫名其妙的问题，如：某一个定时任务，会在同一时刻被执行两次；日志可能会打到前一天的文件等。

3.配置 conf/server.xml 文件，增加 Context 节点，并指定 docBase 为非 webapps 的子目录（推荐）

1. 新建 ${CATALINA_HOME}/mybapps/App1 目录；
2. 修改 conf/server.xml 文件，配置 Context 节点，指定 docBase=“${CATALINA_HOME}/myapps/App1”；这里的 ${CATALINA_HOME} 为 tomcat 安装路径，使用时需替换为绝对路径；
3. 将 App1.war 放到 ${CATALINA_HOME}/mybapps/App1/ 目录下；
4. 通过命令 jar xvf App1.war 解压 war 包到当前目录；
5. 启动 tomcat；
6. 后续 war 包有更新时，重复步骤3、4，不需要再执行第5步，tomcat 会自动重新部署。

注意：docBase 需要设置为绝对路径

方案3配置示例

conf/server.xml 文件中的 Host 节点：

<Host name="localhost"  appBase="webapps"
            unpackWARs="true" autoDeploy="true">
        ...
        ...
        <Context path="/" docBase="/Users/xxx/soft/apache-tomcat-8.5.39/myapps/App1"  debug="0" reloadable="true"></Context>

</Host>

总结

conf/server.xml 的 Host 节点的 appBase 指定的目录表示，

1. 这个目录下面的子目录将自动被部署为应用。
2. 这个目录下面的.war文件将被自动解压缩并部署为应用

而 docBase 只是指向你某个应用的目录，可以和 appBase 没有任何关系。特别注意，如果 docBase 指向的是 webapps 下面的目录，会导致应用被加载两次，引起奇怪问题。