Maven 遠(yuǎn)程熱部署Tomcat

出處:
http://www.cnblogs.com/letcafe/
https://www.cnblogs.com/xyb930826/p/5725340.html

概述

Maven本身不提供任何插件將war包發(fā)布到遠(yuǎn)程站點(diǎn),例如Tomcat這樣類似的Servlet容器,但是,Apache Tomcat本身提供了一個(gè)Maven插件:

<dependency>
    <groupId>org.apache.tomcat.maven</groupId>
    <artifactId>tomcat7-maven-plugin</artifactId>
    <version>2.1</version>
</dependency>

tomcat7-maven-plugin是很久以前的插件版本,默認(rèn)支持到Tomcat7,但是對(duì)于目前最新的Tomcat9同樣可以使用該插件(雖然插件的ArtifactId的名字為tomcat7很奇怪)

插件介紹的官網(wǎng)文檔為:

http://tomcat.apache.org/maven-plugin-2.1/index.html

一、Tomcat插件支持的目標(biāo)

默認(rèn)使用的Tomcat7插件支持多種目標(biāo),

調(diào)用格式如下:

mvn tomcat7:[goal]

例如,遠(yuǎn)程部署一個(gè)項(xiàng)目到Tomcat容器:

mvn tomcat7:deploy

文檔如下:

目標(biāo) 描述
deploy 部署war包到Tomcat中
deploy-only 不經(jīng)過(guò)package階段,直接將包部署到Tomcat中(傳輸現(xiàn)成的)
exec-war 創(chuàng)建一個(gè)包含必要Apache Tomcat類庫(kù)的自可執(zhí)行jar包,這允許使
用類似'jar -jar mywebapp.jar'直接運(yùn)行APP而不需要Tomcat實(shí)例
exec-war-only 同上exec-war,但是不使用package階段
help 展示所有的幫助信息
redeploy 重新部署war包到Tomcat(等同于deploy目標(biāo)加上update=true參數(shù))
redeploy-only 重新部署war包到Tomcat但是不經(jīng)過(guò)package階段(等同于deploy目
標(biāo)加上update=true參數(shù))
run 將當(dāng)前項(xiàng)目作為動(dòng)態(tài)web程序(exploded),使用嵌入的Tomcat服務(wù)器運(yùn)行
run-war 將當(dāng)前項(xiàng)目作為打包后的war(war),使用嵌入的Tomcat服務(wù)器運(yùn)行
run-war-only 同run-war,但是不使用package階段
shutdown 關(guān)閉所有已經(jīng)開(kāi)始的嵌入式Tomcat服務(wù)器
standalone-war 創(chuàng)建嵌入Tomcat的可執(zhí)行war,并且可以在別的地方部署
standalone-war-only 同standalone-war但是不使用package階段
undeploy 從Tomcat服務(wù)器中,取消部署某一個(gè)項(xiàng)目

二、系統(tǒng)要求及插件引入

2.1 系統(tǒng)要求

要求如下:

組件 Maven JDK 內(nèi)存 硬盤(pán)
要求 2.0+ 1.5+ 無(wú)要求 無(wú)要求

2.2 引入插件

引入方式:

<project>
  ...
  <build>
    <!-- 在POM中或父POM中使用這樣的插件(IDEA會(huì)出現(xiàn)對(duì)應(yīng)的插件欄) -->
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

三、遠(yuǎn)程部署war到tomcat

命令格式:

mvn tomcat7:deploy

3.1 添加tomcat管理角色

修改tomcat的用戶配置文件

%TOMCAT_HOME%/conf/tomcat-users.xml,添加一個(gè)用戶:

<?xml version="1.0" encoding="UTF-8"?>
<tomcat-users xmlns="http://tomcat.apache.org/xml"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://tomcat.apache.org/xml tomcat-users.xsd"
              version="1.0">
    <role rolename="manager-gui" />
    <role rolename="manager-script"/>
    <user username="username" password="password" roles="manager-gui,manager-script"/>
</tomcat-users>

注意!可以給該用戶添加多個(gè)角色,為了遠(yuǎn)程部署,需要調(diào)用script,至少需要這個(gè)角色:

  • manager-script

當(dāng)然,也可以開(kāi)啟manager-gui用于可視化管理

3.15 添加manager.xml的配置

默認(rèn)情況下,Tomcat的Manager和Host-Manager只接受本機(jī)的請(qǐng)求,而要讓它接受遠(yuǎn)程的請(qǐng)求,需要添加manager.xml的配置

在tomcat服務(wù)器的conf/Catalina/localhost/目錄下創(chuàng)建一個(gè)manager.xml文件,寫(xiě)入如下值:

<?xml version="1.0" encoding="UTF-8"?>
<Context privileged="true" antiResourceLocking="false"
         docBase="${catalina.home}/webapps/manager">
             <Valve className="org.apache.catalina.valves.RemoteAddrValve" allow="^.*$" />
</Context>

保存退出。

由于Tomcat的Manager可以執(zhí)行項(xiàng)目的部署、卸載等敏感操作,如果你只想允許特定的IP地址訪問(wèn)Manager,可在上面的allow屬性中設(shè)置規(guī)則。具體規(guī)則設(shè)置見(jiàn)下面的鏈接:
http://tomcat.apache.org/tomcat-7.0-doc/config/valve.html#Remote_Address_Filter
問(wèn)題說(shuō)明:http://tomcat.apache.org/tomcat-7.0-doc/manager-howto.html#Configuring_Manager_Application_Access

3.2 本地Maven設(shè)置Server

為了讓本地發(fā)布的Maven可以找到對(duì)應(yīng)的服務(wù)器并完成鑒權(quán)

需要修改settings.xml,并添加服務(wù)器,這里的賬號(hào)、密碼需要和部署的tomcat服務(wù)器配置的一致

<servers>
    <server>
        <id>tomcatServer</id>
        <username>username</username>
        <password>password</password>
    </server>
</servers>

3.3 項(xiàng)目配置Tomcat插件

<build>
    <!-- 在POM中或父POM中使用這樣的插件(IDEA會(huì)出現(xiàn)對(duì)應(yīng)的插件欄) -->
    <plugins>
        <plugin>
            <groupId>org.apache.tomcat.maven</groupId>
            <artifactId>tomcat7-maven-plugin</artifactId>
            <version>2.2</version>
            <configuration>
                <url>http://{yourIP}:8080/manager/text</url>  <!--部署到哪臺(tái)服務(wù)器, 使用的是tomcat的默認(rèn)項(xiàng)目manager進(jìn)行deploy, 因此/manager/text是manager固定的接口。用戶名密碼使用的是tomcat的tomcat-users.xml配置文件中具備manager-script的用戶名密碼, 另外需要在maven的setting.xml配置同樣的用戶名密碼-->
                <server>tomcatServer</server>
                <update>true</update>
                <path>/${project.artifactId}</path>
            </configuration>
        </plugin>
      ...
    </plugins>
</build>

此處指定了插件所使用的<server style="margin: 0px; padding: 0px;">切記需要一致(setting.xml和pom.xml)</server>

3.4 插件參數(shù)說(shuō)明

tomcat7-maven-plugin為每個(gè)目標(biāo)提供了多個(gè)參數(shù),每個(gè)目標(biāo)可以有相關(guān)的配置,具體說(shuō)明可參考官方文檔:

http://tomcat.apache.org/maven-plugin-2.1/tomcat7-maven-plugin/plugin-info.html

3.4.1 必選參數(shù)

以下參數(shù)必選,但是可以在pom中空缺,空缺時(shí)將采用默認(rèn)值

名稱 描述 默認(rèn)值
charset 在與Tomcat Manager通信是的URL編
碼字符集 ISO-8859-1
mode 部署的模式,值可為:war,context,both war
path 應(yīng)用程序運(yùn)行的上下文路徑,必須以'/'開(kāi)始 /${project.artifactId}
update 當(dāng)部署已存在的應(yīng)用時(shí),是否自動(dòng)
undeploy該應(yīng)用 false
url Tomcat Manager實(shí)例使用的全路徑 http://localhost:8080
/manager/text
warFile 部署warFile的路徑 ${project.build.directory}
/${project.build.finalName}.war

3.4.2 可選參數(shù)

對(duì)于個(gè)性化的需求,tomcat7插件提供了可配置的參數(shù)

名稱 描述
contextFile Tomcat的context的XML路徑,對(duì)于mode=war不適用,默認(rèn)為

{project.build.directory}/{project.build.finalName}/
META-INF/context.xml |
| ignorePackaging | 如果設(shè)置為true,忽略類型不是war的項(xiàng)目 |
| username | 部署到Tomcat的username |
| password | 部署到Tomcat的password |
| server | 指定Maven的setting.xml中配置的server id用于Tomcat認(rèn)證 |
| tag | 應(yīng)用程序在Tomcat中使用的標(biāo)簽的名字 |

3.5 運(yùn)行結(jié)果

如果是第一次部署,運(yùn)行mvn tomcat7:deploy進(jìn)行自動(dòng)部署(對(duì)于tomcat8,9,也是使用tomcat7命令),如果是更新了代碼后重新部署更新,運(yùn)行mvn tomcat7:redeploy,如果第一次部署使用mvn tomcat7:redeploy,則只會(huì)執(zhí)行上傳war文件,服務(wù)器不會(huì)自動(dòng)解壓部署。如果路徑在tomcat服務(wù)器中已存在并且使用mvn tomcat7:deploy命令的話,上面的配置中一定要配置<update>true</update>,不然會(huì)報(bào)錯(cuò)。tomcat7:deploy前必須先maven:install從父項(xiàng)目到子項(xiàng)目部署到本地倉(cāng)庫(kù)

調(diào)用:mvn tomcat7:deploy命令得到下圖:

image

成功快速部署到tomcat中

image

四、遠(yuǎn)程undeploy

此外,如果快速卸載(undeploy)Tomcat服務(wù)器的項(xiàng)目,使用:

mvn tomcat7:undeploy

效果如下:

image
image

五、其他問(wèn)題

(1)自動(dòng)部署顯示成功,war包也上傳成功,但是war不自動(dòng)解壓自動(dòng)部署。

如果你在tomcat的server.xml中通過(guò)設(shè)置<Context>標(biāo)簽來(lái)部署相同名稱的項(xiàng)目的話,maven發(fā)布到該服務(wù)器的war不會(huì)被自動(dòng)解壓,部署,更新,需要去掉server.xml中該項(xiàng)目的<Context>標(biāo)簽。

(2)內(nèi)存泄漏
使用上面的方法進(jìn)行部署后會(huì)出現(xiàn)嚴(yán)重的內(nèi)存泄漏現(xiàn)象。tomcat的manager提供了診斷在部署時(shí)是否產(chǎn)生內(nèi)存泄漏的功能,在上面提到的http://serverip:port/manager/html這個(gè)頁(yè)面底部有一個(gè)“Find leaks”的按鈕,如下:

image

點(diǎn)擊按鈕,網(wǎng)頁(yè)頭部出現(xiàn)如下信息說(shuō)明在部署的時(shí)候有內(nèi)存泄漏:

image

上面的消息顯示部署的test項(xiàng)目存在內(nèi)存泄漏,如果同一項(xiàng)目多次重新部署,則一個(gè)項(xiàng)目名可能會(huì)出現(xiàn)多次。

部署時(shí)產(chǎn)生內(nèi)存泄漏的原因是每次(重新)部署時(shí),Tomcat會(huì)為項(xiàng)目新建一個(gè)類加載器,而舊的類加載器沒(méi)有被GC回收。maven的庫(kù)classloader-leak-prevention-servlet可以用來(lái)解決這個(gè)問(wèn)題。具體方案為:

(1)添加maven依賴:

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;"><dependency>
<groupId>se.jiderhamn.classloader-leak-prevention</groupId>
<artifactId>classloader-leak-prevention-servlet</artifactId>
<version>2.1.0</version>
</dependency></pre>

(2)在項(xiàng)目的web.xml中添加一個(gè)Listener(必須讓此Listener成為web.xml中的第一個(gè)Listener,否則不起作用

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;"><listener>
<listener-class>se.jiderhamn.classloader.leak.prevention.ClassLoaderLeakPreventorListener</listener-class>
</listener></pre>

這樣部署時(shí)的內(nèi)存泄漏就解決了。
注意:
1) 添加這個(gè)Listener后,默認(rèn)在tomcat關(guān)閉5s后jvm會(huì)進(jìn)行內(nèi)存回收的操作,具體時(shí)間設(shè)置可在下面的第三個(gè)參考鏈接中找到,所以,在關(guān)閉后的5s內(nèi),再次啟動(dòng)tomcat,可能會(huì)存在問(wèn)題,導(dǎo)致啟動(dòng)無(wú)效(如果出現(xiàn)tomcat重啟后日志顯示正常但是服務(wù)器不工作的話考慮一下是不是這個(gè)問(wèn)題)。
2)這個(gè)Listener只解決部署的內(nèi)存泄漏,其他問(wèn)題(如jdbc等)產(chǎn)生的內(nèi)存泄漏還需要自己解決。
參考:
http://stackoverflow.com/questions/7788280/memory-leak-when-redeploying-application-in-tomcat#answer-36295683
http://java.jiderhamn.se/2011/12/11/classloader-leaks-i-how-to-find-classloader-leaks-with-eclipse-memory-analyser-mat/
https://github.com/mjiderhamn/classloader-leak-prevention

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容