Eclipse中的Maven项目一键部署到Tomcat服务器 - 支持多环境部署
场景说明：
Java Maven Web项目编译、打包后，需要一键部署到研发或者测试服务器上，不用人工手动传包或者手动操作。利用Tomcat的热部署功能实现。
环境及工具：
Windows 7 64bit Tomcat7 JDK1.7_0_55 Eclipse Kepler Service Release 2 Maven 3.0.4 Spring4.0 JUnit4.9 logback1.1.3
异常情况：
在项目搭建时，可能出现各种异常情况，比较常见的问题我记录下来，仅供参考。请参见最后章节：9 异常问题
项目下载：
链接：http://pan.baidu.com/s/1gdzxWRp 密码：2z0d
项目说明：
1. 创建Java Web Maven项目
在Eclipse新建一个Maven project
选择maven-archetype-webapp,创建Web项目
输入Group Id等信息，点击FINISH完成项目创建。
项目创建完成后，右键点击项目，选择配置项目，在Java Build Path选项中，修改默认的输出目录dev/target/classes
另外在Web Deployment Assembly项目部署选项中，删除不需要的项
2. 多环境配置文件和目录
在src/main/resources目录创建三个目录dev、pro、test
conf-sys.properties 测试环境=test，生产环境=pro ,就这个文件三个环境有不一样，其他配置文件三个环境的都一样，这是为了区分编译打包后每个环境配置不一样
# properties
propertiesName=devlogback.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<configuration>
<!--appender 输出目录 -->
<property name="log.base" value="/opt/logs/dev"/>
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%level] %class{5} - %msg%n</pattern>
</encoder>
</appender>
<!-- 文件输出 -->
<appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>${log.base}/dev.log</File>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.base}/dev-%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 编码格式解析器 -->
<encoder>
<pattern>%date{yyyy-MM-dd HH:mm:ss} [%logger{5}]-[%le] - %m%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="stdout" />
</root>
</configuration> spring-config.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
<context:property-placeholder location="classpath*:conf-*.properties" />
<!-- 扫描注解Bean -->
<context:component-scan base-package="com.hs.maven">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller" />
</context:component-scan>
</beans>spring-mvc.xml
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 启动Springmvc注解驱动 -->
<mvc:annotation-driven/>
<context:property-placeholder location="classpath*:conf-*.properties" />
<!-- 开启controller注解支持 -->
<context:component-scan base-package="com.hs.maven.controller" use-default-filters="false">
<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller" />
<context:include-filter type="annotation" expression="org.springframework.web.bind.annotation.ControllerAdvice" />
</context:component-scan>
<!-- 映射静态资源 -->
<mvc:default-servlet-handler />
<!-- 配置处理静态资源的请求 -->
<mvc:resources mapping="/static/**" location="/WEB-INF/static/" />
<!-- 配置视图解析器 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="viewResolver">
<!-- 模板路径为WEB-INF/pages/ -->
<property name="prefix">
<value>/WEB-INF/pages/</value>
</property>
<!-- 视图模板后缀为.JSP -->
<property name="suffix">
<value>.jsp</value>
</property>
</bean>
</beans>创建一个Spring MVC的控制器
package com.hs.maven.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
/**
* @author hushuang
*
*/
@Controller
public class DevController {
private static Logger log = LoggerFactory.getLogger(DevController.class);
/** 配置文件名称，早conf-sys.properties文件中定义，区分不同打包指令后各环境的配置文件内容 */
@Value("${propertiesName}")
private String propertiesName;
/**
* 登录
* @return String
*/
@RequestMapping("/login")
public String login(Model model) {
log.info(propertiesName + "Login!");
model.addAttribute("user", propertiesName);
return "index";
}
}
3. web.xml配置文件
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" metadata-complete="true" version="3.0">
<display-name>dev</display-name>
<!-- Spring -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
classpath:spring-config.xml
</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<listener>
<listener-class>org.springframework.web.context.request.RequestContextListener</listener-class>
</listener>
<!-- 编码 -->
<filter>
<filter-name>Set Character Encoding</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<async-supported>true</async-supported>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>Set Character Encoding</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!-- Spring Mvc -->
<servlet>
<servlet-name>spring</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
<async-supported>true</async-supported>
</servlet>
<servlet-mapping>
<servlet-name>spring</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
4. 测试页面
login.html放到static目录下是为了避开控制器的拦截
index.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<h3> ${user}登录成功！</h3>
</body>
</html>login.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<a href="../login">登录</a>
</body>
</html>5. Maven pom.xml配置文件
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.hs</groupId>
<artifactId>dev</artifactId>
<packaging>war</packaging>
<version>0.0.1-SNAPSHOT</version>
<name>dev Maven Webapp</name>
<url>http://maven.apache.org</url>
<dependencies>
<!-- 测试 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.9</version>
<scope>test</scope>
</dependency>
<!-- 日志 -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.1.3</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.3</version>
</dependency>
<!-- spring -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>4.0.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>4.0.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>4.0.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>4.0.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>4.0.0.RELEASE</version>
</dependency>
<!-- Servlet -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.0.1</version>
<scope>provided</scope>
</dependency>
<!-- <dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.2</version>
</dependency> -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
</dependencies>
<!-- 配置文件 -->
<profiles>
<profile><!-- 研发环境 -->
<id>development</id>
<properties>
<profiles.active>dev</profiles.active><!-- Tomcat7的部署url是manager/text Tomcat6没有/text -->
<deploy.url>http://192.168.0.100:8080/manager/text</deploy.url>
</properties>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
</profile>
<profile><!-- 测试环境 -->
<id>test</id>
<properties>
<profiles.active>test</profiles.active>
<deploy.url>http://192.168.0.200:8080/manager/text</deploy.url>
</properties>
</profile>
<profile>
<!-- 生产环境 (出于安全考虑，一般生产环境不能自动部署，也不会开放端口，需要人工处理，这里的配置用来打包) -->
<id>production</id>
<properties>
<profiles.active>pro</profiles.active>
<deploy.url>http://www.app.cn:8080/manager/text</deploy.url>
</properties>
</profile>
</profiles>
<build>
<finalName>dev</finalName>
<!-- 打包配置文件管理 -->
<resources>
<!-- 代码生成器配置文件过滤 -->
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<excludes>
<exclude>**/generatorConfig.xml</exclude>
</excludes>
<filtering>true</filtering>
</resource>
<!-- 所有环境配置文件过滤 -->
<resource>
<directory>src/main/resources</directory>
<excludes>
<exclude>test/*</exclude>
<exclude>pro/*</exclude>
<exclude>dev/*</exclude>
</excludes>
</resource>
<!-- 指定环境配置文件导入 -->
<resource>
<directory>src/main/resources/${profiles.active}</directory>
</resource>
</resources>
<plugins>
<!-- 编译 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.2</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
</configuration>
</plugin>
<!-- 打包 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.4</version>
<!-- <configuration>
<webResources>
<resource>
<directory>webapp</directory>
</resource>
</webResources>
</configuration> -->
</plugin>
<!-- 自动部署 -->
<plugin>
<groupId>org.codehaus.cargo</groupId>
<artifactId>cargo-maven2-plugin</artifactId>
<version>1.1.3</version>
<configuration>
<wait>true</wait>
<container>
<containerId>tomcat7x</containerId>
<type>remote</type>
</container>
<configuration>
<type>runtime</type>
<properties>
<cargo.remote.uri>${deploy.url}</cargo.remote.uri>
<pre name="code" class="html"> <!-- Tomcat配置的用户名密码， 见Tomcat自动部署支持章节 -->6. Maven pom.xml文件【Run As】自定义指令运行配置
一般运行maven都是右键点击pom.xml文件，选择运行一个已经配置好的maven指令
但是在使用中，这种功能和效率都达不到我们的要求，这时需要配置自定义指令配置，一般会配置5条自定义指令：
说明：
Name: 显示名称
Base directory: 项目绝对地址目录
Goals: maven执行指令 指令中的-D表示参数，如果是研发环境就是dev，生产是pro
Skip Tests 表示选中跳过测试
1. 研发环境打包指令
Name: dev-dev-package
Base directory: E:/workspace/dev
Goals: clean package -Ddev
Skip Tests
2. 研发环境部署指令
Name: dev-dev-deploy
Base directory: E:/workspace/dev
Goals: cargo:redeploy -Ddev
Skip Tests
3. 测试环境打包指令
Name: dev-test-package
Base directory: E:/workspace/dev
Goals: clean package -Dtest
Skip Tests
4. 测试环境部署指令
Name: dev-test-deploy
Base directory: E:/workspace/dev
Goals: cargo:redeploy -Dtest
Skip Tests
5. 生产环境打包指令
Name: dev-pro-deploy
Base directory: E:/workspace/dev
Goals: cargo:redeploy -Dpro
Skip Tests
7. Tomcat自动部署支持
需要在Tomcat配置目录conf下的tomcat-users.xml配置tomcat用户的角色和权限，下面的配置为我们tomcat-username这个用户配置了管理权限，可以向tomcat部署应用
<?xml version="1.0" encoding="UTF-8"?>
<tomcat-users>
<role rolename="manager-script"/>
<role rolename="manager-jmx"/>
<role rolename="manager-status"/>
<role rolename="manager"/>
<role rolename="manager-gui"/>
<user username="tomcat-username" password="tomcat-password" roles="manager,manager-gui,manager-script,manager-jmx,manager-status"/>
</tomcat-users>manager-gui
允许访问html接口(即URL路径为/manager/html/*)
manager-script
允许访问纯文本接口(即URL路径为/manager/text/*)
manager-jmx
允许访问JMX代理接口(即URL路径为/manager/jmxproxy/*)
manager-status
允许访问Tomcat只读状态页面(即URL路径为/manager/status/*)
从Tomcat Manager内部配置文件中可以得知，manager-gui、manager-script、manager-jmx均具备manager-status的权限，也就是说，manager-gui、manager-script、manager-jmx三种角色权限无需再额外添加manager-status权限，即可直接访问路径"/manager/status/*"。
8. 运行验证
Maven自定义指令和Tomcat的权限配置完成后，就可以使用指令打包和部署了，右键点击pom.xml文件，选择【Run As】 第一个【Maven build】就会弹出一个指令选择框，选中要执行的指令，在Console窗口就会看到执行结果，如果是 BUILD SUCCESS就说明成功了。
如果是项目部署，也是一样，注意用户名密码和pom.xml的一致，执行部署指令，就能将项目一键部署到服务器。然后在浏览器中输入部署服务器的地址，就能看到登录信息，登录完成后就可以看到是那个用户登录的。如果是测试用户打包，部署后就会是test登录成功。
总结：通过maven的部署插件和tomcat的热部署功能，可以方便快捷的将代码部署到研发和测试环境，并且减轻研发人员部署验证的工作，提高工作效率。
9 异常问题
如果你准备按照我的demo动手做一次，你可能会遇到一些问题，下面是我走过的坑，如果遇到，可以参考，如果你遇到的问题跟我的不一样，不要慌，静下心，对问题一点点的抽丝剥茧，总能解决，半个小时解决不了，问问身边的同事，然后百度、google，实在解决不来，静下心来慢慢排查，问题肯定能解决。
（1）Cannot change version of project facet Dynamic Web Module to 3.0.
项目的web版本异常，这个是出现比较多的问题，修改项目.settings目录下org.eclipse.wst.common.project.facet.core.xml文件，将<installed facet="jst.web" version="x.x"/>改为<installed facet="jst.web" version="3.0"/>，然后右键点击项目》Maven》Update Project就可以了。
项目中jsp-api.jar包冲突，注释掉pom.xml的配置。我已经注释掉了，如果你的环境提示缺少此jar包可以打开。
（3）项目部署后，日志是debug模式，启动只打印Tomcat日志，没有项目启动日志
如下图中红色字体是tomcat日志，黑色字体是项目日志，如果没有黑色字体部分的日志
此问题一般都是项目部署目录错误的配置导致的，在项目的部署选项中，一定要检查清楚
1262
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
