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

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

Springboot多模块配置详细教程


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

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


在开始动手之前,我们先捋一捋每个模块的作用,清楚需求做事才有目的。之后再说如何创建:

首先,如上图所示,我这里分了四个子模块和一个父模块。


其中ww_system模块主要放entity、service、serviceImpl、mapper等文件。

ww_common主要放一些公共的工具类,

ww_blog是我的前台controller控制器

ww_admin 是系统的web启动入口,包括系统后台controller都在这。是整个系统启动的入口。


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

如何创建?

1,创建父模块

父模块的创建和平常我们创建Springboot项目没法不同,一步一步来就行了,不过既然是父模块,那么它显然是不需要src目录的,所以创建后直接删掉它就行。其他的东西爱删不删,留下pom文件就行。

2,创建子模块。

创建子模块的时候不要直接在左上角new ->project来创建。要选择我们刚创建好的父模块项目,在它上面右击创建new module。

然后一直下一步就行,这里还没有什么要注意的地方,按照这种方式在父模块上右键创建其余的另外三个子模块。

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>
            <!-- SpringBoot的依赖配置-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.2.2.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--thymeleaf依赖-->
            <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>
            <!-- 阿里JSON解析器 -->
            <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标签和模块引用

<?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>
    <parent>
        <artifactId>wwblog</artifactId>
        <groupId>com.macw</groupId>
        <version>1.0.0</version>
    </parent>
    <groupId>com.macw</groupId>
    <artifactId>ww_system</artifactId>
    <version>1.0.0</version>
    <name>ww_system</name>
    <description>系统模块</description>
    <dependencies>
        <!-- Mysql驱动包 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!-- 通用工具-->
        <dependency>
            <groupId>com.macw</groupId>
            <artifactId>ww_common</artifactId>
        </dependency>
        <!--Mybatis plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.0</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-extension</artifactId>
            <version>3.3.0</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.28</version>
        </dependency>
    </dependencies>
</project>
ww_common模块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>
    <parent>
        <artifactId>wwblog</artifactId>
        <groupId>com.macw</groupId>
        <version>1.0.0</version>
    </parent>
    <groupId>com.macw</groupId>
    <artifactId>ww_common</artifactId>
    <version>1.0.0</version>
    <name>ww_common</name>
    <description>公共模块</description>
    <dependencies>
        <!-- Spring框架基本的核心工具 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
        </dependency>
        <!-- SpringWeb模块 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombo.version}</version>
        </dependency>
    </dependencies>
</project>
ww_admin模块pom文件内容:

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

<?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>
    <parent>
        <artifactId>wwblog</artifactId>
        <groupId>com.macw</groupId>
        <version>1.0.0</version>
    </parent>
    <groupId>com.macw</groupId>
    <artifactId>ww_admin</artifactId>
    <version>1.0.0</version>
    <name>ww_admin</name>
    <packaging>jar</packaging>
    <description>系统后台●总后台web服务入口模块</description>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- SpringBoot集成thymeleaf模板 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <!-- spring-boot-devtools -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional> <!-- 表示依赖不会传递 -->
        </dependency>
        <!--公共模块-->
        <dependency>
            <groupId>com.macw</groupId>
            <artifactId>ww_common</artifactId>
        </dependency>
        <!--博客前台-->
        <dependency>
            <groupId>com.macw</groupId>
            <artifactId>ww_blog</artifactId>
        </dependency>
        <!--系统模块-->
        <dependency>
            <groupId>com.macw</groupId>
            <artifactId>ww_system</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.0</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.2.2.RELEASE</version>
                <configuration>
                    <fork>true</fork> <!-- 如果没有该配置,devtools不会生效 -->
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
        <finalName>${project.artifactId}</finalName>
    </build>
</project>

4 启动入口配置

启动入口只在ww_admin下配置Application启动类就行了,其他模块下不需要。

需要注意的是启动类一定要放在模块的根目录下,

我之前就是放在了模块目录下然后就导致了bean注入失败等的许多错误,需要加上@ComponentScan等好几个来进行包扫描,及其麻烦


所以最好的就是放在根目录下,如图所示:

如果遇到bean注释失败的错误,那么别问其他,就去找你的包扫描吧,肯定是路径的问题。我就在这里栽了好久好久。

添加控制器和连接池之后的目录大致是这样的

由于篇幅限制上面pom文件中删掉了很多与这篇文章讲解无用的依赖。如果报错或无法启动请参考本项目源码:https://gitee.com/macw/wwblog.git

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

目录
相关文章
|
1月前
|
Java 开发者 微服务
手写模拟Spring Boot自动配置功能
【11月更文挑战第19天】随着微服务架构的兴起,Spring Boot作为一种快速开发框架,因其简化了Spring应用的初始搭建和开发过程,受到了广大开发者的青睐。自动配置作为Spring Boot的核心特性之一,大大减少了手动配置的工作量,提高了开发效率。
52 0
|
5天前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
44 14
|
8天前
|
存储 JavaScript 前端开发
基于 SpringBoot 和 Vue 开发校园点餐订餐外卖跑腿Java源码
一个非常实用的校园外卖系统,基于 SpringBoot 和 Vue 的开发。这一系统源于黑马的外卖案例项目 经过站长的进一步改进和优化,提供了更丰富的功能和更高的可用性。 这个项目的架构设计非常有趣。虽然它采用了SpringBoot和Vue的组合,但并不是一个完全分离的项目。 前端视图通过JS的方式引入了Vue和Element UI,既能利用Vue的快速开发优势,
55 13
|
27天前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
43 1
SpringBoot入门(7)- 配置热部署devtools工具
|
16天前
|
JavaScript 安全 Java
java版药品不良反应智能监测系统源码,采用SpringBoot、Vue、MySQL技术开发
基于B/S架构,采用Java、SpringBoot、Vue、MySQL等技术自主研发的ADR智能监测系统,适用于三甲医院,支持二次开发。该系统能自动监测全院患者药物不良反应,通过移动端和PC端实时反馈,提升用药安全。系统涵盖规则管理、监测报告、系统管理三大模块,确保精准、高效地处理ADR事件。
|
1月前
|
存储 前端开发 JavaScript
springboot中路径默认配置与重定向/转发所存在的域对象
Spring Boot 提供了简便的路径默认配置和强大的重定向/转发机制,通过合理使用这些功能,可以实现灵活的请求处理和数据传递。理解并掌握不同域对象的生命周期和使用场景,是构建高效、健壮 Web 应用的关键。通过上述详细介绍和示例,相信读者能够更好地应用这些知识,优化自己的 Spring Boot 应用。
30 3
|
1月前
|
Java 数据库连接 数据库
springboot启动配置文件-bootstrap.yml常用基本配置
以上是一些常用的基本配置项,在实际应用中可能会根据需求有所变化。通过合理配置 `bootstrap.yml`文件,可以确保应用程序在启动阶段加载正确的配置,并顺利启动运行。
125 2
|
缓存 Java Spring
Spring&SpringBoot源码笔记整理 |Bean的加载流程二
昨天的文章里提到Bean的加载流程和如何获取bean,今天继续源码解读。还是老规矩,看着Bean加载的时序图进入主题。
334 0
Spring&SpringBoot源码笔记整理 |Bean的加载流程二
|
缓存 Java Spring
Spring&SpringBoot源码笔记整理 |Bean的加载流程一
本篇文章主要介绍Bean的加载流程,以及Spring是怎么解决循环依赖的问题。
141 0
Spring&SpringBoot源码笔记整理 |Bean的加载流程一
|
2月前
|
JavaScript 安全 Java
如何使用 Spring Boot 和 Ant Design Pro Vue 实现动态路由和菜单功能,快速搭建前后端分离的应用框架
本文介绍了如何使用 Spring Boot 和 Ant Design Pro Vue 实现动态路由和菜单功能,快速搭建前后端分离的应用框架。首先,确保开发环境已安装必要的工具,然后创建并配置 Spring Boot 项目,包括添加依赖和配置 Spring Security。接着,创建后端 API 和前端项目,配置动态路由和菜单。最后,运行项目并分享实践心得,包括版本兼容性、安全性、性能调优等方面。
178 1
下一篇
DataWorks