第24章 SpringBootMaven多模块开发

通过IDEA，可以创建Maven多模块项目，适用于一些比较大的项目，按功能划分模块，优化代码结构，方便分工合作。springboot多模块项目使用maven打包部署时需要从子模块到父模块依次进行打包，并且每个pom.xml文件的配置都要正确。

接下来，我们创建一个 “SpringBootModuleDemo” 工程

然后我们修改编码格式以及Maven仓库地址，我们省略这个过程了。

这里，我们创建的 “SpringBootModuleDemo” 就是“父模块”，它的作用就是聚合“子模块”。因此，它一般情况下不会存在“src”代码目录，我们将其删除掉即可，同时在 “pom.xml” 中做如下修改

增加的配置项

<packaging>pom</packaging>

这个 packaging 标签的作用是指定当前项目打包的类型，pom的意思是项目里没有java代码，只是为了聚合子模块工程。packaging 默认类型为 jar，也就是我们日常创建的能够运行的应用程序类型。 接下来，我们修改 “pom.xml” 文件，增加SpringBootWeb依赖

<?xml version="1.0" encoding="UTF-8"?>
<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>com.demo</groupId>
    <artifactId>SpringBootModuleDemo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <packaging>pom</packaging>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.13</version>
        <relativePath/>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

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

</project>

接下来，我们创建第一个子模块 “base-common”

我们在父模块“SpringBootModuleDemo”名称上面右击选择“New” -> “Module...”

我们输入模块名称，然后点击“Finish”完成

我们注意到子模块“base-common” 同样存在属于自己的“pom.xml”文件

    <parent>
        <artifactId>SpringBootModuleDemo</artifactId>
        <groupId>com.demo</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

我们可以看到文件中的 “parent” 标签注明自己所属的父模块为 “SpringBootModuleDemo”

同时，我们在查看父模块 “SpringBootModuleDemo” 中的 pom.xml 文件

    <groupId>com.demo</groupId>
    <artifactId>SpringBootModuleDemo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>base-common</module>
    </modules>

在 “modules” 标签中也注明了子模块 “base-common” 的存在。

请注意，子模块 “base-common” 继承 父模块 “SpringBootModuleDemo” 的依赖项。也就是说，我们可以在子模块 “base-common” 中直接使用SpringBootWeb的API。如果子模块需要单独引入依赖项，则可以直接在自己的pom.xml文件中添加即可。这里我们创建一个 “TestService” 测试类

package com.demo.service;

import org.springframework.stereotype.Service;

@Service
public class TestService {

    public String test(){

        return "hello, test!";
    }

}

我们计划将子模块 “base-common” 作为提供服务的模块存在，它不需要独立启动运行，因为我们不需要为它创建入口启动Application类了。

接下来，我们继续创建第二个子模块“system-application”，它需要使用 “base-common” 提供的服务，并且需要入口启动Application类独立启动运行。

我们同样可以看到在子模块“system-application”的pom.xml配置文件中

    <parent>
        <artifactId>SpringBootModuleDemo</artifactId>
        <groupId>com.demo</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

子模块“system-application”的父模块就是“SpringBootModuleDemo”

同时，我们再次查看父模块“SpringBootModuleDemo”的pom.xml文件

    <groupId>com.demo</groupId>
    <artifactId>SpringBootModuleDemo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>base-common</module>
        <module>system-application</module>
    </modules>

在 “modules” 标签中也注明了子模块 “base-common” 和 “system-application” 的存在。

如何让 “system-application” 子模块引入另一个子模块 “base-common” 呢？

    <dependencies>
        <dependency>
            <groupId>com.demo</groupId>
            <artifactId>base-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

其实跟引入其他第三方依赖是一样的。

我们点击 “Load Maven Changes” 就能够将 “base-common” 加载进来使用了。

接下来，我们子模块 “system-application” 中创建入口Application启动类

package com.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {

        SpringApplication.run(Application.class, args);
    }
}

接下来，我们创建 “TestController” 控制器代码

package com.demo.controller;

import com.demo.service.TestService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @Autowired
    private TestService testService;

    @RequestMapping("/test")
    public String test(){

        return testService.test();
    }

}

我们可以将 “TestService” 注入进来使用了。

接下来，我们启动测试一下吧

最后，我们要注意的是类的包路径问题

com.demo.Application.java
com.demo.controller.TestController.java

com.demo.service.TestService.java

我们的入口Application类的扫描包路径为 “com.demo” 下的，如果我们定义的 “TestService.java” 不在“com.demo” 下的话，我们就无法正确使用这个服务类了。

本工程完整代码下载： https://download.youkuaiyun.com/download/richieandndsc/89953285