注重质量的软件架构指南。当用户需要编写代码、设计架构、分析代码或任何与软件开发相关的工作时,应使用此技能。
软件架构开发技能
功能概述
软件架构开发技能是一项面向实际任务的技能,主要用于本技能提供注重质量的软件开发和架构指导,基于整洁架构(Clean Architecture)和领域驱动设计(DDD)原则;代码风格规则;
核心要点
- 提前返回模式 :尽可能使用提前返回,而非嵌套条件,以提高可读性;
- 通过创建可复用的函数和模块避免代码重复;
- 将过长的(超过80行代码)组件和函数拆分为多个更小的组件和函数;
使用与执行
如果无法在其他地方复用,则保留在同一文件中;但如果文件超过。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
结果检查与注意事项
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
软件架构开发技能
本技能提供注重质量的软件开发和架构指导,基于整洁架构(Clean Architecture)和领域驱动设计(DDD)原则。
代码风格规则
通用原则
- 提前返回模式:尽可能使用提前返回,而非嵌套条件,以提高可读性
- 通过创建可复用的函数和模块避免代码重复
- 将过长的(超过80行代码)组件和函数拆分为多个更小的组件和函数。如果无法在其他地方复用,则保留在同一文件中。但如果文件超过200行代码,应拆分为多个文件
- 尽可能使用箭头函数而非函数声明
最佳实践
库优先方法
- 始终先搜索现有解决方案,再编写自定义代码
- 检查 npm 是否有解决该问题的现有库
- 评估现有的服务/SaaS 解决方案
- 考虑使用第三方 API 实现通用功能
- 使用库而非编写自己的工具函数或辅助代码。例如,使用
cockatiel而非自行编写重试逻辑 - 当确实需要自定义代码时:
- 领域特有的业务逻辑
- 有特殊要求的性能关键路径
- 外部依赖显得过度时
- 需要完全控制的安全敏感代码
- 经过全面评估后现有方案无法满足需求时
架构与设计
- 整洁架构与 DDD 原则:
- 遵循领域驱动设计和通用语言(ubiquitous language)
- 将领域实体与基础设施关注点分离
- 保持业务逻辑独立于框架
- 明确定义用例并保持其隔离
- 命名约定:
- 避免使用通用名称:
utils、helpers、common、shared - 使用领域特定名称:
OrderCalculator、UserAuthenticator、InvoiceGenerator - 遵循有界上下文(bounded context)命名模式
- 每个模块应有单一、明确的目的
- 避免使用通用名称:
- 关注点分离:
- 不要将业务逻辑与 UI 组件混合
- 保持数据库查询不在控制器中出现
- 维护各上下文之间的清晰边界
- 确保适当的职责分离
应避免的反模式
- 非我发明(NIH)综合征:
- 在有 Auth0/Supabase 的情况下不要构建自定义认证
- 不要编写自定义状态管理代替使用 Redux/Zustand
- 不要创建自定义表单验证代替使用成熟的库
- 糟糕的架构选择:
- 业务逻辑与 UI 组件混合
- 数据库查询直接在控制器中
- 缺乏清晰的关注点分离
- 通用命名反模式:
utils.js中包含50个不相关的函数helpers/misc.js作为垃圾场common/shared.js用途不明确
- 记住:每一行自定义代码都是需要维护、测试和文档化的负担
代码质量
- 使用类型化 catch 块进行适当的错误处理
- 将复杂逻辑分解为更小、可复用的函数
- 避免深层嵌套(最多3层)
- 保持函数专注且尽可能不超过50行
- 保持文件专注且尽可能不超过200行代码
相关专题
本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。
0
2026.11.06
围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。
0
2026.11.06
详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。
0
2026.11.06
DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。
0
2026.11.05
DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。
0
2026.11.05
本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。
0
2026.11.04
本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。
0
2026.11.04
本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。
0
2026.11.04
本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。
0
2026.11.04
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.8万人学习
共6课时 | 54.7万人学习
最新文章