概述

这个项目是我在多年Go语言项目开发过程中学习和总结的规范。

制定规范的目的

• 保证代码质量
• 提高协作效率
• 降低维护成本

现代软件行业的高速发展对开发者的综合素质要求越来越高，不仅是写代码的知识点，其它维度的知识点也会影响到软件的最终交付质量。比如：

• 缺少日志、metrics导致上线后无法快速定位问题
• 缺少单元测试导致每次重构，都需要人工测试，成本高昂而且无法保证测试完整性
• 数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险
• 工程结构混乱、代码风格各异等导致后续维护艰难
• 没有鉴权的漏洞代码易被黑客攻击

本开发规范内容包含:

• 编码风格：代码的可读性是指代码让人容易阅读、理解、调试、可预料的程度。提高代码的可读性可以为代码阅读者节约时间和精力，提升团队协作效率。对于可读性，需要牢记，熟悉和遵守编码风格，那只是 “标”，遵守设计原则才是 “本”。
• 工程结构
• 错误处理
• 日志
• 服务metrics
• 安全编码