web server apache tomcat11-03-deploy 如何部署

老马啸西风發表於2024-04-17
WebServerApacheTomcat

前言

整理這個官方翻譯的系列，原因是網上大部分的 tomcat 版本比較舊，此版本為 v11 最新的版本。

開源專案

從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎，輕嗅薔薇。

系列文章

web server apache tomcat11-01-官方文件入門介紹

web server apache tomcat11-02-setup 啟動

web server apache tomcat11-03-deploy 如何部署

web server apache tomcat11-04-manager 如何管理？

web server apache tomcat11-06-Host Manager App -- Text Interface

web server apache tomcat11-07-Realm Configuration

web server apache tomcat11-08-JNDI Resources

web server apache tomcat11-09-JNDI Datasource

web server apache tomcat11-10-Class Loader

....

Tomcat Web 應用部署

簡介

部署是指將 Web 應用程式（無論是第三方 WAR 檔案還是自定義的 Web 應用程式）安裝到 Tomcat 伺服器的過程。

在 Tomcat 伺服器內，可以透過多種方式來完成 Web 應用程式的部署。

  • 靜態部署：在啟動 Tomcat 之前設定 Web 應用程式。
  • 動態部署：透過直接操作已部署的 Web 應用程式（依賴自動部署功能）或透過使用 Tomcat Manager Web 應用程式來遠端部署。

Tomcat Manager 是一個 Web 應用程式，可以以互動方式（透過 HTML GUI）或以程式設計方式（透過基於 URL 的 API）來部署和管理 Web 應用程式。

有許多依賴於 Manager Web 應用程式的部署方式。

Apache Tomcat 提供了用於 Apache Ant 構建工具的任務。

Apache Tomcat Maven 外掛專案提供了與 Apache Maven 的整合。

還有一個稱為 Client Deployer 的工具，可以從命令列使用，並提供了額外的功能，例如編譯和驗證 Web 應用程式，以及將 Web 應用程式打包成 Web 應用資源（WAR）檔案。

安裝

對於靜態部署 Web 應用程式，不需要安裝，因為 Tomcat 預設提供了此功能。對於使用 Tomcat Manager 的部署功能，雖然需要一些配置（如 Tomcat Manager 手冊中詳細說明的那樣），但不需要安裝。但是，如果要使用 Tomcat Client Deployer (TCD)，則需要安裝。

TCD 不包含在 Tomcat 核心發行版中，因此必須從下載區域單獨下載。下載通常標記為 apache-tomcat-11.0.x-deployer。

TCD 的先決條件是 Apache Ant 1.6.2+ 和 Java 安裝。您的環境應定義一個 ANT_HOME 環境值，指向 Ant 安裝的根目錄，以及一個 JAVA_HOME 值，指向您的 Java 安裝。

另外，您應確保 Ant 的 ant 命令和 Java 的 javac 編譯器命令可以在您的作業系統提供的命令 shell 中執行。

  1. 下載 TCD 分發包。

  2. TCD 分發包不需要解壓到任何現有的 Tomcat 安裝中，它可以解壓到任何位置。

  3. 閱讀《使用 Tomcat Client Deployer》文件。

關於 Context

在討論 Web 應用程式的部署時，需要理解 Context 的概念。Context 是 Tomcat 所稱的 Web 應用程式。

為了在 Tomcat 中配置 Context，需要一個 Context 描述符。Context 描述符只是一個包含與 Context 相關的 Tomcat 配置的 XML 檔案，例如命名資源或會話管理器配置。在較早版本的 Tomcat 中，Context 描述符配置的內容通常儲存在 Tomcat 的主配置檔案 server.xml 中，但現在已不鼓勵這樣做（儘管目前仍然有效）。

Context 描述符不僅幫助 Tomcat 知道如何配置 Context，還幫助其他工具（如 Tomcat Manager 和 TCD）正確執行其功能。

Context 描述符的位置包括：

  • $CATALINA_BASE/conf/[enginename]/[hostname]/[webappname].xml

  • $CATALINA_BASE/webapps/[webappname]/META-INF/context.xml

第一種情況的檔案命名為 [webappname].xml，而第二種情況的檔案命名為 context.xml。如果沒有為 Context 提供 Context 描述符，Tomcat 將使用預設值配置 Context。

在 Tomcat 啟動時部署

如果您不想使用 Tomcat Manager 或 TCD，則需要將 Web 應用程式靜態部署到 Tomcat，然後啟動 Tomcat。您需要將 Web 應用程式部署到稱為 appBase 的位置，該位置由 Host 指定。您可以將所謂的“已解壓” Web 應用程式（即非壓縮的）複製到此位置，也可以將壓縮的 Web 應用程式資源 .WAR 檔案複製到此位置。

在預設的情況下，位於主機（預設主機為“localhost”）appBase 屬性（預設 appBase 為“$CATALINA_BASE/webapps”）指定的位置中存在的 Web 應用程式僅在 Host 的 deployOnStartup 屬性為“true”時才會在 Tomcat 啟動時部署。

在這種情況下，以下部署順序將在 Tomcat 啟動時發生：

  1. 首先部署任何 Context 描述符。

  2. 然後部署任何未被任何 Context 描述符引用的已解壓的 Web 應用程式。如果它們在 appBase 中有一個關聯的 .WAR 檔案，並且該檔案比已解壓的 Web 應用程式更新，則將刪除已解壓的目錄，並重新部署 Web 應用程式。

  3. 部署 .WAR 檔案。

在執行的 Tomcat 伺服器上部署

可以將 Web 應用程式部署到執行中的 Tomcat 伺服器上。

如果 Host 的 autoDeploy 屬性設定為“true”，則 Host 將嘗試根據需要動態部署和更新 Web 應用程式，例如

，如果新的 .WAR 放入了 appBase 中。要使此功能正常工作，Host 需要啟用後臺處理，這是預設配置。

autoDeploy 設定為“true”並且執行中的 Tomcat 允許：

  • 將 .WAR 檔案複製到 Host 的 appBase 中進行部署。

  • 將已解壓的 Web 應用程式複製到 Host 的 appBase 中進行部署。

  • 如果提供了新的 .WAR 檔案，則重新部署已經部署的 Web 應用程式。在這種情況下，將刪除已解壓的 Web 應用程式，並重新展開 .WAR。請注意，如果 Host 配置為不展開 .WAR（unpackWARs 屬性設定為“false”），則不會執行展開操作，此時 Web 應用程式將作為壓縮的存檔重新部署。

  • 如果更新了 /WEB-INF/web.xml 檔案（或任何其他定義為 WatchedResource 的資源），則重新載入 Web 應用程式。

  • 如果更新了從中部署了 Web 應用程式的 Context 描述符檔案，則重新部署 Web 應用程式。

  • 如果由 Web 應用程式使用的全域性或每個主機的 Context 描述符檔案已更新，則重新部署依賴的 Web 應用程式。

  • 如果在 $CATALINA_BASE/conf/[enginename]/[hostname]/ 目錄中新增了一個檔案（檔名對應於先前部署的 Web 應用程式的 Context 路徑），則重新部署 Web 應用程式。

  • 如果刪除了其文件基址（docBase）的 Web 應用程式，則解除安裝它。請注意，在 Windows 上，這假定啟用了反鎖定功能（參見 Context 配置），否則無法刪除正在執行的 Web 應用程式的資源。

請注意，還可以在載入器中配置 Web 應用程式重新載入，這樣載入的類將被跟蹤以進行更改。

使用 Tomcat Manager 進行部署

Tomcat Manager 在自己的手冊頁面中進行了詳細介紹。

使用客戶端部署包進行部署

最後，可以使用 Tomcat 客戶端部署程式來部署 Web 應用程式。這是一個可以用來驗證、編譯、壓縮為 .WAR，並將 Web 應用程式部署到生產或開發 Tomcat 伺服器的包。應該注意，此功能使用 Tomcat Manager，因此目標 Tomcat 伺服器應該正在執行。

假設使用者熟悉 Apache Ant 以使用 TCD。Apache Ant 是一個指令碼化的構建工具。TCD 包含一個預打包的構建指令碼。只需要對 Apache Ant 有一些基本的瞭解（如本頁中列出的安裝，並熟悉使用作業系統命令 shell 和配置環境變數）。

TCD 包含 Ant 任務，用於 JSP 編譯的 Jasper 頁面編譯器，以及用於驗證 Web 應用程式 Context 描述符的任務。驗證器任務（類 org.apache.catalina.ant.ValidatorTask）僅允許一個引數：已解壓的 Web 應用程式的基本路徑。

TCD 使用已解壓的 Web 應用程式作為輸入（請參閱下面使用的屬性列表）。透過 deployer 進行程式設計部署的 Web 應用程式可以在 /META-INF/context.xml 中包含 Context 描述符。

TCD 包含一個可立即使用的 Ant 指令碼，具有以下目標：

  • compile（預設）：編譯和驗證 Web 應用程式。這可以獨立使用，不需要執行的 Tomcat 伺服器。編譯的應用程式僅在關聯的 Tomcat X.Y.Z 伺服器釋出中執行，並不能保證在另一個 Tomcat 釋出中工作，因為 Jasper 生成的程式碼依賴於其執行時元件。還應該注意，此目標還會自動編譯位於 /WEB-INF/classes 資料夾中的任何 Java 原始檔。
  • deploy：將 Web 應用程式（已編譯或未編譯）部署到 Tomcat 伺服器。
  • undeploy：解除安裝 Web 應用程式
  • start：啟動 Web 應用程式
  • reload：重新載入 Web 應用程式
  • stop：停止 Web 應用程式

為了配置部署，需要在 TCD 安裝目錄根目錄下建立一個名為 deployer.properties 的檔案。在此檔案中，每行新增以下名稱=值對：

此外，您需要確保為目標 Tomcat Manager（TCD 使用的）設定了使用者，否則 TCD 將無法與 Tomcat Manager 進行身份驗證，部署將失敗。

要執行此操作，請參閱 Tomcat Manager 頁面。

參考資料

https://tomcat.apache.org/tomcat-11.0-doc/deployer-howto.html

相關文章