`

Maven最佳实践：划分模块

 
阅读更多

原文地址：http://juvenshun.iteye.com/blog/305865

“分天下为三十六郡，郡置守，尉，监” —— 《史记·秦始皇本纪》

 

所有用Maven管理的真实的项目都应该是分模块的，每个模块都对应着一个pom.xml。它们之间通过继承和聚合（也称作多模块，multi-module）相互关联。那么，为什么要这么做呢？我们明明在开发一个项目，划分模块后，导入Eclipse变成了N个项目，这会带来复杂度，给开发带来不便。

 

为了解释原因，假设有这样一个项目，很常见的Java Web应用。在这个应用中，我们分了几层：

  • Dao层负责数据库交互，封装了Hibernate交互的类。
  • Service层处理业务逻辑，放一些Service接口和实现相关的Bean。
  • Web层负责与客户端交互，主要有一些Structs的Action类。

对应的，在一个项目中，我们会看到一些包名：

  • org.myorg.app.dao
  • org.myorg.app.service
  • org.myorg.app.web
  • org.myorg.app.util

这样整个项目的框架就清晰了，但随着项目的进行，你可能会遇到如下问题：

  1. 这个应用可能需要有一个前台和一个后台管理端（web或者swing），你发现大部分dao，一些service，和大部分util是在两个应用中可。这样的问题，你一周内遇到了好几次。
  2. pom.xml中的依赖列表越来越长以重用的，但是，由于目前只有一个项目（WAR），你不得不新建一个项目依赖这个WAR，这变得非常的恶心，因为在Maven中配置对WAR的依赖远不如依赖JAR那样简单明了，而且你根本不需要org.myorg.app.web。有人修改了dao，提交到svn并且不小心导致build失败了，你在编写service的代码，发现编译不过，只能等那人把dao修复了，你才能继续进行，很多人都在修改，到后来你根本就不清楚哪个依赖是谁需要的，渐渐的，很多不必要的依赖被引入。甚至出现了一个依赖有多个版本存在。
  3. build整个项目的时间越来越长，尽管你只是一直在web层工作，但你不得不build整个项目。
  4. 某个模块，比如util，你只想让一些经验丰富的人来维护，可是，现在这种情况，每个开发者都能修改，这导致关键模块的代码质量不能达到你的要求。

我们会发现，其实这里实际上没有遵守一个设计模式原则：“高内聚，低耦合”。虽然我们通过包名划分了层次，并且你还会说，这些包的依赖都是单向的，没有包的环依赖。这很好，但还不够，因为就构建层次来说，所有东西都被耦合在一起了。因此我们需要使用Maven划分模块。

 

一个简单的Maven模块结构是这样的：

 

---- app-parent

             |-- pom.xml (pom)

             |

             |-- app-util

             |        |-- pom.xml (jar)

             |

             |-- app-dao

             |        |-- pom.xml (jar)

             |

             |-- app-service

             |        |-- pom.xml (jar)

             |

             |-- app-web

                      |-- pom.xml (war)   

 

上述简单示意图中，有一个父项目(app-parent)聚合很多子项目（app-util, app-dao, app-service, app-web）。每个项目，不管是父子，都含有一个pom.xml文件。而且要注意的是，小括号中标出了每个项目的打包类型。父项目是pom,也只能是pom。子项目有jar，或者war。根据它包含的内容具体考虑。

 

这些模块的依赖关系如下：

 

app-dao      --> app-util

app-service --> app-dao

app-web     --> app-service

 

注意依赖的传递性（大部分情况是传递的，除非你配置了特殊的依赖scope），app-dao依赖于app-util，app-service依赖于app-dao，于是app-service也依赖于app-util。同理，app-web依赖于app-dao,app-util。

 

用项目层次的划分替代包层次的划分能给我们带来如下好处：

  1. 方便重用，如果你有一个新的swing项目需要用到app-dao和app-service，添加对它们的依赖即可，你不再需要去依赖一个WAR。而有些模块，如app-util，完全可以渐渐进化成公司的一份基础工具类库，供所有项目使用。这是模块化最重要的一个目的。
  2. 由于你现在划分了模块，每个模块的配置都在各自的pom.xml里，不用再到一个混乱的纷繁复杂的总的POM中寻找自己的配置。
  3. 如果你只是在app-dao上工作，你不再需要build整个项目，只要在app-dao目录运行mvn命令进行build即可，这样可以节省时间，尤其是当项目越来越复杂，build越来越耗时后。
  4. 某些模块，如app-util被所有人依赖，但你不想给所有人修改，现在你完全可以从这个项目结构出来，做成另外一个项目，svn只给特定的人访问，但仍提供jar给别人使用。
  5. 多模块的Maven项目结构支持一些Maven的更有趣的特性（如DepencencyManagement），这留作以后讨论。

接下来讨论一下POM配置细节，实际上非常简单，先看app-parent的pom.xml：

Xml代码 复制代码 收藏代码
  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">  
  3.     <modelVersion>4.0.0</modelVersion>  
  4.     <groupId>org.myorg.myapp</groupId>  
  5.     <artifactId>app-parent</artifactId>  
  6.     <packaging>pom</packaging>  
  7.     <version>1.0-SNAPSHOT</version>  
  8.     <modules>  
  9.         <module>app-util</module>  
  10.         <module>app-dao</module>  
  11.         <module>app-service</module>  
  12.         <module>app-web</module>  
  13.     </modules>  
  14. </project>   
<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>org.myorg.myapp</groupId>
	<artifactId>app-parent</artifactId>
	<packaging>pom</packaging>
	<version>1.0-SNAPSHOT</version>
	<modules>
		<module>app-util</module>
		<module>app-dao</module>
		<module>app-service</module>
		<module>app-web</module>
	</modules>
</project>

Maven的坐标GAV（groupId, artifactId, version）在这里进行配置，这些都是必须的。特殊的地方在于，这里的packaging为pom。所有带有子模块的项目的packaging都为pom。packaging如果不进行配置，它的默认值是jar，代表Maven会将项目打成一个jar包。

该配置重要的地方在于modules，例子中包含的子模块有app-util, app-dao, app-service, app-war。在Maven build app-parent的时候，它会根据子模块的相互依赖关系整理一个build顺序，然后依次build。

这就是一个父模块大概需要的配置，接下来看一下子模块符合配置继承父模块。、

Xml代码 复制代码 收藏代码
  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">  
  3.     <parent>  
  4.         <artifactId>app-parent</artifactId>  
  5.         <groupId>org.myorg.myapp</groupId>  
  6.         <version>1.0-SNAPSHOT</version>  
  7.     </parent>  
  8.     <modelVersion>4.0.0</modelVersion>  
  9.     <artifactId>app-util</artifactId>  
  10.     <dependencies>  
  11.         <dependency>  
  12.             <groupId>commons-lang</groupId>  
  13.             <artifactId>commons-lang</artifactId>  
  14.             <version>2.4</version>  
  15.         </dependency>  
  16.     </dependencies>  
  17. </project>   
<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>app-parent</artifactId>
		<groupId>org.myorg.myapp</groupId>
		<version>1.0-SNAPSHOT</version>
	</parent>
	<modelVersion>4.0.0</modelVersion>
	<artifactId>app-util</artifactId>
	<dependencies>
		<dependency>
			<groupId>commons-lang</groupId>
			<artifactId>commons-lang</artifactId>
			<version>2.4</version>
		</dependency>
	</dependencies>
</project>

app-util模块继承了app-parent父模块，因此这个POM的一开始就声明了对app-parent的引用，该引用是通过Maven坐标GAV实现的。而关于项目app-util本身，它却没有声明完整GAV，这里我们只看到了artifactId。这个POM并没有错，groupId和version默认从父模块继承了。实际上子模块从父模块继承一切东西，包括依赖，插件配置等等。

此外app-util配置了一个对于commons-lang的简单依赖，这是最简单的依赖配置形式。大部分情况，也是通过GAV引用的。

再看一下app-dao，它也是继承于app-parent，同时依赖于app-util：

Xml代码 复制代码 收藏代码
  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">  
  3.     <parent>  
  4.         <artifactId>app-parent</artifactId>  
  5.         <groupId>org.myorg.myapp</groupId>  
  6.         <version>1.0-SNAPSHOT</version>  
  7.     </parent>  
  8.     <modelVersion>4.0.0</modelVersion>  
  9.     <artifactId>app-dao</artifactId>  
  10.     <dependencies>  
  11.         <dependency>  
  12.             <groupId>org.myorg.myapp</groupId>  
  13.             <artifactId>app-util</artifactId>  
  14.             <version>${project.version}</version>  
  15.         </dependency>  
  16.     </dependencies>  
  17. </project>   
<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>app-parent</artifactId>
		<groupId>org.myorg.myapp</groupId>
		<version>1.0-SNAPSHOT</version>
	</parent>
	<modelVersion>4.0.0</modelVersion>
	<artifactId>app-dao</artifactId>
	<dependencies>
		<dependency>
			<groupId>org.myorg.myapp</groupId>
			<artifactId>app-util</artifactId>
			<version>${project.version}</version>
		</dependency>
	</dependencies>
</project>

该配置和app-util的配置几乎没什么差别，不同的地方在于，依赖变化了，app-dao依赖于app-util。这里要注意的是version的值为${project.version}，这个值是一个属性引用，指向了POM的project/version的值，也就是这个POM对应的version。由于app-dao的version继承于app-parent，因此它的值就是1.0-SNAPSHOT。而app-util也继承了这个值，因此在所有这些项目中，我们做到了保持版本一致。

这里还需要注意的是，app-dao依赖于app-util，而app-util又依赖于commons-lang，根据传递性，app-dao也拥有了对于commons-lang的依赖。

app-service我们跳过不谈，它依赖于app-dao。我们最后看一下app-web：

Xml代码 复制代码 收藏代码
  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">  
  3.     <parent>  
  4.         <artifactId>app-parent</artifactId>  
  5.         <groupId>org.myorg.myapp</groupId>  
  6.         <version>1.0-SNAPSHOT</version>  
  7.     </parent>  
  8.     <modelVersion>4.0.0</modelVersion>  
  9.     <artifactId>app-web</artifactId>  
  10.     <packaging>war</packaging>  
  11.     <dependencies>  
  12.         <dependency>  
  13.             <groupId>org.myorg.myapp</groupId>  
  14.             <artifactId>app-service</artifactId>  
  15.             <version>${project.version}</version>  
  16.         </dependency>  
  17.     </dependencies>  
  18. </project>   
<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>app-parent</artifactId>
		<groupId>org.myorg.myapp</groupId>
		<version>1.0-SNAPSHOT</version>
	</parent>
	<modelVersion>4.0.0</modelVersion>
	<artifactId>app-web</artifactId>
	<packaging>war</packaging>
	<dependencies>
		<dependency>
			<groupId>org.myorg.myapp</groupId>
			<artifactId>app-service</artifactId>
			<version>${project.version}</version>
		</dependency>
	</dependencies>
</project>

app-web依赖于app-service，因此配置了对其的依赖。

由于app-web是我们最终要部署的应用，因此它的packaging是war。为此，你需要有一个目录src/main/webapp。并在这个目录下拥有web应用需要的文件，如/WEB-INF/web.xml。没有web.xml，Maven会报告build失败，此外你可能还会有这样一些子目录：/js, /img, /css ... 。

 

看看Maven是如何build整个项目的，我们在 app-parent 根目录中运行 mvn clean install ，输出的末尾会有大致这样的内容：

 

...

...

[INFO] [war:war]
[INFO] Packaging webapp
[INFO] Assembling webapp[app-web] in [/home/juven/workspaces/ws-others/myapp/app-web/target/app-web-1.0-SNAPSHOT]
[INFO] Processing war project
[INFO] Webapp assembled in[50 msecs]
[INFO] Building war: /home/juven/workspaces/ws-others/myapp/app-web/target/app-web-1.0-SNAPSHOT.war
[INFO] [install:install]
[INFO] Installing /home/juven/workspaces/ws-others/myapp/app-web/target/app-web-1.0-SNAPSHOT.war to /home/juven/.m2/repository/org/myorg/myapp/app-web/1.0-SNAPSHOT/app-web-1.0-SNAPSHOT.war
[INFO]
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO] ------------------------------------------------------------------------
[INFO] app-parent ............................................ SUCCESS [1.191s]
[INFO] app-util .............................................. SUCCESS [1.274s]
[INFO] app-dao ............................................... SUCCESS [0.583s]
[INFO] app-service ........................................... SUCCESS [0.593s]
[INFO] app-web ............................................... SUCCESS [0.976s]
[INFO] ------------------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4 seconds
[INFO] Finished at: Sat Dec 27 08:20:18 PST 2008
[INFO] Final Memory: 3M/17M
[INFO] ------------------------------------------------------------------------

 

注意Reactor Summary，整个项目根据我们希望的顺序进行build。Maven根据我们的依赖配置，智能的安排了顺序，app-util, app-dao, app-service, app-web。

 

最后，你可以在 app-web/target 目录下找到文件 app-web-1.0-SNAPSHOT.war ，打开这个war包，在 /WEB-INF/lib 目录看到了 commons-lang-2.4.jar，以及对应的app-util, app-dao, app-service 的jar包。Maven自动帮你处理了打包的事情，并且根据你的依赖配置帮你引入了相应的jar文件。

 

使用多模块的Maven配置，可以帮助项目划分模块，鼓励重用，防止POM变得过于庞大，方便某个模块的构建，而不用每次都构建整个项目，并且使得针对某个模块的特殊控制更为方便。本文同时给出了一个实际的配置样例，展示了如何使用Maven配置多模块项目。

分享到：
| Log4j基本使用方法
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    Maven多模块web应用实例

    10. **最佳实践(Best Practices)**：保持模块间的低耦合，合理划分模块，遵循约定优于配置的原则，定期更新依赖版本，以确保项目的安全性和稳定性。 总结来说，"Maven多模块web应用实例"是一个展示如何使用Maven...

    maven分模块整合ssm

    在“maven分模块整合ssm”中，我们需要创建多个Maven子模块来分别封装SSM框架的各个部分和业务逻辑，这通常包括以下几个模块： 1. **父模块（Parent）**：定义共有的依赖管理和版本控制，所有子模块都会继承父模块...

    Intellj IDEA+Maven如何构建多模块项目

    8. **最佳实践** - 将公共库、服务模块、Web模块等合理划分，保持模块间的低耦合。 - 使用Maven的Profile特性，针对不同环境（如开发、测试、生产）配置不同的属性值。 - 利用Maven的Plugin管理，自动化构建、...

    maven相关项目的示例

    8. Maven的最佳实践： - 保持POM.xml简洁清晰，避免过度配置。 - 定期更新依赖，确保使用的库是最新的，以获取安全修复和新特性。 - 使用统一的编码风格和构建流程，提高团队协作效率。 9. Maven与持续集成： -...

    maven软件管理及构件

    ### Maven软件管理及构件知识点详解 #### Maven概览与核心理念 **Maven**是一款由Apache组织提供的项目管理和综合工具，旨在简化Java项目的...通过遵循Maven的设计理念和最佳实践，可以显著提高开发效率和项目质量。

    maven 3.5.0

    ### Maven的最佳实践 1. **遵循约定优于配置原则**: Maven有许多默认设置，如源码目录结构，遵循这些约定可以使项目更易维护。 2. **合理使用依赖管理**: 尽量减少对具体版本的硬编码，利用 `...

    springmvc mybatis spring框架整合多模块实例jdk1.8 ,maven,

    标题中的"springmvc mybatis spring框架整合多模块实例jdk1.8 ,maven,"涉及到的是一个基于Java开发的Web应用程序，使用了Spring...这是一个学习SSM整合的好机会，可以帮助开发者熟悉这些流行框架的使用方法和最佳实践。

    java后台maven分项目模块框架(smr)

    总之，“java后台maven分项目模块框架(smr)”是一个综合了现代Java开发最佳实践的项目模板，涵盖了SpringMVC、MyBatis和Redis等核心技术，利用Maven实现了模块化开发，旨在提供一个高效、可扩展的后台开发基础。...

    Maven实战最清楚版

    - **6.9 小结**：总结Maven仓库的使用技巧和最佳实践。 #### 7. 生命周期和插件 - **7.1 何为生命周期**：Maven生命周期的定义及其作用。 - **7.2 生命周期详解** - **7.2.1 三套生命周期**：Maven中的三套主要...

    Maven权威指南,学习参考手册

    ### Maven权威指南：深入解析与实战应用 #### 引言：Maven——自动化构建与项目管理的...通过本书的学习，开发者能够掌握Maven的核心理念和最佳实践，从而提升项目构建的效率和质量，使项目管理更加规范化和自动化。

    Maven集成包

    **四、Maven的最佳实践** 1. **保持POM简洁**：避免过度配置，尽量使用标准约定。 2. **合理组织模块**：根据功能或层次结构划分模块，便于维护和复用。 3. **使用私有仓库**：对于公司内部库，建立私有仓库以提高...

    Maven使用讲解 .

    Maven最佳实践 - **保持POM简洁**: 避免过度配置，遵循最小化原则，尽量使用Maven默认配置。 - **使用版本管理**: 为项目依赖设置明确的版本号，避免使用最新的SNAPSHOT版本。 - **合理划分模块**: 根据功能或...

    maven多工程搭建过程

    六、最佳实践 - 维护清晰的模块划分，每个模块负责特定功能，避免模块间过于紧密耦合。 - 使用统一的命名规则，如`groupId.artifactId.moduleName`，方便理解和管理。 - 定期清理和更新Maven本地仓库，保持项目依赖...

    maven父子结构demo

    6. **最佳实践**：在创建父子结构时，应注意避免过于复杂的依赖关系，保持模块间的低耦合性。另外，合理划分模块，确保每个模块都有明确的职责，有助于项目的长期维护。 总的来说，"maven父子结构demo"是一个很好的...

    maven-multi-modules：使用Maven处理多个Java模块架构

    在实际开发中，我们还需要注意一些最佳实践，比如合理划分模块边界，避免循环依赖，以及定期更新依赖以获取最新的安全修复和功能增强。此外，使用Maven的生命周期和插件，可以定制更复杂的构建过程，如代码质量检查...

    干净的maven架构

    总之，一个“干净的Maven架构”意味着一个组织良好、易于维护和扩展的Java项目，它遵循最佳实践，充分利用Maven提供的功能，使得开发工作更加高效和有序。在实际工作中，这样的项目结构有助于提升团队的生产力，降低...

    maven-project-源码.rar

    【标题解析】：“maven-project-源码.rar”这个标题暗示了我们正在处理一个与Maven项目相关的源代码压缩文件。...通过解压和研究这个项目，开发者可以提升对Maven的掌握，并借鉴其设计模式和最佳实践。

    eclipse下创建ssm+MySQL+maven多模块项目

    在IT行业中，构建一个Web应用是一项基础且重要的任务。本教程将聚焦于使用Eclipse集成开发环境（IDE）创建...通过这个过程，新手可以了解到Java Web开发中的多个关键技术和最佳实践，为今后的项目开发打下坚实的基础。

    Maven基础讲义_maven_

    **四、Maven的最佳实践** 1. **保持POM简洁**：避免在POM中包含不必要的信息，只声明项目真正需要的依赖。 2. **使用版本管理**：尽量使用具体的版本号，避免使用`LATEST`或`SNAPSHOT`，以防止意外的版本变化。 3...

    ssm框架结合maven整合web项目源码

    8. **最佳实践**：在实际开发中，通常会采用Maven的模块化结构，将SSM项目划分为不同的子模块，如服务层、持久层、Web层等，以提高代码的可维护性和可复用性。 这个源码项目对于初学者来说，是一个很好的学习资源，...

Magicbox
Global site tag (gtag.js) - Google Analytics