springboot父工程创建教程(最新完整版)

前言

现在开发中一般都是采用父子工程的方式来进行开发,因为这样可以更好的管理项目,也可以更好的解耦项目.因为我用得上所以我准备写个教程作为以后的参考.就怕自己以后再用的时候忘记了.
下面会从以下几个方面来进行讲解:

1. 父工程创建
2. 子工程创建
3. 父子工程配置

父工程创建

使用idea中自带的模板来创建(下面有图片如果没有显示,需要重新刷新几次网页,我用的免费图床所以有点卡后面文章中如果有图片的地方我就简写如图)

下面的勾选我这边建议是勾选基本的就行了（当然你至少要把spring web勾上）如图:

修改pom文件

修改父工程下的pom文件中的打包方式为pom，如图:

idea会自动设置为父工程
这里我会提供一个基础的父工程的pom.xml文件参考

<?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>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId><!-- 这里一般都是默认生成的不需要修改,如果没有生成就需要手动添加 -->
        <version>4.0.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.yx</groupId>
    <artifactId>JavaWebParent</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>JavaWebParent</name>
    <description>JavaWebParent</description>
    <modules>
        <module>POJO</module>
        <module>Server</module>
        <module>Log</module>
        <module>Filter</module>
        <module>Utils</module>
        <module>Config</module>
        <module>ApplicationServer</module>
    </modules>

    <packaging>pom</packaging>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webmvc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>4.0.1</version>
        </dependency>

        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
    </dependencies>

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

<modules>
        <module>POJO</module>
        <module>Server</module>
        <module>Log</module>
        <module>Filter</module>
        <module>Utils</module>
        <module>Config</module>
        <module>ApplicationServer</module>
    </modules>

modules标签中添加子工程的模块,在第一次创建父工程的时候,是没有的,这个很正常,然后这个模块的添加是在后面的子工程创建的时候添加的.
这里存在两种情况,在正常情况下添加模块的时候,idea会帮你自动添加进modules标签中,但是如果是在子工程中添加模块,就需要手动添加进modules标签中.

补充

差点忘了,父工程创建以后请把父工程的src文件删除掉只保留pom.xml文件就行了.因为父工程只是用来管理子工程的,子工程的代码都在子工程的src文件中.上面图片里面没有删是哪个时候没有过于的去研究这个问题,只是简单的创建了一个父工程,然后添加了子工程.

创建子工程

Archetype:选择org.apache.maven.archetypes:maven-archetype-quickstart
选quickstart没得那么多的其他杂七杂八的东西，是最接近纯骨架的模板,如果你用Spring Initializr创建子工程,会发现有很多其他的东西,你每次创建的时候会要去删一堆的东西很麻烦所以我这个是最纯净且最方便的创建方法 如图:

我这里创建了两个子工程看起来直观一点，只要看到下面的加载完成了就成功了如图:

上面是我之前创建的时候使用的方法,但是我发现一个问题有时候创建的时候,idea会检测不到jdk一直让我添加jdk所以为了保险起见
还是在项目结构里面进行创建,谁是父工程,你就右键创建新模块或者导入模块就行了,亲测不会出现上述问题 如图:

创建完成后就是下面的样子 如图:

工程配置

下面是我的父工程的pom.xml文件

<?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>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>4.0.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.yx</groupId>
    <artifactId>JavaWebParent</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>JavaWebParent</name>
    <description>JavaWebParent</description>
    <modules>
        <module>POJO</module>
        <module>Server</module>
        <module>Log</module>
        <module>Filter</module>
        <module>Utils</module>
        <module>Config</module>
        <module>ApplicationServer</module>
    </modules>

    <packaging>pom</packaging>
    <url/>
    <licenses>
        <license/>
    </licenses>
    <developers>
        <developer/>
    </developers>
    <scm>
        <connection/>
        <developerConnection/>
        <tag/>
        <url/>
    </scm>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webmvc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>4.0.1</version>
        </dependency>

        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webmvc-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter-test</artifactId>
            <version>4.0.1</version>
            <scope>test</scope>
        </dependency>
        <!-- Source: https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.38</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.4.7</version>
        </dependency>
        <!-- Source: https://mvnrepository.com/artifact/io.jsonwebtoken/jjwt -->
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt</artifactId>
            <version>0.12.6</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
            <version>3.1.10</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba.fastjson2</groupId>
            <artifactId>fastjson2</artifactId>
            <version>2.0.53</version> <!-- 请使用最新的稳定版本 -->
        </dependency>
    </dependencies>

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

</project>

首先把打包方式改为pom

<packaging>pom</packaging>

父子工程依赖问题

根据我当前的依赖来看,子工程是默认继承父工程的依赖的,所以子工程不需要再添加依赖了. 但是我发现我看视频的时候有博主的视频里面他的子工程里面是检测不到父工程的依赖的,这里就是问题,如果你发现子工程里面的代码需要引入依赖的话在,子工程里面的pom.xml文件里面添加依赖就行了.但是我觉得根据我当前的创建方式来看一般是不需要手动添加依赖了,都是在父工程里面的依赖

子工程之间相互调用的问题

在子工程之间其实也是通过调用对方的依赖来实现的,例如:在Server子工程里面调用POJO子工程的依赖,你只需要在Server子工程的pom.xml文件里面添加POJO子工程的依赖就行了. 例如:

<dependency>
    <groupId>com.yx</groupId>
    <artifactId>POJO</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

所以当你写代码的时候发现你要调用的没有,那么就是你没有引入对应的依赖,你需要在子工程的pom.xml文件里面添加对应的依赖.

子工程循环调用问题

在两个子工程之间调用的时候,如果子工程A调用子工程B,那么子工程B是可以调用子工程A的,但是如果子工程A调用子工程B,子工程B调用子工程A,那么就会出现循环调用的问题,导致程序崩溃. 所以在子工程之间调用的时候,要注意避免循环调用的问题. 例如:在Server子工程里面调用Log子工程的依赖,你只需要在Server子工程的pom.xml文件里面添加Log子工程的依赖就行了. 例如:

<dependency>
    <groupId>com.yx</groupId>
    <artifactId>Log</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

如果你循环调用其实连编译都过不了,会报错的.

启动项目配置

你肯定发现了一个ApplicationServer的子模块,这个就是我用来专门启动和管理整个项目配置文件的地方
简单说你正常情况创建一个单一的项目,你只需要在ApplicationServer子模块里面添加对应的配置文件就行了. 例如:application.properties,application.yml等. 你可以根据自己的需求添加对应的配置文件.
但是现在创建的项目是多模块的项目,那么就需要一个统一启动和配置整体项目的地方
所以这个模块就需要有两个包,一个是src/main/java,一个是src/main/resources. 你可以在src/main/java里面添加对应的启动类,在src/main/resources里面添加对应的配置文件.

创建resources文件夹很简单,只需要在src/main目录下右键点击New->Directory(目录),然后idea会自动给你一串选项,直接在里面选择resources就行了.
然后剩下的就是把你在ApplicationServer子模块里面添加的配置文件,复制到src/main/resources目录下就行了.

这里注意,要想有启动整个项目的启动类,需要在启动类上添加@SpringBootApplication注解. 例如:

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

@SpringBootApplication
public class ApplicationServer {
    public static void main(String[] args) {
        SpringApplication.run(ApplicationServer.class, args);
    }
}

ApplicationServer.class 名字与启动类名字对应起来

现在就可以正常启动项目了,但是你会发现什么都没有,这是因为没有添加其他的依赖,所以启动的时候,系统只读取了启动类的相关内容,剩下的是一点没动,下面需要将所有的子模块都添加到启动类的pom.xml文件里面. 例如:

<?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>

    <!-- 父工程配置 -->
    <parent>
        <groupId>com.yx</groupId>
        <artifactId>JavaWebParent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <artifactId>ApplicationServer</artifactId>
    <packaging>jar</packaging>

    <name>ApplicationServer</name>
    <description>Spring Boot Application Server Module</description>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
    </properties>

    <dependencies>
        <!-- 依赖其他子模块 -->
        <dependency>
            <groupId>com.yx</groupId>
            <artifactId>POJO</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.yx</groupId>
            <artifactId>Config</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.yx</groupId>
            <artifactId>Filter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.yx</groupId>
            <artifactId>Log</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.yx</groupId>
            <artifactId>Server</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.yx</groupId>
            <artifactId>Utils</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

        <!-- Spring Boot 核心依赖 (必须) -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>

    <!-- 构建配置 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

同时还需要添加一些核心依赖和配置,就像上述代码的配置一样,这样就可以正常启动项目了.

结语

后续根据我的理解,我会修改或者新增一些内容,我也不敢保证这个就是正确的,只是我自己的一点心得欢迎指正