整体概述，主要包含以下内容:
- 高质量编程原则:简单性、可读性、生产力
- 高质量编程实践:代码格式化、注释规范、命名规范、控制流程、错误处理
- 性能调优原则:通过分析调用链路、获取性能数据、定位性能瓶颈进行优化
- 性能调优工具:分析程序、获取性能数据、定位问题高质量编程简介及编码规范
总结30个要点:
- 👍 高质量编程的目标是编写正确可靠、简洁清晰的代码,需要考虑代码的复杂程度和可维护性。
- 💡 编程要遵循简单性原则,尽量用简单清晰的逻辑表达,减少程序复杂度。
- 📖 编程要遵循可读性原则,代码要容易被人理解,减少他人的代码理解成本。
- ⚙️ 编程要遵循生产力原则,提高团队协作效率,统一代码格式。
- 🖥 要使用代码格式化工具,统一代码格式,方便团队协作。
- 🗒️ 注释要解释代码的作用、实现原因和可能出错情况。好的代码需要少量注释。
- 📝 公共函数都需要添加注释,说明功能和用法。私有函数注释根据需要决定。
- 🏷️ 变量和函数命名要简洁明了,不同的作用域需要不同的命名方式。
- 📐 控制流程要保持正常逻辑简单直线,错误逻辑先返回。避免代码嵌套。
- 🚧 使用错误机制传递错误信息,方便跟踪调试。避免过多使用panic。
- 💊 使用recover机制屏蔽panic错误,不要在业务代码中嵌套使用。
- 🔍 性能优化需要从整体链路进行分析,定位优化关键点。
- 📈 需要获取详细的性能数据进行分析,定位性能瓶颈。
- 🛠️ 使用性能分析工具分析程序热点和资源消耗情况。
- 🚏 注意分析服务的上下游依赖,问题可能不在自己代码中。
- 📉 避免过早优化,需要有明确的性能数据支持。
- 🔨 可以通过添加缓存、减少IO、改善算法等方式提高性能。
- ⚡️ 对核心热点函数进行特定优化,其他函数保持简单。
- 📊 性能测试要覆盖不同输入、负载情况,对比优化效果。
- 🏭 生产环境性能数据才是优化的目标,测试环境引导方向。
- 🛩 避免复杂逻辑的嵌套和循环,提高代码可读性。
- 🗃 尽量减少变量作用域,或增加上下文信息。提高可读性。
- 🏁 控制流要保持主线简单直白,错误逻辑先返回。
- 🚨 错误需要传递明确信息,方便调试。避免过多使用panic。
- 🆘 使用recover处理panic,注意作用域。不要嵌套使用。
- 📐 命名要简明表达,避免使用常见名称和缩写。
- 📝 注释要解释额外上下文信息,补充代码的不足。
- 🛠️ 使用代码格式化工具,保持风格一致,提高协作效率。
- ✅ 从整体链路着手,通过数据定位性能瓶颈。
- 📈 性能优化需要以产品数据为目标,测试数据引导方向。
