SuperAPI AI 工具集

maintainable-app

编程与开发

查看项目

更新于 10-15 23:42

技能介绍

用途:maintainable-app 是一份面向生产环境应用的编码与评审指南,目标是在构建、修改和审查代码时,让常见生产故障能够自动恢复、有意降级,并留下足够信号供维护者理解发生了什么。它适用于面向用户的应用、后台 worker、定时任务、Webhook、支付流程、导入导出、通知、API 集成、数据库状态变更、缓存、文件上传、队列、cron、认证会话流程、可观测性、日志、追踪、告警与可靠性行为。

主要能力:提供决策树,按场景引导阅读不同参考文档,包括核心原则、任务与队列、分布式系统、可观测性、评审清单、常见陷阱与来源说明。给出快速参考表,覆盖重复提交、Webhook 重放、重试、worker 重启、昂贵任务合并、任务长时间挂起、远程 API 调用、队列峰值、数据库写入后的副作用、多步分布式工作流、部分故障、日志、指标、追踪与告警等情形。核心规则强调把重试、重复投递、并发、延迟、部分失败、部署重启与陈旧状态视为正常输入;为昂贵或有副作用的操作提供稳定标识;使用显式状态机;在应用内实现恢复;限制爆炸半径;在边界处实现幂等;跨边界设置超时;优先考虑延迟、流量、错误与饱和度四个黄金信号;安全记录日志;测试恢复路径。还提供自愈门禁清单,检查标识、状态、并发、时间、重试、恢复、降级、可观测性、告警与测试。

使用方式:作为技能在后台加载,当编码任务涉及生产应用时触发。小型改动保持轻量,静默运行快速故障模式检查,只提及会改变实现的失效保护、边界情况与可观测性决策。若可用,源代码改动同时加载 maintainable-code,测试改动加载 maintainable-tests。按决策树选择阅读 references/principles.md、references/jobs-and-queues.md、references/distributed-systems.md、references/observability.md、references/review-rubric.md、references/gotchas.md、references/source-notes.md。可选辅助脚本:python3 scripts/analyze_app_resilience.py /path/to/project 或加 --json,用于扫描可能缺失的幂等性、重试退避缺口、无超时的外部调用、低上下文日志、被吞掉的错误与无恢复的挂起状态,但扫描结果不作为结论。

适用场景:生产应用、后台任务、队列、Webhook、支付、导入导出、通知、API 集成、数据库状态转换、缓存、文件上传、cron、认证会话、可观测性与可靠性相关开发与评审。

限制:资料未提供具体收费、价格、平台支持范围或效果保证。辅助脚本仅作提示,安静扫描不代表应用具备韧性,嘈杂扫描也不代表代码有误。更多可观测性不一定更好,高基数、含密钥或无人查询的遥测会增加成本与风险。死信队列需要告警、检查字段、重投规则与毒消息策略。优雅降级必须在故障发生前实现。