# tg-boot

**Repository Path**: pub_module/tg-boot

## Basic Information

- **Project Name**: tg-boot
- **Description**: 一个springboot-starter风格的模块化单体架构低代码开发平台。
- **Primary Language**: Java
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: https://docs.module.pub
- **GVP Project**: No

## Statistics

- **Stars**: 329
- **Forks**: 1
- **Created**: 2025-11-24
- **Last Updated**: 2026-03-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

---
title: 整体架构
createTime: 2026/01/12 20:05:26
permalink: /dev/tgBoot/
---
# TG-boot | 模块化单体架构低代码开发平台

很久之前就想把这些年踩坑的经验及学到的先进概念熔炼成一个开发框架，直到今天已经初具形态，欢迎各位同行批评指及参与到这个开源项目里面。

#### **TG** 基于springboot且继承了springboot的设计理念，同时融入了模块化单体的设计理念，便于不同规模系统的团队分工协作，也便于功能解耦，支撑模块的划分颗粒度也和spring boot 框架同频，不使用的模块不会强制耦合其他模块。
- 模块间基于API层进行通信，零成本进行模块微服务化，模块内基于SPI机制进行扩展，实现了模块的多实现，可插拔。
- 遵循并延续springboot starter设计风格及固有的模块化设计理念，比如spring cache,spring data,spring security等。
- 模块边界清晰，规避耦合混乱，降低业务理解难度。
- 职责分工明确，结合树图架构（TG）的统一规范，提升团队协作效率。
- 易扩展、高可靠，可平滑过渡至微服务架构。
- 保留单体应用轻量优势，支持快速开发交付。
- 架构普适性强，适配小、中、大各规模项目。

# 技术栈

- 后台框架：springboot 3.5.5 、spring security
- 前台框架：vue3、element ui
- 小程序框架：uniapp x (支持鸿蒙开发) 、cool ui、 vit
-
- 多数据库支持：MySQL、PostgreSQL、Oracle、SQL Server、达梦、人大金仓等
- 功能模块：系统、支付、交易、文件、IM、OCR、短信、微信、小程序、CMS 等
- 特别鸣谢 Hu tool 作者提供的工具类库，weixin-java-tools 作者提供微信开发工具类库。

# 仓库地址及演示环境
- Gitee仓库：[https://gitee.com/pub_module/tg-boot.git](https://gitee.com/pub_module/tg-boot.git)
- 文档地址：[http://docs.module.pub](http://docs.module.pub)
- 演示环境：[http://tg.module.pub](http://tg.module.pub)
# 框架特点
- 启动速度快，5.44秒完成启动
- 用户-角色-部门三者绑定，解决组织机构中常见不同用户借调或者身兼多部门角色的问题，切换部门同样会切换角色，避免越权。
- 支持excel模板导入导出，自由且简单的发挥表格支持的样式、函数等所有特性，解耦导出excel表格和业务模块耦合，业务模块专注提供数据，excel模块根据模板渲染数据！
- 规范前端侧支持字典，摒弃后端翻译的弊端。
- 支持分片文件上传、单传。支持本地、minio、阿里云OS端的存储，且使用spi的方式易于扩展其他存储。

# 架构指导
[CSDN架构技术文档地址](https://blog.csdn.net/qq_20466509/article/details/158415916?spm=1001.2014.3001.5501)

# 架构图
```angular2svg
springboot
├── spring-boot-starter-module（根模块）
│   ├── spring-boot-starter-business（主要业务，子模块按照业务划分或者不划分）
│   ├── spring-boot-starter-components（组件化模块，为基础代码库贡献资源）
│   │   │   ├── 短信、支付、文件、IM、OCR、字典、缓存（）、日志、权限、消息队列、用户中心、工作流、定时任务、持久化数据
│   ├── 普通业务模块
|-- spring-boot-starter-runner(单应用启动器)
```


```angular2svg
代码架构
├── spring-boot-starter-system-biz
│   ├── biz（自定义业务代码包）
│   │   ├──service
│   │   │   ├── SpiSysUserServiceImpl.java spi为插件式设计模式接口，模块内部使用
│   │   │   ├── ApiSysRoleServiceImpl.java api为模块化通信接口，模块间使用
│   |   ├──controller
│   │   │   ├── CusSysUserController.java 路径带cus为客户端接口
│   │   │   ├── PubSysRoleController.java 路径带pub为公开接口
│   │   │   ├── MgtSysRoleController.java 路径带mgt为管理端接口
│   |   ├──websocket
│   |   ├──grpc
│   ├── curd（代码生成器生成的增删改查实体,里面可以增加维持数据一致性的数据服务）
│   │   ├── mapper
│   │   │   ├── TgUserMapper.java
│   │   │   ├── TgRoleMapper.java
│   │   ├── entity(如果API层未定义VO但依赖于实体模型，可以将该目录平移到API模块)
│   │   │   ├── TgUser.java
│   │   │   ├── TgRole.java
|   |   ├──service
│   │   │   ├── TgUserService.java
│   │   │   ├── TgRoleService.java

代码结构 API模块
├── spring-boot-starter-system-api
│   ├── api（接口定义包）
│   │   ├──service
│   │   │   ├── ApiXXXService.java (业务模块间通信接口)



分库分表指南：
在业务模块的starter的配置类中配置要查询的数据源。
微服务化指南：
随着业务增长，模块化单体不能满足大流量的情况下，可以对访问量大的模块拆成微服务独立部署。
```
```angular2svg
业务表设计：
├── 系统根表(抽象的表)字段 id,create_time,update_time,create_by,update_by,deleted,version,seq_no
├── 业务字段
│   ├── 表前缀+字段名称（符合目录式命名规范）
│   ├── 冗余字段（与来源名称一致，冗余字段是随着外键冗余过来的字段，该字段通常具有以下几种特点：不经常变更内容、属于其他系统或模块、需要关联查询、需要提升查询效率。
设计思想：
系统字段是虚拟了一个系统表或者实际有一个系统表，用来做共性或者系统层面的事情，比如数据的生成更新时间，操作人，版本变更，排序，日志，数据权限，租户数据隔离等。
业务字段使用目录式范式便于遵循唯一性命名原则，标准化冗余，便于形成范式，利于追踪，理解，统一开发风格。
```
# 开发风格

## 命名规范
- 目录式命名范式是一种基于目录结构的命名规范: 以上一层级的名称作为前缀，拼接下一层级的名来命名，类似于中国的姓+名的方式。因此看到这个名称我们很容易清晰它的“家族式”关系。例如A下面有B，B下面有C,因此我们在表示B的名称时为AB，表示C的名称为BC或者ABC。当层级超过三级需要取末尾三级，例如C下面有D,命名D可以使用BCD,程序设计中通常不建议超过三级，超过三级需要考虑设计是否合理。根据唯一性原则通常至少2个层级。需要注意的是如果上述的
  ABC组合中任何一个元素，例如A为单词，可以使用简写，假设A本身为简写词，跟别的词组合时要使用A的简写组合。
- 遵循唯一性原则：在业务表述中，描述一个事务时为了避免歧义我们会发掘它的唯一属性来作为形容词，例如“什么什么的名称”，或者我们沟通中默认我们的思维交织在一起建立了上下文，我们可以省略“什么什么的”的形容，在软件编码实践过程中，我们发现不同的对象之间关联时及容易产生命名冲突，因此写代码时为了避免混乱、风格不一致，我们不应该省略“什么什么的”形容词，这就是唯一性原则的由来。 唯一性命名规则适用于在编写源码过程中可以有效地避免字段命名冲突，并提高代码的可读性。且有利于代码的风格一致和简洁，比如我们存储用户的最高学历的编码及冗余该学历的名称、就读时间等多个字段的信息，我们可以轻松使用拷贝工具一行代码实现字段映射与赋值，而不必一行行对照字段、set属性。
- 命名示例：比如即时通讯模块，英文完成词为 Instant Messaging，模块的名称简写为IM,IM模块下的频道表命名为 im_channel，则下面的主键编码 应为 im_cl_code或cl_code，通常推荐加一级表前缀的方式，这样可以避免过度冗余也可以有效避免命名冲突（前提不同的表的前缀不能相同）。
- 系统的关联关系基于业务主键。业务主键命名为：表名+CODE，例如：用户表的业务主键为：USER_CODE。
- 字典编码命名与业务字段同名，当产生命名冲突时候前面+模块名称。
## 模块规范
- 不同模块的通信只能通过API层，API层的实现依赖于具体的业务模块，子模块可以依赖父模块，父级模块不能依赖于子模块，子模块继承的能力丰度取决于父级模块的丰度。
- 严禁不同模块的表关联查询，如有关联需求请创建同步表

# 感谢 & 友情链接
在此，首先要向各位开源前辈、向 Jeecg 等众多优秀框架的开发者们致以最诚挚的敬意。正是在这些优秀作品的熏陶与滋养下，我才得以在实际工作中不断沉淀、稳步成长，也才能真正做出一些看得见的成绩。
从业多年，我始终受益于开源精神的光芒。在无数优秀开源框架的陪伴下，我得以博采众长、融会贯通，逐步形成了自己的技术理解与架构思路，并基于这些积累，研发了这套更贴合自身场景与理念的框架。
如今将它开源，既是致敬一路指引我的开源大神们，也是希望以微薄之力回馈社区。愿这套框架能为更多同行带来便利、启发与价值，也愿开源之路，永远有人前行，永远有人照亮。以下致谢没有先后之分，如有采纳、借鉴等遗漏情况请提issue,我看到后会第一时间处理。
## spring boot
勿用质疑，一己之力撑起了java的一片天。
## jeecg
笔者某科技公司从业三年，做了政务、教育等大大小小系统100+，当之无愧框架之星。
## ruoyi
笔者某科技公司从业多年，做的优秀项目很多，框架简洁易懂，是知名度极高的系统。
## maku
笔者刚接触的系统、代码风格是我最喜欢的框架。
## activi
工作流框架的王者。
## hutool
天下谁人不识君，凭一己之力让java写的功能好写，简洁，直逼python。
## binwang-wx
曾经对接**系统很头疼，王斌大哥的框架即简洁又高效，真好！
##  excel导入导出
以前借鉴过某大神写的导出工具类，项目地址找不到了，如果看到了请联系我上墙。
## vue
懂的都懂，国人骄傲的前端框架，如果前端分历史，我愿意说vue时代是现代。
## element ui 
当之无愧最好用的前端开源ui框架，让多少公司的项目呱呱落地。