基于maven使用IDEA创建多模块项目

超、凢脫俗 2022-05-31 01:22 311阅读 0赞

*   *  
 *  转自博客[点击打开链接][Link 1]
    
     *   *  [一 项目工程目录][Link 1]
         *  [二 创建父工程][Link 2]
         *  [三 创建公共工具类][Link 3]
         *  [三 创建开发项目][Link 4]
         *  [四 创建开发项目子模块][Link 5]
         *  [五 运行项目][Link 6]

鉴于最近学习一个分布式项目的开发，讲一下关于使用IntelliJ IDEA基于Maven创建多模块项目的实际开发，可能有不合适的地方，但是项目是可以跑通的，也请有不足之处，都提出来，一起讨论下。

### 一. 项目工程目录 ###

首先展示一下，最终整个项目的工程目录：

![projectTree][]

简单介绍一下目录结构：   
`common-parent`为所有项目的父项目，主要用来管理所有项目使用的jar包及其版本。   
`common-utils`为公共的工具类项目，继承父项目，它会被打成jar包供其它项目使用。   
`taotao-manager`为我们自己的项目，继承与我们的父项目。   
`taotao-manager-pojo`为我们自己项目的一个子模块，依赖与taotao-manager,打成jar包   
`taotao-manager-mapper`为我们自己项目的一个子模块，依赖与taotao-manager-pojo,打成jar包   
`taotao-manager-service`为我们自己项目的一个子模块，依赖与taotao-manager-mapper,打成jar包   
`taotao-manager-web`为我们自己项目的一个子模块，依赖与taotao-manager-service,打成war包

### 二. 创建父工程 ###

下面为具体操作：   
1. 首先打开IntelliJ IDEA，按下面步骤来：   
![createParent1][]   
或者第一次打开IDEA，   
![createParent2][]   
2. 来到创建目录，选择Empty project，next   
![createParent3][]  
3. 来到New Project页面，填写project name，选择Project location，点Finish   
![createParent4][]  
等待IDEA加载完成，进行下一步   
4. 选择File–>New–>Module,进入New Module页面：   
![createParent5][]   
5. 在New Module页面，按如下步骤操作：   
![createParent6][]  
6. 填写组织名称和项目名称，以及版本号   
![createParent7][]  
7. 配置本地maven目录及maven仓库配置文件   
![createParent8][]  
8. 创建父工程最后一步，给Module取名，及选择工作目录，选择完成   
![createParent9][]

等待生成pom文件，注意修改打包方式为pom，修改pom文件如下：(由于pom文件较长，只给出部分，获取所有，请关注[github][])

<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/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>cn.william</groupId>
        <artifactId>common-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
        <packaging>pom</packaging>
    
        <name>common-parent</name>
        <url>http://maven.apache.org</url>
    
        
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <junit.version>4.12</junit.version>
            ...(省略)
        </properties>
    
        <dependencyManagement>
            <dependencies>
                
                <dependency>
                    <groupId>joda-time</groupId>
                    <artifactId>joda-time</artifactId>
                    <version>${joda-time.version}</version>
                </dependency>
               ...(省略)
        </dependencyManagement>
    
        <build>
            <finalName>${project.artifactId}</finalName>
            <plugins>
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-resources-plugin</artifactId>
                    <version>2.7</version>
                    <configuration>
                        <encoding>UTF-8</encoding>
                    </configuration>
                </plugin>
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.5.1</version>
                    <configuration>
                        <source>1.8</source>
                        <target>1.8</target>
                        <encoding>UTF-8</encoding>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    
    </project>

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16
 *  17
 *  18
 *  19
 *  20
 *  21
 *  22
 *  23
 *  24
 *  25
 *  26
 *  27
 *  28
 *  29
 *  30
 *  31
 *  32
 *  33
 *  34
 *  35
 *  36
 *  37
 *  38
 *  39
 *  40
 *  41
 *  42
 *  43
 *  44
 *  45
 *  46
 *  47
 *  48
 *  49
 *  50
 *  51
 *  52
 *  53
 *  54
 *  55
 *  56
 *  57
 *  58

### 三. 创建公共工具类 ###

首先，公共工具类是继承自父项目common-parent的。   
需要注意的一点是一点，为了项目看起来为分模块的形式（类似在eclipse中开发），在创建common-utils中有一步需要注意：   
![createUtils1][]   
![createUtils2][]  
下一步特别注意，这一步会影响目录结构，   
![createUtils3][]  
![createUtils4][]  
![createUtils5][]  
![createUtils6][]

同样注意项目的打包方式为jar，和父项目有所不同。

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16
 *  17
 *  18
 *  19
 *  20
 *  21
 *  22
 *  23
 *  24
 *  25
 *  26
 *  27
 *  28
 *  29
 *  30
 *  31
 *  32

### 三. 创建开发项目 ###

创建开发项目taotao-manager，其创建步骤同上，同样是继承common-parent,同样修改其pom文件，详细如下：

<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/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>common-parent</artifactId>
            <groupId>cn.william</groupId>
            <version>1.0-SNAPSHOT</version>
            <relativePath>../common-parent/pom.xml</relativePath>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>taotao-manager</artifactId>
        <packaging>pom</packaging>
    
        <name>taotao-manager</name>
        <url>http://maven.apache.org</url>
        <modules>
            <module>taotao-manager-pojo</module>
            <module>taotao-manager-mapper</module>
            <module>taotao-manager-service</module>
            <module>taotao-manager-web</module>
        </modules>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        </properties>
    
        
        <dependencies>
            <dependency>
                <groupId>cn.william</groupId>
                <artifactId>common-utils</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
        </dependencies>
    
        <build>
            
            <plugins>
                <plugin>
                    <groupId>org.apache.tomcat.maven</groupId>
                    <artifactId>tomcat7-maven-plugin</artifactId>
                    <configuration>
                        <port>8080</port>
                        <path>/</path>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    
    
    </project>

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16
 *  17
 *  18
 *  19
 *  20
 *  21
 *  22
 *  23
 *  24
 *  25
 *  26
 *  27
 *  28
 *  29
 *  30
 *  31
 *  32
 *  33
 *  34
 *  35
 *  36
 *  37
 *  38
 *  39
 *  40
 *  41
 *  42
 *  43
 *  44
 *  45
 *  46
 *  47
 *  48
 *  49
 *  50
 *  51
 *  52

### 四. 创建开发项目子模块 ###

创建taotao-manager-pojo，mapper，service，web等子模块，详细如下：

1.  右键点击taotao-manager，选择New，Module，   
    ![createSon1][]  
    ![createSon2][]  
    这一步注意，与创建common-utils时不同，是将其子模块添加到taotao-manager目录下的：   
    ![createSon3][]  
    maven的相关配置，保持默认：   
    ![createSon4][]  
    注意子模块所在目录就好：   
    ![createSon5][]
2.  创建taotao-manager下其它子模块   
    上面说的时创建taotao-manager-pojo子模块，另外三个子模块的创建方式与其类似，有一点不同时，在创建taotao-manager-web子模块时，maven项目的类型选择如下：   
    ![createSon6][]
3.  修改子模块的pom文件

子模块pojo，mapper，service的打包方式全为jar，只有web子模块打包为war包。

pojo子模块，pom.xml详细如下：

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16
 *  17
 *  18
 *  19
 *  20
 *  21

mapper子模块依赖与pojo子模块，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/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>taotao-manager</artifactId>
            <groupId>cn.william</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>taotao-manager-mapper</artifactId>
        <packaging>jar</packaging>
    
        <name>taotao-manager-mapper</name>
        <url>http://maven.apache.org</url>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        </properties>
    
        <dependencies>
            
            <dependency>
                <groupId>cn.william</groupId>
                <artifactId>taotao-manager-pojo</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
            </dependency>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis-spring</artifactId>
            </dependency>
            <dependency>
                <groupId>com.github.miemiedev</groupId>
                <artifactId>mybatis-paginator</artifactId>
            </dependency>
            <dependency>
                <groupId>com.github.pagehelper</groupId>
                <artifactId>pagehelper</artifactId>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
            </dependency>
    
        </dependencies>
    </project>

service子模块依赖与mapper子模块，pom.xml详细如下：

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16
 *  17
 *  18
 *  19
 *  20
 *  21
 *  22
 *  23
 *  24
 *  25
 *  26
 *  27
 *  28
 *  29
 *  30
 *  31
 *  32
 *  33
 *  34
 *  35
 *  36
 *  37
 *  38
 *  39

web子模块依赖与service子模块，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">
        <parent>
            <artifactId>taotao-manager</artifactId>
            <groupId>cn.william</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
        <artifactId>taotao-manager-web</artifactId>
        <packaging>war</packaging>
        <name>taotao-manager-web Maven Webapp</name>
        <url>http://maven.apache.org</url>
        <dependencies>
            
            <dependency>
                <groupId>cn.william</groupId>
                <artifactId>taotao-manager-service</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
            ...（省略）
        </dependencies>
        <build>
            <finalName>taotao-manager-web</finalName>
        </build>
    </project>

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16
 *  17
 *  18
 *  19
 *  20
 *  21
 *  22
 *  23
 *  24
 *  25
 *  26

> 关于上面省略的部分，可查看github完整项目，地址：

### 五. 运行项目 ###

1.  创建index.jsp   
    至此，项目创建已经完成，我们可以在taotao-manager-web的webapp目录下创建index.jsp,详情如下：   
    ![createIndex][]
2.  使用tomcat插件   
    我们使用maven的tomcat插件来运行项目，在此之前，确保在taotao-manager的pom文件中配置了tomcat的插件：

...（省略）
    <build>
        
        <plugins>
            <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <configuration>
                    <port>8080</port>
                    <path>/</path>
                </configuration>
            </plugin>
        </plugins>
    </build>
    ...（省略）

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15

1.  配置Maven Tomcat Plugin运行web项目

（1） 添加新配置   
![mavenTomcatPlugin][]

![addPlugin][]

（2） 点击运行，或者点击旁边的debug   
![tomcatRun][]

（3） 出项错误   
出现错误，可能是common-parent和common-utils没有安装到本地仓库，出现的错误是找不到common-utils的jar包，那就需要我们安装一下。   
![mavenInstall][]

等待将jar包安装到本地仓库，稍微有点慢可能，耐心等。。。

安装完成之后，再次运行，出现下面的信息，证明运行成功：   
![runSuccess][]

通过浏览器访问：   
![browserSuccess][]

至此，我们的项目环境搭建成功，接下来就是实际的项目开发了。

[Link 1]: http://blog.csdn.net/williamhappy/article/details/54376855#%E4%B8%80-%E9%A1%B9%E7%9B%AE%E5%B7%A5%E7%A8%8B%E7%9B%AE%E5%BD%95
[Link 2]: http://blog.csdn.net/williamhappy/article/details/54376855#%E4%BA%8C-%E5%88%9B%E5%BB%BA%E7%88%B6%E5%B7%A5%E7%A8%8B
[Link 3]: http://blog.csdn.net/williamhappy/article/details/54376855#%E4%B8%89-%E5%88%9B%E5%BB%BA%E5%85%AC%E5%85%B1%E5%B7%A5%E5%85%B7%E7%B1%BB
[Link 4]: http://blog.csdn.net/williamhappy/article/details/54376855#%E4%B8%89-%E5%88%9B%E5%BB%BA%E5%BC%80%E5%8F%91%E9%A1%B9%E7%9B%AE
[Link 5]: http://blog.csdn.net/williamhappy/article/details/54376855#%E5%9B%9B-%E5%88%9B%E5%BB%BA%E5%BC%80%E5%8F%91%E9%A1%B9%E7%9B%AE%E5%AD%90%E6%A8%A1%E5%9D%97
[Link 6]: http://blog.csdn.net/williamhappy/article/details/54376855#%E4%BA%94-%E8%BF%90%E8%A1%8C%E9%A1%B9%E7%9B%AE
[projectTree]: /images/20220531/e611781cb0134466b12afde84db8a2b7.png
[createParent1]: /images/20220531/e8de609f6d7d4ec48aa995608096fd39.png
[createParent2]: /images/20220531/4ab6f18a6ed441fc891e3871fa49e620.png
[createParent3]: /images/20220531/68687421490a4a82a43994e597a6b069.png
[createParent4]: /images/20220531/2acc67fa04e648cabc5ca1174b162ab5.png
[createParent5]: /images/20220531/8ed44bc4cfbf4be381947639aeb860ca.png
[createParent6]: /images/20220531/f98003cd57ab4b259ecbdcfa1b613c52.png
[createParent7]: /images/20220531/87ceac3a8245471eb343b465d75ee8a1.png
[createParent8]: /images/20220531/a682f1a4f52245599316e2c6fa246bbd.png
[createParent9]: /images/20220531/be4226dbbe584c04ba6e67179e839838.png
[github]: http://blog.csdn.net/williamhappy/article/details/54376855
[createUtils1]: /images/20220531/17c3554bda0f481ca275f46bc5a8ef04.png
[createUtils2]: /images/20220531/8eb7e25b7bcc49d88c2a756f8645c779.png
[createUtils3]: /images/20220531/98f888b190764334b78a8a1afb8d2f51.png
[createUtils4]: /images/20220531/fb0642866bd74c16b221d5af0c292766.png
[createUtils5]: /images/20220531/0f4515f39b2048709b263301ca9a4a86.png
[createUtils6]: /images/20220531/445633eda1224e19aedfc1ab5c0d2e5c.png
[createSon1]: /images/20220531/a1e583e383384ebbbaa82f28c30eeab1.png
[createSon2]: /images/20220531/5f38749ba20d47c5bc06214bed2c3968.png
[createSon3]: /images/20220531/ea87e292b85d40a09d2ace8435617874.png
[createSon4]: /images/20220531/59f059d64acb42a9a8c787ba3779f131.png
[createSon5]: /images/20220531/5c5d67eead4a4fb1aaae30a4feaa65c6.png
[createSon6]: /images/20220531/141c718337774ca6887dd48872a3d022.png
[createIndex]: /images/20220531/3f036c6134c342e48495417559dca7bd.png
[mavenTomcatPlugin]: /images/20220531/2a9969f83708444aac6c60950a7cb97a.png
[addPlugin]: /images/20220531/38c570b134f3454c82417594e55f7f6e.png
[tomcatRun]: /images/20220531/aa90478babe440588debdf6e315f0153.png
[mavenInstall]: /images/20220531/9aeacc3755474c59acf486ece765d290.png
[runSuccess]: /images/20220531/ad265df6d12044169b8b0c153f4b6da7.png
[browserSuccess]: /images/20220531/124e08401c354e07aef3a32bff3477b9.png