Maven的多模块项目

更新于:2020-10-12     浏览:1762 次  

在平时的 Java Web 项目开发中,为了便于后期的维护,我们一般会进行分层开发,最常见的情况就是分为:domain(域模型层)、dao(数据库访问层)、service(业务逻辑层)、web(表现层)。这样分层之后,各个层之间的职责会比较明确,后期维护起来也相对比较容易,可以使用 Maven 来构建以上的各个层。常见的 Java Web 项目结构如下所示:

system-parent
      |----pom.xml
        
      |----system-domain
             |----pom.xml
      |----system-dao
             |----pom.xml
      |----system-service
             |----pom.xml
      |----system-web
             |----pom.xml

1、创建 system-parent 项目

首先,创建 system-parent 项目,用来给各个子模块继承。进入命令行,输入以下命令:

mvn archetype:create -DgroupId=cn.mavenbook -DartifactId=system-parent -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

命令执行完成之后,可以看到在当前目录生成了 system-parent 目录,里面有一个 src 目录和一个 pom.xml 文件。

将 src 文件夹删除,然后修改 pom.xml 文件,将 <packaging>jar</packaging> 修改为 <packaging>pom</packaging>,pom 表示它是一个被继承的模块,修改后的内容如下:

<?xml version="1.0"?>

<project>

  <modelVersion>4.0.0</modelVersion>

  <groupId>cn.mavenbook</groupId>
  <artifactId>system-parent</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>pom</packaging>

  <name>system-parent</name>

</project>

2、创建 sytem-domain 模块

在命令行窗口中,进入创建好的 system-parent 目录,然后执行下列命令:

mvn archetype:create -DgroupId=cn.mavenbook -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 文件如下:

<?xml version="1.0"?>

<project>

  <modelVersion>4.0.0</modelVersion>

  <groupId>org.maven</groupId>
  <artifactId>system-parent</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>pom</packaging>

  <name>system-parent</name>

  <modules>
     <module>system-domain</module>
  </modules>

</project>

修改 system-domain 目录中的 pom.xml 文件,把<groupId>cn.mavenbook</groupId>和<version>1.0-SNAPSHOT</version>去掉,加上 <packaging> jar </packaging>, 因为 groupId 和 version 会继承 system-parent 中的 groupId 和 version,packaging 设置打包方式为 jar。修改过后的 pom.xml 文件如下:

<?xml version="1.0"?>

<project>
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>cn.mavenbook</groupId>
    <artifactId>system-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
  </parent>

  <artifactId>system-domain</artifactId>
  <packaging>jar</packaging>

  <name>system-domain</name>
  <url>http://maven.apache.org</url>
</project>

3、创建 sytem-dao 模块

在命令行窗口,进入创建好的 system-parent 目录,然后执行下列命令:

mvn archetype:create -DgroupId=cn.mavenbook -DartifactId=system-dao -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

命令执行完成之后,可以看到在 system-parent 目录中生成了 system-dao,里面包含 src 目录和 pom.xml 文件。

同时,在 system-parent 目录中的 pom.xml 文件自动变成如下内容:

<?xml version="1.0"?>

<project>

  <modelVersion>4.0.0</modelVersion>

  <groupId>org.maven</groupId>
  <artifactId>system-parent</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>pom</packaging>

  <name>system-parent</name>

  <modules>
    <module>system-domain</module>
    <module>system-dao</module>
  </modules>

</project>

修改 system-dao 目录中的 pom.xml 文件,把<groupId>cn.mavenbook</groupId>和<version>1.0-SNAPSHOT</version>去掉,加上<packaging>jar</packaging>,因为 groupId 和 version 会继承 system-parent 中的 groupId 和 version,packaging 设置打包方式为 jar,同时添加对 system-domain 模块的依赖,修改后的内容如下:

<?xml version="1.0"?>

<project>
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>cn.mavenbook</groupId>
    <artifactId>system-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
  </parent>

  <artifactId>system-dao</artifactId>
  <packaging>jar</packaging>

  <name>system-dao</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <!--system-dao需要使用到system-domain中的类,所以需要添加对system-domain模块的依赖-->
     <dependency>
      <groupId>cn.mavenbook</groupId>
      <artifactId>system-domain</artifactId>
      <version>${project.version}</version>
    </dependency>
  </dependencies>

</project>

4、创建system-service模块

在命令行窗口,进入创建好的 system-parent 目录,然后执行下列命令:

mvn archetype:create -DgroupId=cn.mavenbook -DartifactId=system-service -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

命令执行完成之后可以看到在 system-parent 目录中生成了 system-service目录,里面包含 src 目录和 pom.xml 文件。

同时,在 system-parent 目录中的 pom.xml 文件自动变成如下内容:

<?xml version="1.0"?>

<project>

  <modelVersion>4.0.0</modelVersion>

  <groupId>cn.mavenbook</groupId>
  <artifactId>system-parent</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>pom</packaging>

  <name>system-parent</name>

  <modules>
    <module>system-domain</module>
    <module>system-dao</module>
    <module>system-service</module>
  </modules>

</project>

修改system-service目录中的pom.xml文件,把<groupId>cn.mavenbook</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。修改后的内容如下:

<?xml version="1.0"?>

<project >
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>cn.mavenbook</groupId>
    <artifactId>system-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
  </parent>

  <artifactId>system-service</artifactId>
  <packaging>jar</packaging>

  <name>system-service</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <!--
    system-service依赖system-dao和system-domain,
    但是我们只需添加system-dao的依赖即可,因为system-dao已经依赖了system-domain
    -->
    <dependency>
      <groupId>cn.mavenbook</groupId>
      <artifactId>system-dao</artifactId>
      <version>${project.version}</version>
    </dependency>
  </dependencies>

</project>

5、创建 system-web 模块

在命令行窗口中,进入创建好的 system-parent 目录,然后执行下列命令:

mvn archetype:create -DgroupId=cn.mavenbook -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 文件自动变成如下内容:

<?xml version="1.0"?>

<project>

  <modelVersion>4.0.0</modelVersion>

  <groupId>cn.mavenbook</groupId>
  <artifactId>system-parent</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>pom</packaging>

  <name>system-parent</name>

  <modules>
    <module>system-domain</module>
    <module>system-dao</module>
    <module>system-service</module>
    <module>system-web</module>
  </modules>

</project>

修改system-web目录中的pom.xml文件,把<groupId>cn.mavenbook</groupId>和<version>1.0-SNAPSHOT</version>去掉,因为groupId和version会继承system-parent中的groupId和version,同时添加对system-service模块的依赖,修改后的内容如下:

<?xml version="1.0"?>

<project>
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>cn.mavenbook</groupId>
    <artifactId>system-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
  </parent>

  <artifactId>system-web</artifactId>
  <packaging>war</packaging>

  <name>system-web Maven Webapp</name>
  <url>http://maven.apache.org</url>

  <dependencies>
    <!--system-web依赖system-service-->
     <dependency>
      <groupId>cn.mavenbook</groupId>
      <artifactId>system-service</artifactId>
      <version>${project.version}</version>
    </dependency>
  </dependencies>

  <build>
    <finalName>system-web</finalName>
  </build>

  </project>

注意,web项目的打包方式是war。

6、编译运行项目

经过上面的五个步骤,相关的模块全部创建完成,怎么运行起来呢?

由于最终运行的是 system-web 模块,所以我们对该模块添加 jetty 支持,方便测试运行。修改 system-web 项目的 pom.xml 如下:

<?xml version="1.0"?>

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>cn.mavenbook</groupId>
    <artifactId>system-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
  </parent>

  <artifactId>system-web</artifactId>
  <packaging>war</packaging>

  <name>system-web Maven Webapp</name>
  <url>http://maven.apache.org</url>

  <dependencies>
    <!--system-web依赖system-service-->
     <dependency>
      <groupId>cn.mavenbook</groupId>
      <artifactId>system-service</artifactId>
      <version>${project.version}</version>
    </dependency>
  </dependencies>

  <build>
    <finalName>system-web</finalName>
    <plugins>
        <!--配置Jetty插件-->
        <plugin>
            <groupId>org.mortbay.jetty</groupId>
            <artifactId>maven-jetty-plugin</artifactId>
        </plugin>
    </plugins>
  </build>

</project>

在命令行进入 system-parent 目录,然后执行下列命令:

mvn clean install

命令执行完后,在 system-web 目录下多出了 target 目录,里面有了 system-web.war。

命令行进入 sytem-web 目录,执行如下命令,启动 jetty

mvn jetty:run

启动 jetty 服务器后,访问 http://localhost:8080/system-web/ 就可以获取到运行结果。