wangli/orgmanax
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(REQ-3282): README.md增加dto层描述

Browse Source
This commit is contained in:
周敏 2024-12-23 19:38:02 +08:00
parent 7d36020e60
commit 18caac6179
1 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -34,7 +34,7 @@
/api/unit/update
/api/node-user/list
/api/org-user/page
/api/org-user/page
/api/org-user/operate-log/page
```
* domain 为主要操作/查询的对象。包含以下值
```
@ -60,15 +60,15 @@
## 模块描述
模块名称 | 功能 | 依赖
------ |--------------------------------------------------------------------------------------------------------------------------------------------| ----
`orgmanax-api` | API层，提供给org-gateway的接口 |无
`orgmanax-common`| 公共组件、UTIL等 |无
`orgmanax-infra` | 基础设施层，隔离非业务变化，防止外部变化引起内部业务变更。<br/>对接二方服务，数据库，MQ等中件间 | `orgmanax-common`
`orgmanax-integration`| 封装了二方服务非纯净版本。如：apollo-api、gaia-api等。等两方服务统一规范后，该层就会移除。 | `orgmanax-infra`
`orgmanax-server`| 核心能力层，分为两块：<br/>1、通用能力:`foundation` 单域核心逻辑如：创建部门，创建单位 <br/>2、人岗架业务能力：`service` 如：创建班组、创建小组 <br/>`service` 依赖本域 `foundation`或他域service完成业务 | `orgmanax-api` `orgmanax-common` `orgmanax-infra`
`orgmanax-starter`| 启动类 | `orgmanax-api` `orgmanax-common` `orgmanax-infra` `orgmanax-server` `orgmanax-integration`
模块名称 | 功能 | 依赖
------ |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----
`orgmanax-dto` | 通用对象层，提供对外暴露的对象（如：接口的出入参数「Req、Resp」、领域模型DTO、事件的payload等。仅在服务内部使用的模型，不放在dto包里面；<br>哪些对象应该放到dto包，这个较难以甄别。目前暂定dto里面仅提供以下内容：<br> 1.api接口的`入参和出参`；<br> 2.对外统一暴露的`领域聚合对象`，如 NodeDTO、NodeUserDTO、UnitDTO等；<br> 3.对外暴露的`枚举`定义；<br> 4.MQ消息体的`payload`定义 | 无
`orgmanax-api` | API层，提供给org-gateway的接口 | `orgmanax-dto`
`orgmanax-common`| 公共组件、UTIL等 |无
`orgmanax-infra` | 基础设施层，隔离非业务变化，防止外部变化引起内部业务变更。<br/>对接二方服务，数据库，MQ等中件间 | `orgmanax-common`
`orgmanax-integration`| 封装了二方服务非纯净版本。如：apollo-api、gaia-api等。等两方服务统一规范后，该层就会移除。 | `orgmanax-infra`
`orgmanax-server`| 核心能力层，分为两块：<br/>1、通用能力:`foundation` 单域核心逻辑如：创建部门，创建单位 <br/>2、人岗架业务能力：`service` 如：创建班组、创建小组 <br/>`service` 依赖本域 `foundation`或他域service完成业务 | `orgmanax-api` `orgmanax-common` `orgmanax-infra`
`orgmanax-starter`| 启动类 | `orgmanax-api` `orgmanax-common` `orgmanax-infra` `orgmanax-server` `orgmanax-integration`
## 各模块参数约束
![img_3.png](img_3.png)
@ -82,7 +82,22 @@
## 目录层级
```
.
├── orgmanax-api #给org-gateway提供的api
├── orgmanax-dto # 通用对象包，仅提供需对外公开的对象，如：入参、出参、领域聚合对象、枚举等
│   └── src
│   └── main
│   └── java
│   └── cn
│   └── axzo
│   └── orgmanax
│   └── dto
│   ├── node
│   └── enums
│   └── dto
│   └── req
│   └── resp
│   └── payload
│   └── nodeuser
│── orgmanax-api #给org-gateway提供的api
│   ├── src
│   │   ├── main
│   │   │   └── java