浏览代码

消息模块改造

1811872455@163.com 1 月之前
父节点
当前提交
32e9d72db4
共有 1 个文件被更改,包括 107 次插入0 次删除
  1. 107 0
      java/java项目结构说明.md

+ 107 - 0
java/java项目结构说明.md

@@ -0,0 +1,107 @@
+# Java 模块分层与引用关系
+
+## 1. 分层结构(先看层次)
+
+### L0:根聚合层
+
+- `storlead-saas-platform`:全项目根 `pom`,负责聚合所有 Java 模块。
+
+### L1:平台基础层
+
+- `java/storlead-dependencies`:统一管理依赖版本(BOM)。
+- `java/storlead-framework`:基础框架层,提供公共能力(`common`、`core`、`auth`、`mybatis`、`redis`、`web`)。
+
+### L2:平台能力域
+
+- `java/storlead-system`:系统模块(角色、模块、权限、设置等)。
+- `java/storlead-user`:用户模块。
+- `java/storlead-thirdparty`:第三方公共模块(企微、钉钉、支付宝等能力接入)。
+- `java/storlead-account`:账户业务模块。
+
+### L3:业务能力域
+
+- `java/storlead-sms`:手机短信发送模块(消息短信、验证码发送)。
+- `java/storlead-message`:站内消息模块(站内、邮箱、企微消息发送)。
+- `java/storlead-es`:ES 搜索模块。
+- `java/storlead-sasa`:子业务聚合模块(各业务线)。
+
+### L4:应用接入层
+
+- `java/storlead-api`:主 API 应用入口(当前启动类所在模块)。
+
+## 2. 聚合树(父子关系)
+
+```text
+storlead-saas-platform
+├─ storlead-dependencies
+├─ storlead-framework
+│  ├─ storlead-common
+│  ├─ storlead-core
+│  ├─ storlead-auth
+│  ├─ storlead-mybatis
+│  ├─ storlead-redis
+│  └─ storlead-web
+├─ storlead-system
+├─ storlead-user
+├─ storlead-thirdparty
+│  ├─ storlead-thirdparty-api
+│  ├─ storlead-thirdparty-core
+│  └─ storlead-thirdparty-dingtalk
+├─ storlead-account
+│  ├─ storlead-account-api
+│  └─ storlead-account-biz
+├─ storlead-sms
+│  ├─ storlead-sms-core
+│  ├─ storlead-sms-api
+│  └─ storlead-sms-biz
+├─ storlead-message
+│  ├─ storlead-message-core
+│  ├─ storlead-message-api
+│  └─ storlead-message-biz
+├─ storlead-es
+│  ├─ storlead-es-core
+│  ├─ storlead-es-api
+│  └─ storlead-es-biz
+├─ storlead-sasa
+│  ├─ storlead-trade
+│  │  ├─ storlead-customer
+│  │  ├─ storlead-marketing
+│  │  └─ storlead-acquisition
+│  ├─ storlead-salary
+│  ├─ storlead-sales
+│  ├─ storlead-okr
+│  └─ storlead-project
+└─ storlead-api
+```
+
+## 3. 模块引用关系(依赖方向)
+
+### 3.1 框架内部主链
+
+- `storlead-core` -> `storlead-common`
+- `storlead-auth` -> `storlead-common`、`storlead-core`
+- `storlead-redis` -> `storlead-common`
+- `storlead-mybatis` -> `storlead-common`、`storlead-core`、`storlead-auth`
+- `storlead-web` -> `storlead-common`、`storlead-core`、`storlead-redis`、`storlead-mybatis`
+
+### 3.2 业务模块主链
+
+- `storlead-sms-biz` -> `storlead-sms-api`、`storlead-sms-core`、`storlead-common`、`storlead-redis`、`storlead-mybatis`
+- `storlead-message-biz` -> `storlead-message-core`、`storlead-common`、`storlead-mybatis`、`storlead-web`、`storlead-user`
+- `storlead-es-biz` -> `storlead-es-api`、`storlead-es-core`
+- `storlead-user` -> `storlead-common`、`storlead-mybatis`、`storlead-thirdparty-api`
+- `storlead-system` -> `storlead-common`
+- `storlead-customer`、`storlead-marketing`、`storlead-acquisition` -> `storlead-common`、`storlead-web`
+- `storlead-salary`、`storlead-sales`、`storlead-okr`、`storlead-project` -> `storlead-common`
+- `storlead-api` -> `storlead-common`、`storlead-web`、`storlead-account-api`、`storlead-customer`
+
+### 3.3 第三方主链
+
+- `storlead-thirdparty-core` -> `storlead-thirdparty-api`
+- `storlead-thirdparty-dingtalk` -> `storlead-thirdparty-core`
+- `storlead-thirdparty-wecom`(目录存在)-> `storlead-thirdparty-core`、`storlead-common`、`storlead-web`、`storlead-redis`、`storlead-mybatis`
+
+## 4. 补充说明
+
+- 当前启动类:`com.storlead.api.StorleadTradeApplication`(位于 `java/storlead-api`)。
+- `storlead-thirdparty-wecom` 目录存在,但未在 `java/storlead-thirdparty/pom.xml` 的 `<modules>` 中声明;如需纳入聚合构建,需要补充声明。