Springboot多模块配置详细教程+源码案例+所遇到的坑

朴灿烈づ我的快乐病毒、 2023-06-26 12:05 6阅读 0赞

### Springboot多模块配置详细教程 ###

> 这两天参考了下若依大神的后台管理项目，感觉程序的健壮性是真的强大，本人佩服的五体投地，很多程序设计技巧规范非常值得我去学习，其中第一个便是Springboot的多模块化配置，也正好项目中需要，所以特地学习一下，但是实际操作中遇到了很多问题，特此记录一下。

###### 进行多模块配置的好处：maven多模块项目通常由一个父模块和若干个子模块构成，每个模块都对应着一个pom.xml。它们之间通过继承和聚合（也称作多模块）相互关联。多模块适用于一些比较大的项目，通过合理的模块拆分，实现代码的复用，便于维护和管理。 ######

在开始动手之前，我们先捋一捋每个模块的作用，清楚需求做事才有目的。之后再说如何创建：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70]  
首先，如上图所示，我这里分了四个子模块和一个父模块。

其中ww\_system模块主要放entity、service、serviceImpl、mapper等文件。  
ww\_common主要放一些公共的工具类，  
ww\_blog是我的前台controller控制器  
ww\_admin 是系统的web启动入口，包括系统后台controller都在这。是整个系统启动的入口。

有心的朋友可以再单独把service也单独抽出来做一个模块，不过我觉得没有必要，用了mybatisplus之后service和mapper就很少写了。

### 如何创建？ ###

#### 1，创建父模块 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70 1]  
父模块的创建和平常我们创建Springboot项目没法不同，一步一步来就行了，不过既然是父模块，那么它显然是不需要src目录的，所以创建后直接删掉它就行。其他的东西爱删不删，**留下pom文件就行。**

#### 2，创建子模块。 ####

创建子模块的时候不要直接在左上角new ->project来创建。要选择我们刚创建好的父模块项目，在它上面右击创建new module。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70 2]  
然后一直下一步就行，这里还没有什么要注意的地方，按照这种方式在父模块上右键创建其余的另外三个子模块。

#### 3，重点：配置依赖 ####

都创建好之后就是重点了，要配置我们几个模块之间的关联关系，  
大致思路就是：所有的子模块都继承父模块  
ww\_admin和ww\_blog两个带控制器的模块要引用ww\_system和ww\_common公共模块。  
公共模块ww\_common不依赖任何模块，只补充它所需要的jar包坐标就行

然后，父模块pom中不需要配置build打包配置

###### 父模块pom文件内容： ######

**注意模块引用和modules标签！！！！**

<?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.macw</groupId>
        <artifactId>wwblog</artifactId>
        <version>1.0.0</version>
    
        <name>wwblog</name>
        <url>http://www.henaumcw.top</url>
        <description>马超伟●个人博客系统</description>
    
        <properties>
            <java.version>1.8</java.version>
            <macw.version>1.0.0</macw.version>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
            <shiro.version>1.4.2</shiro.version>
            <thymeleaf.extras.shiro.version>2.0.0</thymeleaf.extras.shiro.version>
            <druid.version>1.1.14</druid.version>
        </properties>
    
        <modules>
            <module>ww_admin</module>
            <module>ww_blog</module>
            <module>ww_system</module>
            <module>ww_common</module>
        </modules>
        <packaging>pom</packaging>
    
        <dependencyManagement>
            <dependencies>
                
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-dependencies</artifactId>
                    <version>2.2.2.RELEASE</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
                
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-thymeleaf</artifactId>
                    <version>2.2.2.RELEASE</version>
                </dependency>
                
                <dependency>
                    <groupId>com.alibaba</groupId>
                    <artifactId>druid-spring-boot-starter</artifactId>
                    <version>${druid.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>com.alibaba</groupId>
                    <artifactId>fastjson</artifactId>
                    <version>${fastjson.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>com.macw</groupId>
                    <artifactId>ww_system</artifactId>
                    <version>${macw.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>com.macw</groupId>
                    <artifactId>ww_blog</artifactId>
                    <version>${macw.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>com.macw</groupId>
                    <artifactId>ww_admin</artifactId>
                    <version>${macw.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>com.macw</groupId>
                    <artifactId>ww_common</artifactId>
                    <version>${macw.version}</version>
                </dependency>
            </dependencies>
        </dependencyManagement>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.1</version>
                    <configuration>
                        <source>${java.version}</source>
                        <target>${java.version}</target>
                        <encoding>${project.build.sourceEncoding}</encoding>
                    </configuration>
                </plugin>
            </plugins>
        </build>
        
        <repositories>
            <repository>
                <id>public</id>
                <name>aliyun nexus</name>
                <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
                <releases>
                    <enabled>true</enabled>
                </releases>
            </repository>
        </repositories>
    </project>

###### ww\_system:pom文件内容： ######

注意parent标签和模块引用

###### ww\_common模块pom文件内容： ######

###### ww\_admin模块pom文件内容： ######

**注意这里的模块引用和build标签内容**

#### 4 启动入口配置 ####

启动入口只在ww\_admin下配置Application启动类就行了，其他模块下不需要。  
需要注意的是启动类一定要放在模块的根目录下，  
我之前就是放在了模块目录下然后就导致了bean注入失败等的许多错误，需要加上@ComponentScan等好几个来进行包扫描，及其麻烦

所以最好的就是放在根目录下，如图所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70 3]  
如果遇到bean注释失败的错误，那么别问其他，就去找你的包扫描吧，肯定是路径的问题。我就在这里栽了好久好久。  
添加控制器和连接池之后的目录大致是这样的  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70 4]  
由于篇幅限制上面pom文件中删掉了很多与这篇文章讲解无用的依赖。如果报错或无法启动请参考本项目源码：[https://gitee.com/macw/wwblog.git][https_gitee.com_macw_wwblog.git]

今天先更新到这，其他有问题闲来再更新

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191231180812711.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191231181705863.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191231182055709.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20191231185137914.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20191231185515837.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01hY1d4,size_16,color_FFFFFF,t_70
[https_gitee.com_macw_wwblog.git]: https://gitee.com/macw/wwblog.git