Maven多模塊的設計與實戰

一、多模塊項目的組織

當我們需要管理一個複雜的項目時，我們通常需要將這個項目劃分成幾個子模塊。 這些子模塊可以是獨立的，也可以是相互依賴的。 例如，在一個Web應用程序中，我們可以分別為Service、Web和DAO層創建三個子模塊。

下面是一個簡單的多模塊項目的結構示例:

example-project/
|-- pom.xml（父模塊pom）
|-- example-service/
|   |-- pom.xml（服務模塊pom）
|   |-- src/
|       |-- main/
|       |   |-- java/...
|       |   |-- resources/...
|       |-- test/...
|-- example-web/
|   |-- pom.xml（Web模塊pom）
|   |-- src/
|       |-- main/
|       |   |-- webapp/
|       |   |   |-- WEB-INF/...
|       |   |-- java/...
|       |   |-- resources/...
|       |-- test/...
|-- example-dao/
|   |-- pom.xml（DAO模塊pom）
|   |-- src/
|       |-- main/
|       |   |-- java/...
|       |   |-- resources/...
|       |-- test/...

在上面的示例中，example-project是整個項目的父模塊，example-service、example-web和example-dao分別是三個子模塊。父模塊有一個pom.xml文件來定義子模塊的依賴關係和通用的配置。每個子模塊都有自己的pom.xml文件和源代碼目錄。

二、基本的Maven多模塊配置

下面是一個簡單的Maven多模塊配置文件，包括一個父pom和兩個子模塊pom:

1.父模塊pom.xml

<project>
    <groupId>com.example</groupId>
    <artifactId>example-project</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>example-service</module>
        <module>example-web</module>
    </modules>

    <dependencies>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>29.0-jre</version>
        </dependency>
        <dependency>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <version>42.2.14</version>
        </dependency>
    </dependencies>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.1</version>
                    <configuration>
                        <source>1.8</source>
                        <target>1.8</target>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

上面的pom.xml文件定義了整個項目的groupId、artifactId和version。dependency元素定義了整個項目的依賴項，例如guava和postgresql庫。modules元素定義了父模塊所包括的子模塊。build元素定義了整個項目的編譯配置，其中包括編譯插件的設置。由於這些設置是對整個項目有效的，因此它們應該定義在父模塊中。

2.服務模塊example-service的pom.xml

<project>
    <parent>
        <groupId>com.example</groupId>
        <artifactId>example-project</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <groupId>com.example</groupId>
    <artifactId>example-service</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>29.0-jre</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

上面的pom.xml文件定義了服務模塊的groupId、artifactId和version。parent元素指定了父模塊。dependencies元素定義了子模塊的依賴項。build元素定義了子模塊的編譯配置，其中包括編譯插件的設置。

3.Web模塊example-web的pom.xml

<project>
    <parent>
        <groupId>com.example</groupId>
        <artifactId>example-project</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <groupId>com.example</groupId>
    <artifactId>example-web</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <dependencies>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>example-service</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>3.2.3</version>
                <configuration>
                    <webXml>src/main/webapp/WEB-INF/web.xml</webXml>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

上面的pom.xml文件定義了Web模塊的groupId、artifactId和version。parent元素指定了父模塊。dependencies元素定義了子模塊的依賴項。build元素定義了子模塊的編譯配置，其中包括編譯插件的設置。

三、多模塊項目的實戰

我們可以使用多模塊Maven項目的大多數功能來管理我們的項目。 在下面的示例中，我們將創建一個簡單的多模塊項目，該項目包含一個主模塊和兩個子模塊。 主模塊(name-parent)將作為父模塊，其中一個子模塊(name-app)將是我們的主要應用程序，另一個子模塊(name-lib)將是我們的庫。

1.創建主模塊pom.xml文件

在我們開始之前，讓我們先創建父模塊的pom.xml文件。 我們可以按照下面的結構編寫:

<project>
    <groupId>com.example</groupId>
    <artifactId>name-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>name-app</module>
        <module>name-lib</module>
    </modules>

    <properties>
        <java.version>1.8</java.version>
        <spring.boot.version>2.2.6.RELEASE</spring.boot.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-parent</artifactId>
                <version>${spring.boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

我們使用了dependencyManagement元素來管理所有的依賴項。 我們可以從Spring Boot開發人員頁面下載主要版本，然後從Dependency Information部分中獲取最新版本。 properties元素定義了我們使用的Java和Spring Boot版本。最後，build元素定義了我們使用的Spring Boot插件。

2.創建子模塊name-app的pom.xml文件

我們還需要為我們的Spring Boot應用程序創建一個子模塊，其中包含應用程序的代碼和依賴項。創建子模塊的過程與父模塊類似:

<project>
    <parent>
        <groupId>com.example</groupId>
        <artifactId>name-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>com.example</groupId>
    <artifactId>name-app</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

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

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>name-lib</artifactId>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
</project>

我們在父模塊中指定了dependencyManagement元素，所以我們不需要在這裡重複定義。 我們將Spring Boot和我們的庫作為依賴項添加到此模