Files
orbit/docs/examples/README.md

2.8 KiB
Raw Blame History

通用场景示例

示例只使用通用的作业、对象、文件、资源与审核信号,不包含接入方项目名称或行业规则。

已可运行:健康检查

  • 源码:SDK 健康检查。
  • 前置:已迁移的 MySQL 与已启动的基础服务。
  • 操作与预期输出:SDK 接入说明。
  • 异常:数据库不可用或迁移记录异常时 readiness 返回 HTTP 503,SDK 返回类型化状态错误。
  • 清理:只读调用,无业务资源需要删除。

已可运行:文件转换任务的受理与取消

  • 源码:SDK 任务受理示例。
  • 前置:完成迁移、初始化凭据、启动服务,在没有 Worker 消费的专用队列运行此受理/取消示例,详见 SDK 接入。
  • 输入:对象引用、格式与精确整数;提交两次同一身份,再查询、分页并带版本取消。
  • 预期:重复请求返回同一任务,最终 CANCELLED/revision=2。当前不启动 Worker,不实际生成文件。
  • 异常:凭据失效、权限不足、内容冲突、版本竞争和未知网络结果,见 任务接口。
  • 清理:示例以取消结束;任务和审计历史保留。重复运行会生成独立示例任务。

计划场景与验收标准

场景 输入与步骤 预期结果 必测异常 状态
文件转换 对象引用 → 提交任务 → Worker 转换 → 结果引用 同一操作获得一次业务结果,历史可查 重复提交、Worker 在结果上报前中断 P1 受理完成,P2 执行待开发
定期同步 发布计划 → 周期触发 → 暂停 → 恢复 触发身份唯一,漏跑策略可追溯 多节点竞争、停机后补跑上限 P3 待开发
并行生成 输入对象 → 并行计算两份结果 → 汇合 两支满足条件后只创建一份后继工作 一支失败、重复结果、汇合竞争 P4 待开发
等待审核 校验 → 等待信号 → 发布结果 只接受授权、匹配当前操作的信号 早到、重复、过期与越权信号 P4 待开发
外部作业查询 提交一次 → 间隔查询 → 最终结果 处理中消耗轮次,请求失败消耗尝试 回执与查询竞争、预算耗尽、响应未知 P5 待开发
暂停与恢复 暂停 → 接收在途结果 → 核查 → 继续 历史与预算保留,已成功工作不重复 暂停/开始竞争、恢复时已过期 P5 待开发

每个待开发场景最终都需提供独立目录、完整源码、配置模板、启动与验证命令,不能只留下概念流程图。配套回归会先使用可控的模拟处理器或外部服务,不对真实系统产生副作用。