技术沙箱:springBoot 从创建到结束 - 02 —— 手动搭建 Maven 父工程 tech-sandbox、sandbox-common(公共子模块)、sandbox-admin(SpringBoot 后端业务模块)

本项目只讨论:JDK8 + SpringBoot 2.7.x 这种组合,JDK17 + SpringBoot3不讨论

本项目的IDEA使用:IntelliJ IDEA 2025.3.1.1

 1、打开IDEA,打开New Project弹框,

Name:项目名称

Location:项目地址

JDK:使用的jdk位置

Catalog:Archetype 模板从哪里加载(Maven Central 就是从中央仓库拉取脚手架列表)。

Archetype:Maven 脚手架模板,重点:Archetype 本身没有专门的 “父工程模板”,没有一个叫 “父工程 archetype” 的东西。

  • maven-archetype-quickstart:普通 Java 项目模板,自带 src/main/java、测试类,打包类型默认 jar,(这个就够用了,创建完了再改)
  • maven-archetype-site 等其他模板是别的用途

2、生成之后,必须做的改造(这一步就是把普通 jar 项目 → 改成 Maven 聚合父工程,博客重点)

等待 IDEA 加载完成,打开 pom.xml,修改打包类型: 找到 packaging,把默认的 <packaging>jar</packaging> 改成 <packaging>pom</packaging>

packaging=pom 才是父聚合工程的核心标记!

 

3、删除自动生成的 src 整个文件夹(父工程不放业务代码,只用来管理子模块、统一版本)

<dependencies></dependencies>里面的依赖删空:父工程不直接放业务依赖(后面我们用 dependencyManagement 统一管理版本)

直接删除整个 build 节点:父工程只负责聚合和版本管理,不需要这个容器,这个表情的作用是:

<build> //是一个大容器标签
<plugins> //里面可以放各种各样 Maven 插件
<plugin> //其中一个插件
...
</plugin>
</plugins>
</build>

 <url>http://www.example.com</url>这个也可以删掉:这个标签非必需,可删,留着也无害。是项目主页地址,Maven 规范里用来标注这个项目的官网 / 仓库地址,纯信息说明,不参与编译、打包、依赖解析,没有任何功能性作用

4、刷新右侧 Maven 面板(Reload All Maven Projects)

5、先在这个父 pom 里面,把 dependencyManagement 写进去,统一管理 SpringBoot、MyBatis-Plus 的版本,放在 <properties> 的后面,也就是:

<properties>
    ...
</properties>

<!-- 在这里新增 dependencyManagement -->
<dependencyManagement>
    <dependencies>
        <!-- 在这里放要锁定版本的依赖 -->
    </dependencies>
</dependencyManagement>
  1. 父工程这里:dependencyManagement → 里的依赖不会自动下载 jar 包,它只是登记版本,如果里面的依赖标红也没关系,不影响后续子模块使用。
  2. 子模块里面:写普通 <dependency>,不写 version,才会真正拉取 jar 包

6、创建公共子模块 sandbox-common:公共模块,存放统一返回体、常量、工具类、基础实体、通用配置等,后续业务模块可以依赖本模块复用公共代码。

6.1 、IDEA 创建 Module

在左侧项目树,右键根工程 tech-sandbox → New → Module

  • Archetype:maven-archetype-quickstart
  • Catalog:Maven Central
  • 模块名称:sandbox-common
  • 路径:默认,自动生成在 tech-sandbox/sandbox-common,不要手动修改
  • JDK:JDK 1.8
  • Advanced Settings:groupId 和父工程保持一致

点击 Create 创建。

6.2、子模块 pom 说明:创建完成后,子模块 sandbox-common 的 pom.xml 会自动生成 parent 标签,这就是和父工程绑定的核心:

 <parent>

    <groupId>org.example</groupId>
    <artifactId>tech-sandbox</artifactId>
    <version>1.0-SNAPSHOT</version>
</parent>
  • 子模块不需要重复写 dependencyManagement;
  • 子模块引入依赖时不需要写 version,自动继承父工程里面锁定的版本。

清理模板自带多余内容:删掉自动生成的 build 插件、<name>、<url> 等占位信息,保持 pom 简洁。

6.3、引入依赖(不指定 version):在子模块的 <dependencies> 里面添加依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
    </dependency>
</dependencies>

6.4、核对父工程 modules:新建模块成功后,回到父工程 tech-sandbox 的 pom.xml,检查是否自动生成 modules

<modules>
    <module>sandbox-common</module>
</modules>
如果没有自动生成,手动加上这段配置,放在 dependencyManagement 外面。
作用:告诉 Maven,父工程聚合这些子模块,打包、install 的时候按顺序构建全部子模块。

6.5、将项目依赖添加到父工程:tech-sandbox,pom文件的dependencyManagement标签里,用作版本控制,否则其他子项目无法依赖。

 

<!-- 依赖自己的公共模块 sandbox-common -->
<dependency>
<groupId>org.example</groupId>
<artifactId>sandbox-common</artifactId>
<version>${project.version}</version>
</dependency>
己项目内部的子模块,不属于 SpringBoot BOM 管理范围,如果想要子模块引用时省略 version,需要手动在父 dependencyManagement 中声明,使用 ${project.version} 继承父版本。

 

6.6、验证构建:右侧 Maven 面板刷新项目,执行 clean → install。 看到 BUILD SUCCESS 代表子模块继承、依赖版本管控全部生效

7、新建 sandbox-admin:sandbox-admin 是可独立启动的 SpringBoot 后端服务,是主应用,它会依赖 sandbox-common,复用里面的公共类(返回结果、工具类、实体等)。

7.1、同样在根工程 tech-sandbox 右键 → New → Module

  • Archetype:maven-archetype-quickstart
  • Catalog:Maven Central
  • 模块名称:sandbox-admin
  • 路径:默认自动放在 tech-sandbox/sandbox-admin,不要改动
  • JDK:JDK 1.8
  • Advanced Settings:groupId 和父工程保持一致 org.example

点击 Create 创建。

7.2、sandbox-admin 的 pom 要做两件关键事情(博客重点)

  • 清理多余标签(name、url、build 插件,和 common 一样)
  • 依赖两块:
    • spring-boot-starter-web(继承父版本)
    • 依赖 sandbox-common(自己项目内的公共模块)
    • <dependencies>
          <!-- web依赖 -->
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter-web</artifactId>
          </dependency>
          <!-- 依赖自己的公共模块 sandbox-common -->
          <dependency>
              <groupId>org.example</groupId>
              <artifactId>sandbox-common</artifactId>
              <!-- 这里同样不用写version,继承父工程 -->
          </dependency>
      </dependencies>
知识点:模块之间互相引用,就是这样写依赖。admin 依赖 common,common 里的类 admin 就能直接 import 使用。
sandbox-common 引依赖的时候,sandbox-common只是一堆 class 代码,它本身不会启动 Spring,不会读取 yml,所以如果sandbox-common的pom里引了Mybatis这种需要配置数据源的依赖,业务项目里的yml是要配置Mybatis数据源的
sandbox‑common 其实并不用引Mybatis这种依赖,业务项目里引入,common 里面写的 Mapper、实体类,可以被 admin 调用去访问数据库。
  1. common 放:通用基础工具依赖(正常 scope,允许传递) lombok、hutool 等,所有服务通用,稳定、无自动配置、不会触发 Spring 的条件装配。
  2. common 不放:各种框架 starter(mybatis、redis 等自动配置包) 这类交给业务模块按需引入;如果 common 需要用到框架的类编译,则用 provided。
  3. 业务模块(admin、job 等):按需引入 starter 需要数据库 → admin 自己引入 mybatis-plus; 需要 redis → 自己引入 redis starter; 只需要工具、不需要数据库 → 只依赖 common,干干净净,不会触发数据源报错。

7.3、父 pom 自动新增 module:

<modules>
    <module>sandbox-common</module>
    <module>sandbox-admin</module>
</modules>

sandbox-admin 和 common 的巨大区别:
  • sandbox-common:公共依赖包,packaging 默认 jar,无启动类,只提供工具、实体、常量;
  • sandbox-admin:业务应用,需要添加 SpringBoot 启动类、yml 配置文件,可以直接启动运行,对外提供接口。

7.4、刷新 Maven + 构建验证sandbox-admin

右侧 Maven 面板刷新整个项目,执行 clean → install。

出现 BUILD SUCCESS 代表模块依赖关系正常,admin 可以正常引用 common。

8、接下来验证流程

在根工程 tech-sandbox 执行 clean → install

  • 根工程会自动按 modules 顺序:先构建 sandbox-common,再构建 sandbox-admin

出现 BUILD SUCCESS 代表依赖关系全部正常

9、sandbox-admin 编写启动类 & 配置文件

9.1、创建目录结构:sandbox-admin/src/main/java/org/example/AdminApplication.java

包名 org.example 需要和 Maven groupId 保持一致,保证组件扫描生效

子模块不再重复写顶级的 groupId/version,而是通过 <parent> 继承父工程的坐标:

<project>
    <modelVersion>4.0.0</modelVersion>

    <!-- 继承父工程的 groupId、version -->
    <parent>
        <groupId>org.example</groupId>
        <artifactId>tech‑sandbox</artifactId>
        <version>1.0‑SNAPSHOT</version>
    </parent>

    <!-- 子模块只需要写自己的 artifactId -->
    <artifactId>sandbox‑admin</artifactId>

    <!-- dependencies ... -->
</project>

AdminApplication.java 完整代码:

  1. @SpringBootApplication 默认扫描当前类所在包及其所有子包;如果你的 Controller、Service 放在别的包,会扫描不到直接 404。
  2. sandbox‑common 是公共 jar 包,被 admin 依赖,不需要写任何启动类
package org.example;

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

/**
 * 业务服务启动类
 * @SpringBootApplication 开启SpringBoot自动装配 + 组件扫描
 * 默认扫描当前包以及子包下面所有@Component/@Controller/@Service等组件
 */
@SpringBootApplication
public class AdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(AdminApplication.class, args);
    }
}

9.2、编写 application.yml 配置文件

新建文件路径:sandbox-admin/src/main/resources/application.yml

server:
  port: 8080         # 服务端口
# servlet:
#   context-path: /api  # 可选,配置全局访问前缀

spring:
  application:
    name: sandbox-admin # 应用服务名称

9.3、写一个简单测试 Controller

路径:sandbox-admin/src/main/java/org/example/controller/HelloController.java

package org.example.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/demo")
public class HelloController {

    @GetMapping("/hello")
    public String hello(){
        return "sandbox‑admin 服务启动成功!";
    }
}

9.4、运行&访问

  1. IDE 直接运行 AdminApplication 的 main 方法
  2. 浏览器访问:http://127.0.0.1:8080/demo/hello
  3. 页面输出:sandbox‑admin 服务启动成功!

(spring-boot-starter-web依赖更多用法:https://www.cnblogs.com/cmjChunShu/articles/23550972)

posted @ 2026-11-04 21:22  椿树之久  阅读(8)  评论(0)    收藏  举报