Nebula 项目
项目简介
Nebula 是一个基于 Spring 生态的 Java 模块化中台工程。它不是单纯的 controller -> service -> dao 三层单体,而是围绕"模块边界稳定、支持单体接入、支持远程调用、支持独立服务化部署"这几个目标构建的中台底座。
整体组织方式:
- 根聚合工程统一管理所有能力模块(统一在根
pom.xml中聚合与依赖版本); - 每个领域模块内部再按
api / core / local / remote / service拆分为 5 个子模块; - 基础设施能力由
nebula-base、nebula-event、nebula-dependency等通用模块下沉,不承载具体业务。
业务应用可以按需选择接入形态:通过 *-local 以单体方式引入能力,通过 *-remote 以 Feign 远程调用消费独立部署的服务,或直接使用 *-service 独立服务化部署。
架构速览
┌──────────────────────────────────────────────┐
│ 应用与运行入口层 │
│ nebula-app / *-service / nebula-gateway │
├──────────────────────────────────────────────┤
│ 业务模块接入层 │
│ *-local / *-remote │
├──────────────────────────────────────────────┤
│ 业务能力核心层 │
│ *-core │
├──────────────────────────────────────────────┤
│ 业务契约层 │
│ *-api │
├──────────────────────────────────────────────┤
│ 基础设施层 │
│ nebula-base / nebula-event / dependency │
└──────────────────────────────────────────────┘
更详细的分层动机与包组织方式,见 设计说明。
模块清单
| 模块 | 定位 | 文档 |
|---|---|---|
nebula-auth | 认证与权限中心:用户、角色、权限、组织架构、菜单资源、OAuth2 客户端与微信登录 | Auth 模块 |
nebula-dict | 统一数据字典:字典类型 + 树形字典项,支持缓存与分页维护 | Dict 模块 |
nebula-param | 统一系统参数中心:运行期按 key 读取、后台可维护的业务开关与配置 | Param 模块 |
nebula-storage | 统一文件存储:普通/分片上传、鉴权下载、短时签名分享下载 | Storage 模块 |
nebula-frontend | 前端支撑:启动配置、主题/语言/导航布局偏好、动态缓存治理、应用版本与升级检查 | Frontend 模块 |
nebula-notify | 统一消息中心:通知模板与渠道变体、通知类别、站内信、公告、订阅偏好、移动推送与设备注册 | Notify 模块 |
| 多租户 | 跨模块能力:租户子域名解析、平台账号与租户账号分离、强制绑定、数据/缓存/异步隔离 | 多租户 |
mobile/ | 移动端基座(React Native 新架构,一套代码输出 iOS / Android / 鸿蒙) | 移动端基座 |
各模块文档采用统一结构:overview → design-and-implementation → business-capabilities → usage-guide → configuration → ddl(mobile/ 为客户端工程,结构略有不同)。
📚 文档分类
- Auth 模块 - nebula-auth 模块的总览、业务功能、设计实现、接入方式、配置与建表说明
- Dict 模块 - nebula-dict 模块的总览、业务功能、设计实现、接入方式、配置与建表说明
- Param 模块 - nebula-param 模块的总览、业务功能、设计实现、接入方式、配置与建表说明
- Storage 模块 - nebula-storage 模块的总览、业务功能、设计实现、接入方式、配置与建表说明
- Frontend 模块 - nebula-frontend 模块的总览、业务功能、设计实现、接入方式、配置与建表说明
- Notify 模块 - nebula-notify 模块的总览、业务功能、设计实现、接入方式、配置与建表说明
- 多租户 - 租户解析、平台账号强制绑定、企业切换、数据隔离、配置与建表说明
- 移动端基座 - React Native 移动端基座工程与端无关共享契约
packages/client-sdk - 接口文档:模块对外接口不再在本站维护,接入 nebula 后端运行时 OpenAPI 文档(启动后访问
doc.html/swagger-ui.html),与代码实时一致 - 设计说明 - 项目分层设计、包设计、敏感字段加密与多租户实施计划
- 规范说明 - 开发规范清单(架构、分层、命名、数据库、接口、异常、日志、安全、配置、多租户)
- 发版记录 - 各版本变更、破坏性变更与升级注意
推荐阅读顺序
如果你是第一次阅读 Nebula 文档,建议按下面顺序进入:
- 先看 设计说明
- 了解项目分层方式、包结构与整体架构约定
- 再看目标模块的
index / overview- 快速建立该模块的能力边界和文档地图
- 然后按统一顺序阅读模块页
design-and-implementation→business-capabilities→usage-guide→configuration→ddl
- 需要具体接口契约时,查看 nebula 后端运行时 OpenAPI 文档(
doc.html/swagger-ui.html),与代码实时一致 - 最后看 规范说明
- 对照命名、分层、数据库与安全规范,帮助把文档理解映射回代码结构
相关文档:OmniGate · OmniTOTP · Port Cleaner