feat: add optional Spring REST adapter and catalog SPI

Expose OrdoEngine over conditionally registered HTTP endpoints in autoconfigure, keep JDBC wiring in spring.jdbc, and share definition JSON via ProcessDefinitionParser.toJson.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
0264408
2026-09-17 10:30:09 +08:00
co-authored by Cursor
parent 7d17157633
commit 0288a8b3dd
29 changed files with 1295 additions and 27 deletions
+42 -6
View File
@@ -10,9 +10,7 @@ Ordo 是嵌入宿主进程的审批引擎,入口是 `OrdoEngine`。
做:流程定义、实例推进、待办任务、条件路由、ACTION 副作用、审计事件、分页查询。
产品边界:不做业务表单、用户体系、多租户;不内置设计器 UI。业务字段放在 `ProcessContext`(不可变 `Map<String, Object>`)。当前也**没有** REST;HTTP 仍由宿主自建。计划中的可选 REST 与独立设计器见 [roadmap.md](roadmap.md)。
开发计划(尚未提供,见 [roadmap.md](roadmap.md)):可选 REST + 目录 SPI。
产品边界:不做业务表单、用户体系、多租户;不内置设计器 UI。业务字段放在 `ProcessContext`(不可变 `Map<String, Object>`)。可选 HTTP 见 §2.3;独立设计器见 [roadmap.md](roadmap.md)。
## 2. 模块与接入
@@ -66,6 +64,9 @@ ordo:
location: classpath*:ordo/*.json # 启动时对每个 JSON 调用 publish
due:
poll-ms: 0 # >0 时轮询 processDue;默认不调度
rest:
enabled: false
base-path: /ordo
```
启动加载使用 `publish`:图与 latest 相同则不升版本;不同则写入新版本。运行中实例继续锁定发起时所用版本。
@@ -78,9 +79,44 @@ ordo:
| `RoutingCondition` | 始终匹配(无条件边) |
| `ActionHandler` | 空操作 |
| `OrdoEventListener` | 可有多个,提交后按 Spring 顺序调用 |
| `OrdoCatalog` | 空列表(仅 REST 打开时装配) |
未提供自定义 Bean 时,ACTION 步骤仍会推进流程,但 handler 什么都不做。
### 2.3 可选 REST
`spring-boot-starter-web` 对 autoconfigure 为 optional,starter **不**传递 Web。宿主已有 Web 且 `ordo.rest.enabled=true` 时注册 `com.jetlumen.ordo.spring.rest` 下的接口。不包含鉴权;`actor` / `initiator` 放在 JSON 体。OpenAPI:[ordo-rest.openapi.yaml](ordo-rest.openapi.yaml)。
默认前缀 `/ordo`:
| 方法 | 路径 | 引擎 |
|---|---|---|
| POST | `/definitions/parse` | `ProcessDefinitionParser.fromJson` |
| POST | `/definitions` | `publish` |
| GET | `/definitions` | `queryDefinitions` |
| GET | `/definitions/{id}` | `findDefinition`(latest) |
| GET | `/definitions/{id}/versions` | `queryDefinitionVersions` |
| GET | `/definitions/{id}/versions/{version}` | `findDefinition(id, version)` |
| POST | `/instances` | `start` |
| GET | `/instances` | `queryInstances` |
| GET | `/instances/{id}` | `findInstance` |
| POST | `/instances/{id}/withdraw` | `withdraw` |
| POST | `/instances/{id}/cancel` | `cancel` |
| GET | `/instances/{id}/tasks` | `findTasks` |
| GET | `/instances/{id}/tasks/pending` | `findPendingTasksByInstanceId` |
| GET | `/instances/{id}/history` | `queryHistory` |
| GET | `/instances/{id}/action-executions` | `queryActionExecutions` |
| GET | `/tasks` | `queryTasks` |
| GET | `/tasks/pending?assignee=` | `findPendingTasksByAssignee` |
| GET | `/tasks/{id}` | `findTask` |
| POST | `/tasks/{id}/approve` | `approve` |
| POST | `/tasks/{id}/reject` | `reject` |
| POST | `/tasks/{id}/reassign` | `reassign` |
| POST | `/due` | `processDue`(默认 limit 100) |
| GET | `/catalog/conditions\|actions\|assignees` | `OrdoCatalog` |
定义读写 JSON 与 §3.2 相同。HTTP:404 找不到;403 越权;409 已完成/无路由;400 非法参数。
## 3. 流程定义
每个定义有 `id`、引擎分配的 `version`、`name`、步骤列表、转移列表。步骤 id 在定义内唯一。每个步骤必须至少有一条出边(结束用 `to = null`)。同一 `from` 上 `priority` 不能重复。
@@ -121,7 +157,7 @@ new ProcessDefinition("leave-request-routed", "Leave request",
### 3.2 JSON
`ProcessDefinitionParser.fromJson(String|InputStream)`。Spring 默认扫 `classpath*:ordo/*.json`。
`ProcessDefinitionParser.fromJson(String|InputStream)` / `toJson(ProcessDefinition)`。Spring 默认扫 `classpath*:ordo/*.json`。`toJson` 写出 `version` 与 `startStep`(当前步骤列表首位);`fromJson` 仍忽略 JSON 里的 `version`。
```json
{
@@ -355,6 +391,6 @@ Flyway 脚本按方言分目录:`db/postgresql/migration`、`db/mysql/migratio
## 13. 未提供能力
开发计划中(见 [roadmap.md](roadmap.md)):可选 REST + 目录 SPI。独立设计器不进本仓库,等 REST 与目录之后再做。
独立设计器不进本仓库,等 REST 与目录之后由单独产品消费(见 [roadmap.md](roadmap.md))。
暂不在计划中:多租户、设计器 UI。当前 REST 由宿主自建。
暂不在计划中:多租户、设计器 UI。