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

前言

整理這個官方翻譯的系列,原因是網上大部分的 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

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章