pipeline-architecture
业务逻辑管道架构规范,声明意图后统一执行。
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:pipeline-architecture。 它的用途是:业务逻辑管道架构规范,声明意图后统一执行。 完整的 Skill 内容见:https://321skill.com/skills/pipeline-architecture/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'我想新增一个用户注册API,包含邮箱验证、创建用户、发送欢迎邮件三个步骤,并记录审计日志。' 它会按照Pipeline Architecture生成Step定义(如EmailValidationStep、CreateUserStep、SendWelcomeEmailStep),然后统一通过Pipeline执行,并自动处理每个步骤的提交或回滚。
介绍
Pipeline Architecture 是一种将业务逻辑中的“决策”与“执行”分离的架构模式。当你的项目需要新增 API 端点、实现多步骤数据写入(如同时写入数据库、调用外部 API、更新设备变量)、进行权限检查或审计日志时,传统的命令式代码容易让流程变得混乱、难以回滚和测试。这个 Skill 提供了一套结构化的规范,让你先声明每个步骤的意图(Step),再统一提交(Commit)或终止(Stop),从而保证业务流程的清晰、可审计和可回滚。
使用方式非常简单:你只需按照系统定义的 Pipeline 结构,将业务拆解为多个 Step(如 Query、Mutation、Scratch、Persistence 等),每个 Step 声明其输入、输出和副作用,最后通过统一的入口执行整个流程。该 Skill 同时提供了 Python/FastAPI 和 TypeScript/Node.js 两种实现,你可以根据团队技术栈选择对应的代码模板或库。
适合使用该 Skill 的角色包括后端开发、全栈开发和智能体开发者。尤其是当你需要处理“先决断后执行”的 workflow(如订单处理、用户注册、跨系统同步)时,Pipeline Architecture 能显著提升代码的可维护性和可测试性。对于需要严格审计或支持回滚的金融、合规类业务场景,该模式几乎是必选方案。
使用建议:请确保你的项目已经采用了该架构(即项目中已存在 Pipeline 基类和 Step 抽象),否则需要先引入核心依赖。另外,不要将其用于简单的一次性操作(如单条数据查询),因为引入 Pipeline 会增加不必要的抽象成本。在实际编码时,可以结合项目的具体需求,通过继承 Step 类来快速实现自定义步骤。
核心特点
与常见的“中间件”或“函数式管道”不同,该 Skill 强调“先宣告意图、后统一执行”,将决策与执行严格分离,每个 Step 都可以独立 commit 或 stop,从而支持事务性回滚和完整的审计日志记录。
注意事项
不适合简单的一次性操作或无需审计的场景,过度使用会增加不必要的抽象成本。
常见问题
如何新增一个API endpoint?
先定义 Pipeline 中的 Step 列表(如 Query、Mutation、Persistence),然后调用 Pipeline.execute() 统一执行,无需手动编排每个步骤。具体请参考仓库中的示例代码。
支持哪些语言?
目前支持 Python/FastAPI 和 TypeScript/Node.js 两种实现,可根据项目技术栈选择对应版本。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/pipeline-architecture/raw/index.md 读取 pipeline-architecture 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/pipeline-architecture/raw/index.md(查看排版版本)