maven自動部署到遠程tomcat教程

使用maven的自動部署功能能夠很方便的將maven工程自動部署到遠程tomcat服務器，節省了大量時間。

本文章適用於tomcat的7.x ,8.x, 9.x版本。

下面是自動部的步驟

1，首先，配置tomcat的manager

編輯遠程tomcat服務器下的conf/tomcat-users.xml,在末尾增長（其實只要拉到文件末尾，去掉註釋改一下就能夠了）

<role rolename="manager-gui"/>
<role rolename="manager-script"/>
<user username="admin" password="password" roles="manager-script"/>
<user username="root" password="password" roles="manager-gui"/>

將上面的password改成本身的密碼，注意對於tomcat9來講，不能同時賦予用戶manager-script和manager-gui角色。

保存tomcat-users.xml。

在tomcat服務器的conf/Catalina/localhost/目錄下建立一個manager.xml文件，寫入以下值:

<?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>

 

保存退出。

而後在瀏覽器中輸入http://serverip:port/manager/html，此時會彈出要求輸入用戶名和密碼對話框，輸入manager-gui對應的用戶和密碼登陸管理控制檯(其中serverip爲服務器ip，若是服務器在本地就是localhost或者127.0.0.1，端口爲tomcat端口，默認8080)。以此確認manager是否配置正確。正確結果示例以下：

 

2，在maven項目中添加配置

在pom.xml文件中，在plugins節點下添加以下plugin節點

<plugin>

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

    <configuration>
        <url>http://serverip:port/manager/text</url>
        <username>admin</username>
        <password>password</password>
        <update>true</update>
        <path>/webapp</path>
    </configuration>

</plugin>

將上面的serverip和port換成本身tomcat服務器的ip和端口。密碼換成上面配置的manager-script角色的密碼。path改成項目在tomcat服務器中的部署路徑。

而後進行部署，若是是第一次部署，運行mvn tomcat7:deploy進行自動部署(對於tomcat8,9，也是使用tomcat7命令)，若是是更新了代碼後從新部署更新，運行mvn tomcat7:redeploy，若是第一次部署使用mvn tomcat7:redeploy，則只會執行上傳war文件，服務器不會自動解壓部署。若是路徑在tomcat服務器中已存在而且使用mvn tomcat7:deploy命令的話，上面的配置中必定要配置<update>true</update>，否則會報錯。

若是IDE是eclipse,就在runas->run configurations中配置一個maven build，intellij相似。

3. 內存泄漏

 使用上面的方法進行部署後會出現嚴重的內存泄漏現象。tomcat的manager提供了診斷在部署時是否產生內存泄漏的功能，在上面提到的http://serverip:port/manager/html這個頁面底部有一個「Find leaks」的按鈕，以下：

點擊按鈕，網頁頭部出現以下信息說明在部署的時候有內存泄漏：

上面的消息顯示部署的test項目存在內存泄漏，若是同一項目屢次從新部署，則一個項目名可能會出現屢次。

部署時產生內存泄漏的緣由是每次（從新）部署時，Tomcat會爲項目新建一個類加載器，而舊的類加載器沒有被GC回收。maven的庫classloader-leak-prevention-servlet能夠用來解決這個問題。具體方案爲：

 

（1）添加maven依賴：

<dependency>
    <groupId>se.jiderhamn.classloader-leak-prevention</groupId>
    <artifactId>classloader-leak-prevention-servlet</artifactId>
    <version>2.1.0</version>
</dependency>

（2）在項目的web.xml中添加一個Listener（必須讓此Listener成爲web.xml中的第一個Listener，不然不起做用）

<listener>
    <listener-class>se.jiderhamn.classloader.leak.prevention.ClassLoaderLeakPreventorListener</listener-class>
</listener>

這樣部署時的內存泄漏就解決了。

注意：

1） 添加這個Listener後，默認在tomcat關閉5s後jvm會進行內存回收的操做，具體時間設置可在下面的第三個參考連接中找到，因此，在關閉後的5s內，再次啓動tomcat，可能會存在問題，致使啓動無效（若是出現tomcat重啓後日志顯示正常可是服務器不工做的話考慮一下是否是這個問題）。

2）這個Listener只解決部署的內存泄漏，其餘問題（如jdbc等）產生的內存泄漏還須要本身解決。

參考：

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

 

4，錯誤排除。

(1) 執行tomcat7:deploy顯示Build Success成功可是沒有效果，也沒有在本地生成war包，檢查一下maven配置文件中packaging標籤是否設置爲war。即：

<packaging>war</packaging>

若是不是（好比說是pom），那麼改爲war應該就能夠了。

(2) 若是出如今本地tomcat服務器自動部署沒有任何問題，部署到遠程服務器出現下面的Cannot invoke Tomcat manager: Connection reset by peer: socket write error 錯誤：

[ERROR] Failed to execute goal org.apache.tomcat.maven:tomcat7-maven-plugin:2.2:deploy (default-cli) on project webapp: Cannot invoke Tomcat manager: Connection reset by peer: socket write error -> [Help 1]
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.tomcat.maven:tomcat7-maven-plugin:2.2:deploy (default-cli) on project clyf_wechat: Cannot invoke Tomcat manager
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:212)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:153)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:145)
    at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:116)
    at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:80)
    at org.apache.maven.lifecycle.internal.builder.singlethreaded.SingleThreadedBuilder.build(SingleThreadedBuilder.java:51)
    at org.apache.maven.lifecycle.internal.LifecycleStarter.execute(LifecycleStarter.java:128)
    at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:307)
    at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:193)
    at org.apache.maven.DefaultMaven.execute(DefaultMaven.java:106)
    at org.apache.maven.cli.MavenCli.execute(MavenCli.java:863)
    at org.apache.maven.cli.MavenCli.doMain(MavenCli.java:288)
    at org.apache.maven.cli.MavenCli.main(MavenCli.java:199)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:497)
    at org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced(Launcher.java:289)
    at org.codehaus.plexus.classworlds.launcher.Launcher.launch(Launcher.java:229)
    at org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode(Launcher.java:415)
    at org.codehaus.plexus.classworlds.launcher.Launcher.main(Launcher.java:356)
Caused by: org.apache.maven.plugin.MojoExecutionException: Cannot invoke Tomcat manager
    at org.apache.tomcat.maven.plugin.tomcat7.AbstractCatalinaMojo.execute(AbstractCatalinaMojo.java:141)
    at org.apache.tomcat.maven.plugin.tomcat7.AbstractWarCatalinaMojo.execute(AbstractWarCatalinaMojo.java:68)
    at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:134)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:207)
    ... 20 more
Caused by: java.net.SocketException: Connection reset by peer: socket write error
    at java.net.SocketOutputStream.socketWrite0(Native Method)
    at java.net.SocketOutputStream.socketWrite(SocketOutputStream.java:109)
    at java.net.SocketOutputStream.write(SocketOutputStream.java:153)
    at org.apache.http.impl.io.AbstractSessionOutputBuffer.write(AbstractSessionOutputBuffer.java:181)
    at org.apache.http.impl.io.ContentLengthOutputStream.write(ContentLengthOutputStream.java:115)
    at org.apache.tomcat.maven.common.deployer.TomcatManager$RequestEntityImplementation.writeTo(TomcatManager.java:880)
    at org.apache.http.entity.HttpEntityWrapper.writeTo(HttpEntityWrapper.java:89)
    at org.apache.http.impl.client.EntityEnclosingRequestWrapper$EntityWrapper.writeTo(EntityEnclosingRequestWrapper.java:108)
    at org.apache.http.impl.entity.EntitySerializer.serialize(EntitySerializer.java:117)
    at org.apache.http.impl.AbstractHttpClientConnection.sendRequestEntity(AbstractHttpClientConnection.java:265)
    at org.apache.http.impl.conn.ManagedClientConnectionImpl.sendRequestEntity(ManagedClientConnectionImpl.java:203)
    at org.apache.http.protocol.HttpRequestExecutor.doSendRequest(HttpRequestExecutor.java:236)
    at org.apache.http.protocol.HttpRequestExecutor.execute(HttpRequestExecutor.java:121)
    at org.apache.http.impl.client.DefaultRequestDirector.tryExecute(DefaultRequestDirector.java:682)
    at org.apache.http.impl.client.DefaultRequestDirector.execute(DefaultRequestDirector.java:486)
    at org.apache.http.impl.client.AbstractHttpClient.doExecute(AbstractHttpClient.java:863)
    at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:82)
    at org.apache.tomcat.maven.common.deployer.TomcatManager.invoke(TomcatManager.java:742)
    at org.apache.tomcat.maven.common.deployer.TomcatManager.deployImpl(TomcatManager.java:705)
    at org.apache.tomcat.maven.common.deployer.TomcatManager.deploy(TomcatManager.java:388)
    at org.apache.tomcat.maven.plugin.tomcat7.deploy.AbstractDeployWarMojo.deployWar(AbstractDeployWarMojo.java:85)
    at org.apache.tomcat.maven.plugin.tomcat7.deploy.AbstractDeployMojo.invokeManager(AbstractDeployMojo.java:82)
    at org.apache.tomcat.maven.plugin.tomcat7.AbstractCatalinaMojo.execute(AbstractCatalinaMojo.java:132)
    ... 23 more

使用mvn tomcat7:redeploy時出現以下狀況

 

通過查詢Tomcat文檔後發現，這是因爲Tomcat的遠程地址攔截器形成的結果，默認狀況下，Tomcat的Manager和Host-Manager只接受本機的請求，而要讓它接受遠程的請求，須要添加上面提到的manager.xml的配置（第一步配置過了就不要加了），也就是：

<?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能夠執行項目的部署、卸載等敏感操做，若是你只想容許特定的IP地址訪問Manager，可在上面的allow屬性中設置規則。具體規則設置見下面的連接：

http://tomcat.apache.org/tomcat-7.0-doc/config/valve.html#Remote_Address_Filter

問題說明：http://tomcat.apache.org/tomcat-7.0-doc/manager-howto.html#Configuring_Manager_Application_Access

(3)自動部署顯示成功，war包也上傳成功，可是war不自動解壓自動部署。

若是你在tomcat的server.xml中經過設置<Context>標籤來部署相同名稱的項目的話，maven發佈到該服務器的war不會被自動解壓，部署，更新，須要去掉server.xml中該項目的<Context>標籤。

 

 5. 其餘

若是想要實現對部署路徑加版本，可將上面tomcat7-maven-pluginconfiguration的path設置爲 

<path>/webapp#version</path>

的形式，部署後，當前項目在服務器端的路徑就是/webapp/version。舉個例子，若是path設置爲 test#1.0，那麼服務端項目實際的路徑就是/test/1.0。以下：

 

 

 

若是名字和版本號之間是兩個#，效果就是制定當前項目在manager網頁中顯示的版本，路徑不變，舉個例子，path設置爲test##1.0，實際部署路徑爲/test，可是在manager網頁中，顯示以下，注意Version一欄的值：

 

參考：

http://tomcat.apache.org/tomcat-7.0-doc/config/context.html#Naming