Springboot多模块项目从0构建打包运行

SYKMI

已于 2024-06-29 20:58:44 修改

阅读量1k

点赞数 18

分类专栏： SpringBoot学习文章标签： spring boot java 后端

于 2024-06-24 00:24:42 首次发布

本文链接：https://blog.csdn.net/weixin_44001317/article/details/139908321

版权

SpringBoot学习专栏收录该内容

8 篇文章 0 订阅

订阅专栏

今天复习了一下Springboot的多模块的构建，其实一直以来都对单体项目使用多模块感到不太理解，不知道到底有什么样的优势，目前切身体会到的优势就是确实可以让依赖的划分更加清晰（每个模块下的pom文件只引入该模块需要的依赖）和稳定（父项目控制子项目的依赖版本，避免依赖版本不同导致问题），其他没有太多的感受，后续遇到了再补充吧

创建项目

要创建多模块项目，首先需要创建一个maven项目作为父模块
在这里插入图片描述
既然是作为父模块，那么就不需要选任何组件，其实我后续子模块的创建也没有选定任何组件，都是按需在pom文件中手动加入的

创建完成后，我们删除src目录和其他不需要的文件

接下来我们选定父模块，去新建entity，dao，service和web模块，流程和下图是一模一样的，需要记住的是，创建完这些模块之后，需要删除src下的启动类和不需要的文件，但是web模块下的启动类可以保留，作为项目启动的入口
在这里插入图片描述
这样都新建完成之后我们可以看下现在的全部目录（图片被吞了我没发觉，这是后续补的，这些类是后续加的，可以先不管）

处理pom文件

首先我们需要处理父pom文件，删除build、dependencyManagement、dependencies和properties标签，后续需要可以再加，然后在父pom中将打包类型设置为pom类型用于指示该Maven模块是一个聚合（Aggregation）或父（Parent）模块，而不是一个常规的可执行JAR、WAR或其他类型的包。
首先我们要声明有哪些子模块，所以父pom需要标明这些信息，然后我们需要声明这些子模块所使用的依赖版本，尽量统一或者兼容，这样可以在其他子模块引入依赖的时候不需要关心引入的版本了，避免不必要的问题出现导致项目起不来还需要去排查，按照以上思想我们就成功编辑了一个父模块，完整pom内容如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>father</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>father</name>

    <modules>
        <module>dao</module>
        <module>entity</module>
        <module>service</module>
        <module>web</module>
    </modules>

    <properties>
        <base.version>2.7.6</base.version>
        <mysql.version>8.0.25</mysql.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <version>${base.version}</version>
            </dependency>

            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
                <version>${base.version}</version>
            </dependency>

            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.2.2</version>
            </dependency>

            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>${mysql.version}</version>
            </dependency>

            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
                <version>${base.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

处理子pom文件

父pom设置好了之后，我们处理子pom文件，首先我们设置dao层的pom文件。需要说明的是在编辑子pom之前依然需要删除生成的pom文件中的没用的东西，删除完后的pom内容如下，非常简洁：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>dao</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>dao</name>
</project>

首先需要声明父依赖，标明它是父依赖下的子模块。然后我们会想既然这是和后端数据库打交道的模块，那么就要引入使用的数据库的依赖，然后引入持久层框架的依赖，我这里使用的MySQL数据库和mybatis框架，那么就需要引入对应的依赖，然后该模块肯定还需要引入entity模块的依赖，因为我们要使用这个模块下的实体类呀，所以处理完之后的pom内容如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>dao</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>dao</name>
    <!--声明父模块-->
    <parent>
        <groupId>com.example</groupId>
        <version>0.0.1-SNAPSHOT</version>
        <artifactId>father</artifactId>
    </parent>

    <!--需要的依赖-->
    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>entity</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>

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

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
    </dependencies>
</project>

同样的，service层需要依赖dao层，步骤和上面说的一样，删除不需要的东西，我们想要时可以后续再配。处理完成的pom如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>service</name>

    <!--声明父模块-->
    <parent>
        <groupId>com.example</groupId>
        <version>0.0.1-SNAPSHOT</version>
        <artifactId>father</artifactId>
    </parent>

    <!--所需依赖-->
    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>dao</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

    </dependencies>

</project>

web层和上面都是一样的，其实每层都是一样的思路，你想要什么依赖自己配置，web层这里需要加入spring-web依赖并且依赖于service。需要提一嘴的时，由于项目启动类就在这里，所以最后打包也是在这里执行的，这里需要多配置下打包信息。最终pom如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>web</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>web</name>

    <!--声明父模块-->
    <parent>
        <groupId>com.example</groupId>
        <version>0.0.1-SNAPSHOT</version>
        <artifactId>father</artifactId>
    </parent>

    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>service</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

        <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.6</version>
                <configuration>
                    <!--多模块下，指定统一入口文件，否则会导致打包失败-->
                    <mainClass>com.example.web.WebApplication</mainClass>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

至此，基本配置已经完成，尝试启动项目看看
在这里插入图片描述
也没问题，那我们尝试加入一个接口吧

加入接口打包运行

直接放图吧（只放了dao和controller层，其他都是按照三层架构正常写的，就不放了）
在这里插入图片描述

这里都是虚构的接口，我没有和真实的数据库交互，只是测试接口能否正常访问，但是由于dao层加入了MySQL的依赖，所以需要在application.yml文件中补全数据库信息，如下图：
在这里插入图片描述
需要注意在启动类上加入@ComponentScan注解扫描其他模块的bean，如果是真实的mapper接口还需要打@MapperScan注解去扫描@mapper注解的接口
打包运行

成功！

tips

为什么springboot多模块项目下可以扫描到其他类的组件加入到容器中？
需要添加@ComponentScan注解才可以扫描到其他模块下的类，并且需要添加正确的包名，Springboot默认只会扫描启动类所在的包及其子包下的bean，即使你其他模块中的bean和启动类下包名相同也不行，必须要添加该注解