创建新模块

🧱 创建新模块指南(以 tduck-video 为例)

为了扩展业务功能,例如增加一个“视频”模块,命名为 tduck-video,我们可以按照以下步骤快速集成到现有项目中。


第一步:创建模块

在项目根目录 tduck-x-platform 下,新建一个 Maven 子模块:

示例结构

tduck-x-platform
├── tduck-video     <-- 👈 新增模块
│   └── pom.xml

模块 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">
  
    <parent>
        <groupId>com.tduck</groupId>
        <artifactId>tduck-x-platform</artifactId>
        <version>${revision}</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>
    <artifactId>tduck-video</artifactId>

    <dependencies>
        <!-- 引入通用模块依赖 -->
        <dependency>
            <groupId>com.tduck</groupId>
            <artifactId>tduck-common</artifactId>
        </dependency>
    </dependencies>

</project>

提示:如需调用数据库、使用Redis、权限、安全等功能,也可以额外引入对应模块依赖。


第二步:注册到父模块 pom.xml

在根项目的 pom.xml 中的 <modules> 标签内,加入新模块:

<modules>
    ...
    <module>tduck-video</module> <!-- 👈 新增 -->
</modules>

注意:名称应与子模块目录名一致。


第三步(可选):开放接口访问

如果你希望该模块对外提供 REST 接口,则继续此步;如果该模块只是一个服务层工具库,可跳过。

tduck-api 中添加模块依赖

src/tduck-api/pom.xml 中加入:

<dependency>
    <groupId>com.tduck</groupId>
    <artifactId>tduck-video</artifactId>
</dependency>

📌 说明

  • tduck-api 是项目的对外统一 API 网关模块。
  • 所有 REST 接口最终都需要被汇总在此模块中启动。

✅ 项目结构图(最终效果)

tduck-x-platform
├── tduck-api             # 接口聚合模块
├── tduck-common          # 通用工具
├── tduck-video           # ✅ 新建视频模块
└── pom.xml               # 父级 POM,已引入 tduck-video