SuperAPI AI 工具集

software-architecture

编程与开发

查看项目

更新于 10-16 05:51

技能介绍

用途:该技能为以质量为核心的软件开发与架构提供指导,适用于编写代码、设计架构和代码分析等场景,理论基础为整洁架构(Clean Architecture)与领域驱动设计(DDD)。

主要能力与规则: 代码风格方面,提倡优先使用提前返回(early return)替代嵌套条件以提升可读性;通过抽取可复用函数和模块避免重复;将超过80行的组件与函数拆分为更小的单元,无法复用时保留在同一文件内,但文件超过200行应拆分为多文件;尽量用箭头函数替代函数声明。

库优先:强调在编写自定义代码前先搜索现有方案,检查 npm 是否存在解决问题的库,评估现有服务或 SaaS 方案,考虑常见功能的第三方 API;例如使用 cockatiel 而非自行编写重试逻辑。仅当领域特定业务逻辑、有特殊要求的性能关键路径、外部依赖过重、需要完全控制的安全敏感代码或经充分评估后现有方案不满足需求时,才自行实现。

架构与设计:遵循 DDD 与统一语言,将领域实体与基础设施关注点分离,使业务逻辑独立于框架,清晰定义用例并保持隔离。命名上避免 utils、helpers、common、shared 等泛化名称,改用领域特定名称(如 OrderCalculator、UserAuthenticator、InvoiceGenerator),遵循限界上下文命名模式,每个模块应有单一明确用途。关注点分离要求不将业务逻辑与 UI 组件混合,不将数据库查询放入控制器,保持上下文间清晰边界。

应避免的反模式:NIH(重复造轮子)综合征,如已有 Auth0/Supabase 仍自建认证、已有 Redux/Zustand 仍自写状态管理、已有成熟库仍自建表单校验;糟糕架构选择,如业务逻辑与 UI 混合、控制器直连数据库查询、缺乏关注点分离;泛化命名,如含50个不相关函数的 utils.js、作为倾倒场的 helpers/misc.js、用途不清的 common/shared.js。

代码质量:使用带类型的 catch 进行错误处理;将复杂逻辑拆解为更小的可复用函数;避免超过3层的深层嵌套;函数尽量聚焦且不超过50行;文件尽量聚焦且不超过200行代码。

限制:资料未提供该技能的具体安装方式、平台支持、收费模式或价格信息,暂未提供。