diff --git a/README.md b/README.md index 78a070d..da7e237 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ - ## 接口规范 -- 所有接口统一采用POST,列表接口需要带上分页且设置默认大小1000条 +- 所有接口统一采用POST,列表接口需要设置默认大小1000条 - 接口出入参,必须使用可扩展的对象类型。不能直接是 String,Integer,或者List这些无法扩展的类型。 - 为每个接口定义自己的出入参,不要复用出入参 - 接口URL使用 【-】符号进行分割,比如: /orgmanax/node/create-team @@ -60,14 +60,14 @@ ## 模块描述 -模块名称 | 功能 | 依赖 ------- |---------------------------------------------------------------------------------------------------------------------------------------| ---- -`orgmanax-api` | API层,提供给org-gateway的接口 |无 -`orgmanax-common`| 公共组件、UTIL等 |无 -`orgmanax-infra` | 基础设施层,隔离非业务变化,防止外部变化引起内部业务变更。
对接外部依赖,数据库,MQ等中件间 | `orgmanax-common` -`orgmanax-integration`| 封装了非基础业务的API,防止外部API无用依赖影响内部。如:apollo-api、gaia-api等 | `orgmanax-infra` -`orgmanax-server`| 业务层,核心分为两层:
1、基础层:`foundation` 单域核心逻辑如:创建部门,创建单位
2、业务层:`service` 如:创建班组、创建小组
`service` 依赖本域 `foundation`或他域service完成业务 | `orgmanax-api` `orgmanax-common` `orgmanax-infra` -`orgmanax-starter`| 启动类 | `orgmanax-api` `orgmanax-common` `orgmanax-infra` `orgmanax-server` `orgmanax-integration` +模块名称 | 功能 | 依赖 +------ |--------------------------------------------------------------------------------------------------------------------------------------------| ---- +`orgmanax-api` | API层,提供给org-gateway的接口 |无 +`orgmanax-common`| 公共组件、UTIL等 |无 +`orgmanax-infra` | 基础设施层,隔离非业务变化,防止外部变化引起内部业务变更。
对接二方服务,数据库,MQ等中件间 | `orgmanax-common` +`orgmanax-integration`| 封装了二方服务非纯净版本。如:apollo-api、gaia-api等。等两方服务统一规范后,该层就会移除。 | `orgmanax-infra` +`orgmanax-server`| 核心能力层,分为两块:
1、通用能力:`foundation` 单域核心逻辑如:创建部门,创建单位
2、人岗架业务能力:`service` 如:创建班组、创建小组
`service` 依赖本域 `foundation`或他域service完成业务 | `orgmanax-api` `orgmanax-common` `orgmanax-infra` +`orgmanax-starter`| 启动类 | `orgmanax-api` `orgmanax-common` `orgmanax-infra` `orgmanax-server` `orgmanax-integration` ## 各模块参数约束 @@ -79,7 +79,6 @@ - XXXUpdate:更新入参 - DO:数据库实体,DO使用充血模型,包括属性和行为,定义行为的范围:只能是本对象内部属性发生变更的行为 - ## 目录层级 ``` . @@ -137,7 +136,7 @@ │   │   │   │   ├── mapper │   │   │   │   └── repository │   │   │   │   └── impl -├── orgmanax-integration #封装非基础域API,该层会引用其它域的feign +├── orgmanax-integration #封装二方非纯净API │   └── src │   └── main │   └── java @@ -153,7 +152,7 @@ │   ├── elise │   ├── gaia │   └── profile -├── orgmanax-server#业务服务层 +├── orgmanax-server#核心能力层 │   └── src │   ├── main │   │   └── java @@ -166,14 +165,14 @@ │   │   │   ├── event#协同关系事件 │   │   │   │   └── inner │   │   │   │   └── payload -│   │   │   └── service# 协同关系业务 +│   │   │   └── service# 协同关系相关业务 │   │   │   └── impl │   │   ├── node#部门相关 │   │   │   ├── controller │   │   │   ├── event#部门事件 │   │   │   │   └── inner │   │   │   │   └── payload -│   │   │   ├── foundation#部门基础功能(如创建部门、更新部门) +│   │   │   ├── foundation#部门基础能力层 │   │   │   │   ├── impl │   │   │   │   └── req │   │   │   └── service# 部门业务(创建班组、解散班组、更换班组长、创建小组) diff --git a/orgmanax-api/README.md b/orgmanax-api/README.md index e69de29..621a737 100644 --- a/orgmanax-api/README.md +++ b/orgmanax-api/README.md @@ -0,0 +1 @@ +-- 待补充 \ No newline at end of file diff --git a/orgmanax-common/README.md b/orgmanax-common/README.md index e69de29..621a737 100644 --- a/orgmanax-common/README.md +++ b/orgmanax-common/README.md @@ -0,0 +1 @@ +-- 待补充 \ No newline at end of file diff --git a/orgmanax-infra/README.md b/orgmanax-infra/README.md index e69de29..621a737 100644 --- a/orgmanax-infra/README.md +++ b/orgmanax-infra/README.md @@ -0,0 +1 @@ +-- 待补充 \ No newline at end of file