我们为什么要进行模块化开发?
在多人使用Maven协作开发项目时,尤其是稍微上点规模的项目,每个RD的工作都细分到具体功能和模块,有些模块甚至还要单独部署。
我们假设有这样一个商城项目,包括以下几个模块:
商城前台(shop)
管理后台(admin)
数据库交互模块(dao)
通用业务模块(service)
接口模块(api)
通用工具(util)
其中shop和admin需要单独部署,dao、service、util你可能想要一些经验丰富的人来维护,如果使用一个应用来管理的话,所有的功能和模块都会耦合在一起,所有人都可以随意修改代码,这显然不是我们所期望的。
而且使用一个应用来管理的话,任何一个点的代码有变更,整个项目就需要重新build,使用模块化开发的另一个好处是如果dao的代码被修改,只需要重新build dao模块就可以了。web模块可以build成war,dao、service、util等可以build成jar,只需要配置好依赖关系,就可以实现模块间的解耦合。这样的设计才是遵循“高内聚,低耦合”设计原则的。
二 分模块开发的好处
用Maven管理的比较大的项目大部分都是分模块的,每个模块都对应着一个pom.xml。它们之间通过继承和聚合相互关联。那么,为什么要这么做呢?我们明明在开发一个项目,划分模块后,导入Eclipse变成了N个项目,这样岂不带来复杂度,给开发带来不便?
为了解释原因,假设有这样一个项目,很常见的spring+spring mvc+mybatis整合开发的web应用。在这个应用中,我们分了几层:
1) entity层即实体层,也即放置PO类还有跟PO类相关联的配置文件。
2) Dao层负责数据库交互,封装了Hibernate交互的类。
3) Service层处理业务逻辑,放一些Service接口和实现相关的Bean。
4) Web层负责与客户端交互,主要有一些Structs的Action类。
对应的,在该项目中,我们会看到如下一些包名:
1) com.mycom.com.entitys
2) com.mycom.com.dao
3) com.mycom.com.service
4) com.mycom.com.web
这样整个项目的框架就清晰了,但随着项目的进行,你可能会遇到如下问题:
Ø 这个应用可能需要有一个前台和一个后台管理端,你发现大部分entitys,一些service,和大部分dao是在两个应用中可通用的。这样的问题,你一周内遇到了好几次。
Ø pom.xml中的依赖列表越来越长,但是,由于目前只有一个项目(WAR),你不得不新建一个项目依赖这个WAR,这变得非常的恶心,因为在Maven中配置对WAR的依赖远不如依赖JAR那样简单明了,而且你根本不需要org.myorg.app.web。有人修改了dao,提交到svn并且不小心导致build失败了,你在编写service的代码,发现编译不过,只能等那人把dao修复了,你才能继续进行,很多人都在修改,到后来你根本就不清楚哪个依赖是谁需要的,渐渐的,很多不必要的依赖被引入。甚至出现了一个依赖有多个版本存在。
Ø build整个项目的时间越来越长,尽管你只是一直在web层工作,但你不得不build整个项目。
Ø 某个模块,比如dao,你只想让一些经验丰富的人来维护,可是,现在这种情况,每个开发者都能修改,这导致关键模块的代码质量不能达到你的要求。
我们会发现,其实这里实际上没有遵守一个设计模式原则:“高内聚,低耦合”。虽然我们通过包名划分了层次,并且你还会说,这些包的依赖都是单向的,没有包的环依赖。这很好,但还不够,因为就构建层次来说,所有东西都被耦合在一起了。因此我们需要使用Maven划分模块。
目录
Maven学习总结(八)——使用Maven构建多模块项目
在平时的Javaweb项目开发中为了便于后期的维护,我们一般会进行分层开发,最常见的就是分为domain(域模型层)、dao(数据库访问层)、service(业务逻辑层)、web(表现层),这样分层之后,各个层之间的职责会比较明确,后期维护起来也相对比较容易,今天我们就是使用Maven来构建以上的各个层。
项目结构如下:
system-parent
|----pom.xml
|----system-domain
|----pom.xml
|----system-dao
|----pom.xml
|----system-service
|----pom.xml
|----system-web
|----pom.xml
一、创建system-parent项目
创建system-parent,用来给各个子模块继承。
进入命令行,输入以下命令:
mvn archetype:create -DgroupId=me.gacl -DartifactId=system-parent -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
如下图所示:
命令执行完成之后可以看到在当前目录(C:\Documents and Settings\Administrator)生成了system-parent目录,里面有一个src目录和一个pom.xml文件,如下图所示:
将src文件夹删除,然后修改pom.xml文件,将<packaging>jar</packaging>修改为<packaging>pom</packaging>,pom表示它是一个被继承的模块,修改后的内容如下:
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/xsd/maven-4.0.0.xsd"> 3 <modelVersion>4.0.0</modelVersion> 4 5 <groupId>me.gacl</groupId> 6 <artifactId>system-parent</artifactId> 7 <version>1.0-SNAPSHOT</version> 8 <packaging>pom</packaging> 9 10 <name>system-parent</name> 11 <url>http://maven.apache.org</url> 12 13 <properties> 14 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 15 </properties> 16 17 <dependencies> 18 <dependency> 19 <groupId>junit</groupId> 20 <artifactId>junit</artifactId> 21 <version>3.8.1</version> 22 <scope>test</scope> 23 </dependency> 24 </dependencies> 25 </project>
二、创建sytem-domain模块
在命令行进入创建好的system-parent目录,然后执行下列命令:
mvn archetype:create -DgroupId=me.gacl -DartifactId=system-domain -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
如下图所示:
命令执行完成之后可以看到在system-parent目录中生成了system-domain,里面包含src目录和pom.xml文件。如下图所示:
同时,在system-parent目录中的pom.xml文件自动添加了如下内容:
<modules> <module>system-domain</module> </modules>
这时,system-parent的pom.xml文件如下:
1 <?xml version="1.0" encoding="UTF-8"?> 2 <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"> 3 <modelVersion>4.0.0</modelVersion> 4 5 <groupId>me.gacl</groupId> 6 <artifactId>system-parent</artifactId> 7 <version>1.0-SNAPSHOT</version> 8 <packaging>pom</packaging> 9 10 <name>system-parent</name> 11 <url>http://maven.apache.org</url> 12 13 <properties> 14 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 15 </properties> 16 17 <dependencies> 18 <dependency> 19 <groupId>junit</groupId> 20 <artifactId>junit</artifactId> 21 <version>3.8.1</version> 22 <scope>test</scope> 23 </dependency> 24 </dependencies> 25 <modules> 26 <module>system-domain</module> 27 </modules> 28 </project>
修改system-domain目录中的pom.xml文件,把<groupId>me.gacl</groupId>和<version>1.0-SNAPSHOT</version>去掉,加上<packaging>jar</packaging>,因为groupId和version会继承system-parent中的groupId和version,packaging设置打包方式为jar
修改过后的pom.xml文件如下:
1 <?xml version="1.0"?> 2 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 4 <modelVersion>4.0.0</modelVersion> 5 <parent> 6 <groupId>me.gacl</groupId> 7 <artifactId>system-parent</artifactId> 8 <version>1.0-SNAPSHOT</version> 9 </parent> 10 11 <artifactId>system-domain</artifactId> 12 <packaging>jar</packaging> 13 14 <name>system-domain</name> 15 <url>http://maven.apache.org</url> 16 </project>
三、创建sytem-dao模块
在命令行进入创建好的system-parent目录,然后执行下列命令:
mvn archetype:create -DgroupId=me.gacl -DartifactId=system-dao -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
如下图所示:
命令执行完成之后可以看到在system-parent目录中生成了system-dao,里面包含src目录和pom.xml文件。如下图所示:
同时,在system-parent目录中的pom.xml文件自动变成如下内容:
1 <?xml version="1.0" encoding="UTF-8"?> 2 <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"> 3 <modelVersion>4.0.0</modelVersion> 4 5 <groupId>me.gacl</groupId> 6 <artifactId>system-parent</artifactId> 7 <version>1.0-SNAPSHOT</version> 8 <packaging>pom</packaging> 9 10 <name>system-parent</name> 11 <url>http://maven.apache.org</url> 12 13 <properties> 14 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 15 </properties> 16 17 <dependencies> 18 <dependency> 19 <groupId>junit</groupId> 20 <artifactId>junit</artifactId> 21 <version>3.8.1</version> 22 <scope>test</scope> 23 </dependency> 24 </dependencies> 25 <modules> 26 <module>system-domain</module> 27 <module>system-dao</module> 28 </modules> 29 </project>
修改system-dao目录中的pom.xml文件,,把<groupId>me.gacl</groupId>和<version>1.0-SNAPSHOT</version>去掉,加上<packaging>jar</packaging>,因为groupId和version会继承system-parent中的groupId和version,packaging设置打包方式为jar,同时添加对system-domain模块的依赖,修改后的内容如下:
1 <?xml version="1.0"?> 2 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 4 <modelVersion>4.0.0</modelVersion> 5 <parent> 6 <groupId>me.gacl</groupId> 7 <artifactId>system-parent</artifactId> 8 <version>1.0-SNAPSHOT</version> 9 </parent> 10 11 <artifactId>system-dao</artifactId> 12 <packaging>jar</packaging> 13 14 <name>system-dao</name> 15 <url>http://maven.apache.org</url> 16 <properties> 17 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 18 </properties> 19 <dependencies> 20 <!--system-dao需要使用到system-domain中的类,所以需要添加对system-domain模块的依赖--> 21 <dependency> 22 <groupId>me.gacl</groupId> 23 <artifactId>system-domain</artifactId> 24 <version>${project.version}</version> 25 </dependency> 26 </dependencies> 27 </project>
四、创建system-service模块
在命令行进入创建好的system-parent目录,然后执行下列命令:
mvn archetype:create -DgroupId=me.gacl -DartifactId=system-service -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
如下图所示:
命令执行完成之后可以看到在system-parent目录中生成了system-service,里面包含src目录和pom.xml文件。如下图所示:
同时,在system-parent目录中的pom.xml文件自动变成如下内容:
1 <?xml version="1.0" encoding="UTF-8"?> 2 <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"> 3 <modelVersion>4.0.0</modelVersion> 4 5 <groupId>me.gacl</groupId> 6 <artifactId>system-parent</artifactId> 7 <version>1.0-SNAPSHOT</version> 8 <packaging>pom</packaging> 9 10 <name>system-parent</name> 11 <url>http://maven.apache.org</url> 12 13 <properties> 14 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 15 </properties> 16 17 <dependencies> 18 <dependency> 19 <groupId>junit</groupId> 20 <artifactId>junit</artifactId> 21 <version>3.8.1</version> 22 <scope>test</scope> 23 </dependency> 24 </dependencies> 25 <modules> 26 <module>system-domain</module> 27 <module>system-dao</module> 28 <module>system-service</module> 29 </modules> 30 </project>
修改system-service目录中的pom.xml文件,,把<groupId>me.gacl</groupId>和<version>1.0-SNAPSHOT</version>去掉,加上<packaging>jar</packaging>,因为groupId和version会继承system-parent中的groupId和version,packaging设置打包方式为jar,同时添加对system-dao模块的依赖,system-service依赖system-dao和system-domain,但是我们只需添加system-dao的依赖即可,因为system-dao已经依赖了system-domain。修改后的内容如下:
1 <?xml version="1.0"?> 2 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 4 <modelVersion>4.0.0</modelVersion> 5 <parent> 6 <groupId>me.gacl</groupId> 7 <artifactId>system-parent</artifactId> 8 <version>1.0-SNAPSHOT</version> 9 </parent> 10 11 <artifactId>system-service</artifactId> 12 <packaging>jar</packaging> 13 14 <name>system-service</name> 15 <url>http://maven.apache.org</url> 16 <properties> 17 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 18 </properties> 19 <dependencies> 20 <!-- 21 system-service依赖system-dao和system-domain, 22 但是我们只需添加system-dao的依赖即可,因为system-dao已经依赖了system-domain 23 --> 24 <dependency> 25 <groupId>me.gacl</groupId> 26 <artifactId>system-dao</artifactId> 27 <version>${project.version}</version> 28 </dependency> 29 </dependencies> 30 </project>
五、创建system-web模块
在命令行进入创建好的system-parent目录,然后执行下列命令:
mvn archetype:create -DgroupId=me.gacl -DartifactId=system-web -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false
如下图所示:
命令执行完成之后可以看到在system-parent目录中生成了system-web,里面包含src目录和pom.xml文件。如下图所示:
在\system-web\src\main\webapp目录中还生成了一个简单的index.jsp,如下图所示:
里面的内容为
<html> <body> <h2>Hello World!</h2> </body> </html>
system-web\src\main\webapp\WEB-INF目录中生成了web.xml
同时,在system-parent目录中的pom.xml文件自动变成如下内容:
1 <?xml version="1.0" encoding="UTF-8"?> 2 <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"> 3 <modelVersion>4.0.0</modelVersion> 4 5 <groupId>me.gacl</groupId> 6 <artifactId>system-parent</artifactId> 7 <version>1.0-SNAPSHOT</version> 8 <packaging>pom</packaging> 9 10 <name>system-parent</name> 11 <url>http://maven.apache.org</url> 12 13 <properties> 14 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 15 </properties> 16 17 <dependencies> 18 <dependency> 19 <groupId>junit</groupId> 20 <artifactId>junit</artifactId> 21 <version>3.8.1</version> 22 <scope>test</scope> 23 </dependency> 24 </dependencies> 25 <modules> 26 <module>system-domain</module> 27 <module>system-dao</module> 28 <module>system-service</module> 29 <module>system-web</module> 30 </modules> 31 </project>
修改system-web目录中的pom.xml文件,,把<groupId>me.gacl</groupId>和<version>1.0-SNAPSHOT</version>去掉,因为groupId和version会继承system-parent中的groupId和version,同时添加对system-service模块的依赖,修改后的内容如下:
1 <?xml version="1.0"?> 2 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 4 <modelVersion>4.0.0</modelVersion> 5 <parent> 6 <groupId>me.gacl</groupId> 7 <artifactId>system-parent</artifactId> 8 <version>1.0-SNAPSHOT</version> 9 </parent> 10 11 <artifactId>system-web</artifactId> 12 <packaging>war</packaging> 13 14 <name>system-web Maven Webapp</name> 15 <url>http://maven.apache.org</url> 16 <dependencies> 17 <!-- 18 system-web依赖system-service 19 --> 20 <dependency> 21 <groupId>me.gacl</groupId> 22 <artifactId>system-service</artifactId> 23 <version>${project.version}</version> 24 </dependency> 25 </dependencies> 26 <build> 27 <finalName>system-web</finalName> 28 </build> 29 </project>
注意,web项目的打包方式是war。
六、编译运行项目
经过上面的五个步骤,相关的模块全部创建完成,怎么运行起来呢。由于最终运行的是system-web模块,所以我们对该模块添加jetty支持,方便测试运行。修改system-web项目的pom.xml如下:
1 <?xml version="1.0"?> 2 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 4 <modelVersion>4.0.0</modelVersion> 5 <parent> 6 <groupId>me.gacl</groupId> 7 <artifactId>system-parent</artifactId> 8 <version>1.0-SNAPSHOT</version> 9 </parent> 10 11 <artifactId>system-web</artifactId> 12 <packaging>war</packaging> 13 14 <name>system-web Maven Webapp</name> 15 <url>http://maven.apache.org</url> 16 <dependencies> 17 <!-- 18 system-web依赖system-service 19 --> 20 <dependency> 21 <groupId>me.gacl</groupId> 22 <artifactId>system-service</artifactId> 23 <version>${project.version}</version> 24 </dependency> 25 </dependencies> 26 <build> 27 <finalName>system-web</finalName> 28 <plugins> 29 <!--配置Jetty插件--> 30 <plugin> 31 <groupId>org.mortbay.jetty</groupId> 32 <artifactId>maven-jetty-plugin</artifactId> 33 </plugin> 34 </plugins> 35 </build> 36 </project>
在命令行进入system-parent目录,然后执行下列命令:
mvn clean install
如下图所示:
命令执行完后,在system-web目录下多出了target目录,里面有了system-web.war,如下图所示:
命令行进入sytem-web目录,执行如下命令,启动jetty
mvn jetty:run
如下图所示:
启动jetty服务器后,访问http://localhost:8080/system-web/ 运行结果如下图所示:
七、导入Eclipse中进行开发
操作步骤如下所示: