创建支持eclipse的多模块maven项目

date: 2013-07-19 17:46

创建支持eclipse的多模块maven项目

通过maven可以创建多个关联模块的项目（Multiple Module Projects）。由一个总的模块，下面包含多个子模块（子模块还可以包含子模块）。这种maven功能能支持大型的项目构建，往往大型项目由很多子模块组成。

以下说明在eclipse下如何创建多模块的maven项目。

创建总的POM

mvn archetype:create -DgroupId=com.easymorse.marshal -DartifactId=multi-modules-demo

创建一个maven项目，然后修改该项目的pom.xml文件，package类型改为pom：

<packaging>pom</packaging>

并且删除src目录

创建子模块

在总模块目录下，创建子模块，比如web-demo：

mvn archetype:create -DgroupId=com.easymorse.marshal -DartifactId=web-demo

再创建一个比如日志模块：

mvn archetype:create -DgroupId=com.easymorse.marshal -DartifactId=logging-demo

在总pom的pom.xml文件中已经自动加入：

<modules>
    <module>web-demo</module>
    <module>logging-demo</module>
</modules>

在各子模块的pom.xml文件中也自动加入了：

<parent>
  <artifactId>multi-modules-demo</artifactId>
  <groupId>com.easymorse.marshal</groupId>
  <version>1.0-SNAPSHOT</version>
</parent>

子模块继承了总POM的package，这里需要修改，web-demo模块覆盖为：

<packaging>war</packaging>

logging-demo模块修改为：

<packaging>jar</packaging>

对上级模块的特别设置

需要在上级模块中设置java编译的参数，现在eclipse一般都使用比较新的版本，默认jdk是1.6，而maven默认还是1.4。

<plugin>
    <artifactId>maven-compiler-plugin</artifactId>
    <configuration>
        <source>1.6</source>
        <target>1.6</target>
        <encoding>UTF-8</encoding>
    </configuration>
</plugin>

对web子模块的特别设置

web子模块（web-demo）依赖它的日志模块logging-demo。设置pom.xml：

<dependency>
  <groupId>com.easymorse.marshal</groupId>
  <artifactId>logging-demo</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

web子模块在生成eclipse项目时，需要wtp支持，需要设置eclipse插件：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-eclipse-plugin</artifactId>
            <configuration>
                <wtpmanifest>true</wtpmanifest>
                <wtpapplicationxml>true</wtpapplicationxml>
                <wtpversion>2.0</wtpversion>
            </configuration>
        </plugin>
    </plugins>
</build>

生成Eclipse项目

在multi-modules-demo项目根目录下：

mvn eclipse:eclipse

然后，通过eclipse的import项目导入，可发现两个项目：

1. logging-demo
2. web-demo

都导入进来。导入可能会出现错误，主要是因为没有设置maven的类路径变量“M2_REPO”，可以设置这个类变量到maven的本地repository陌路即可。

如果要在eclipse中使用m2eclipse，需要使用

mvn eclipse:m2eclipse

这样就不需要设置M2_REPO类库变量了。

接下来

接下来可以：

1. 通过eclipse配置的tomcat运行web-demo；
2. 通过maven的tomcat或者jetty插件运行web-demo（需要配置pom.xml文件）；
3. 为项目打包便于分发和部署。

以上内容摘自：http://marshal.easymorse.com/archives/873

扩展阅读：http://www.infoq.com/cn/news/2011/01/xxb-maven-3-pom-refactoring