SuperAPI AI 工具集

software-architecture

设计与创作

查看项目

更新于 10-15 21:38

技能介绍

用途:该技能为注重质量的软件开发与架构提供指导,基于整洁架构(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 混合、控制器中直接查数据库、缺乏清晰关注点分离;泛化命名反模式,如 utils.js 塞入50个无关函数、helpers/misc.js 当垃圾场、common/shared.js 用途不明。

代码质量:使用带类型的 catch 块进行错误处理;将复杂逻辑拆为更小可复用函数;避免超过3层的深层嵌套;函数尽量控制在50行以内,文件尽量控制在200行以内。

限制:资料未提供该技能的具体安装命令、平台支持、收费方式或使用步骤,暂未提供相关信息。