開發(fā)過程使用Tomcat Maven插件持續(xù)快捷部署Web項(xiàng)目
我在平時(shí)工作中部署Web項(xiàng)目到測試服務(wù)器上的Tomcat時(shí)用的是Hudson。Hudson本身已經(jīng)跟SVN、Git、Maven集成并且支持添加各種插件。但如果使用Hudson,我需要配置兩個(gè)任務(wù):一個(gè)任務(wù)負(fù)責(zé)打包項(xiàng)目成WAR,另外一個(gè)任務(wù)負(fù)責(zé)部署打包好的WAR包到目標(biāo)服務(wù)器的Tomcat上。雖然任務(wù)只需要配置一次,但每次修改代碼提交后,都得切換到瀏覽器點(diǎn)Hudson構(gòu)建任務(wù)頁面上的Build Now按鈕,然后還得跳轉(zhuǎn)到另一個(gè)頁面觀察是否有報(bào)錯(cuò),然后再點(diǎn)擊執(zhí)行相應(yīng)的部署任務(wù)。煩不勝煩,偶然發(fā)現(xiàn)Tomcat Maven插件支持直接打包并部署項(xiàng)目到Tomcat中,嘗試一番后終于搞定,總結(jié)于此。
網(wǎng)上關(guān)于這個(gè)主題的文章也不少,過程也大同小異,但本文除了過程外還想記錄下我期間踩過的坑和關(guān)于這種部署方案的建議。
1、準(zhǔn)備工作
下載安裝并配置好Tomcat和Maven。
準(zhǔn)備好一個(gè)Maven Web項(xiàng)目。
2、Maven部署Web項(xiàng)目到Tomcat的配置
2.1、配置Tomcat角色
Maven自動(dòng)部署實(shí)際上調(diào)的是Tomcat安裝目錄下的manager功能。而為了能正常訪問http://localhost:8080/manager頁面,我們需要修改$TOMCAT_HOME/conf目錄下的tomcat-users.xml:
- <tomcat-users>
- <role rolename="tomcat"/>
- <role rolename="manager"/>
- <role rolename="manager-gui"/>
- <role rolename="manager-script" />
- <role rolename="admin-gui"/>
- <user username="tomcat" password="tomcat" roles="tomcat,manager,
- manager-gui,manager-script,admin-gui" />
- </tomcat-users>
2.2、修改pom.xml增加Tomcat Maven插件
我使用的Tomcat7,pom.xml中增加如下配置:
- <properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <spring.version>3.2.2.RELEASE</spring.version>
- <finalName>web-loab</finalName>
- </properties>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.tomcat.maven</groupId>
- <artifactId>tomcat7-maven-plugin</artifactId>
- <configuration>
- <url>http://localhost:8080/manager/text</url>
- <server>tomcat</server>
- <username>tomcat</username>
- <password>tomcat</password>
- <path>/${finalName}</path>
- </configuration>
- </plugin>
- </plugins>
- </build>
上面username、password來自tomcat-users.xml。server是Tomcat服務(wù)器名稱。path是訪問應(yīng)用的路徑。url指定Tomcat管理頁路徑。
2.3、修改Maven的settings.xml
在$USER_HOME/.m2目錄下找到settings.xml,添加server節(jié)點(diǎn):
- <servers>
- <server>
- <id>tomcat</id>
- <username>tomcat</username>
- <password>tomcat</password>
- </server>
- </servers>
上面的username、password依然與tomcat-users.xml中相同,id與2.2中的server相同
2.4、部署項(xiàng)目到Tomcat
先確保Tomcat服務(wù)器已經(jīng)啟動(dòng),然后cd到項(xiàng)目根目錄,運(yùn)行下面的命令:
- mvn clean tomcat7:redeploy
部署成功,如下:
然后我們就能在Tomcat安裝目錄的webapps目錄下找到新部署的WAR包。
初次部署用的是tomcat7:deploy命令,重新部署可以用tomcat7:redeploy命令(推薦統(tǒng)一用這個(gè)),Tomcat Maven插件支持的命令包括:run、shutdown、run-war-only、exec-war、standalone-war-only、deploy、standalone-war、undeploy、run-war、redeploy等。
3、踩過的坑
光看上面的過程,似乎非常順暢,但世上的事總是不會(huì)那么順利的。下面列舉幾個(gè)我踩過的坑。
3.1、Windows系統(tǒng)下,redeploy過程無法刪除舊項(xiàng)目的目錄
報(bào)錯(cuò)信息在$TOMCAT_HOME/logs下的catalina日志文件中,如下:
- 信息: Undeploying context [/web-loab]
- 十月 11, 2014 3:52:26 下午 org.apache.catalina.startup.ExpandWar deleteDir
- 嚴(yán)重: [D:\tomcat\apache-tomcat-7.0.56\webapps\web-loab\WEB-INF] could not be completely deleted. The presence of the remaining files may cause problems
大概是因?yàn)門omcat還在使用這個(gè)目錄,無法刪除,必須修改$TOMCAT_HOME/conf/context.xml:
- <Context antiJARLocking="true" antiResourceLocking="true">
3.2、Servelt.class offending
這個(gè)問題應(yīng)該不屬于本文主題范疇了,但可能因?yàn)檫@個(gè)導(dǎo)致Web項(xiàng)目啟動(dòng)起來卻無法訪問,報(bào)錯(cuò)信息如下:
- 十月 11, 2014 3:46:29 下午 org.apache.catalina.loader.WebappClassLoader validateJarFile
- 信息: validateJarFile(D:\tomcat\apache-tomcat-7.0.56\webapps\web-loab\WEB-INF\lib\servlet-api-6.0.29.jar) - jar not loaded. See Servlet Spec 3.0, section 10.7.2. Offending class: javax/servlet/Servlet.class
原因是webapps目錄下的某個(gè)Web項(xiàng)目的WEB-INF/lib目錄下有servlet-api.jar,刪除之,并在pom.xml中指定servelt-api.jar的scope為provided:
- <dependency>
- <groupId>org.apache.tomcat</groupId>
- <artifactId>servlet-api</artifactId>
- <version>6.0.29</version>
- <scope>provided</scope>
- </dependency>
3.3、版本問題
確保Web項(xiàng)目的Java Build Path使用的JDK版本、Java Compiler的編譯JDK版本以及Project Facets里的Java版本一致。
如果用的Tomcat6,則pom.xml中配置tomcat6-maven-plugin,如果用的tomcat7則用tomcat7-maven-plugin?;蛘吣J(rèn)用tomcat-maven-plugin。
4、有關(guān)使用Tomcat Maven插件部署項(xiàng)目的一些建議
這種方案能夠?qū)崿F(xiàn)持續(xù)快捷部署。但它有一些局限性:
-
要求從本地開發(fā)環(huán)境能直接訪問Tomcat服務(wù)器所在網(wǎng)段
-
不能保留歷史部署包
因此初步建議只在開發(fā)環(huán)境使用這種部署方式,并且結(jié)合SVN、Git等版本控制軟件做兩個(gè)內(nèi)部約定:
-
所有可部署版本代碼都必須先簽入一個(gè)名為deploy-xx的分支,xx表示當(dāng)前可部署版本,deploy分支代碼必須保證是可以部署的代碼,然后切到deploy-xx分支再部署項(xiàng)目
-
以后增加了新功能,則需新建另一個(gè)deploy分支,并增大版本號。這樣可以利用版本控制軟件幫我們保留各個(gè)歷史可部署代碼(解決了上面提到的第二個(gè)局限性)。尤其是多個(gè)項(xiàng)目集成時(shí),***保證每一次集成時(shí)各個(gè)項(xiàng)目的deploy分支帶的版本后綴相同。這樣可以方便各個(gè)項(xiàng)目代碼集體回滾