Go Engineering - Elegant Project

优雅项目

Go 应用

代码结构

按功能拆分 - Kubernetes / Docker / Helm / Prometheus

代码规范

1. 编码规范 - https://github.com/xxjwxc/uber_go_guide_cn
2. 静态代码检查 - https://github.com/golangci/golangci-lint
3. 最佳实践
   • https://go.dev/doc/effective_go
   • https://go.dev/wiki/CodeReviewComments
   • https://rakyll.org/style-packages/

代码质量

1. 单元测试
   • 可测试
     • 将依赖的数据库等抽象成接口，在被测代码中调用接口的方法，在测试时传入 Mock 类型
     • 尽量减少 function 中的依赖 + 依赖是容易 Mock 的
   • 高覆盖率
2. Code Review

Mock 工具

1. https://github.com/golang/mock
   • 官方 Mock 框架，与 Golang 内置的 testing 包集成，最常用
   • 实现基于 interface 的 Mock 功能
2. https://github.com/DATA-DOG/go-sqlmock
   • 模拟数据库连接
3. https://github.com/jarcoal/httpmock
   • 模拟 HTTP 请求
4. https://github.com/bouk/monkey
   • 通过替换函数指针的方式来修改任意函数的实现

高覆盖率

1. 使用 gotests 自动生成单元测试代码
2. 定期检查单元测试覆盖率

$ go test -race -cover  -coverprofile=./coverage.out -timeout=10m -short -v ./...
$ go tool cover -func ./coverage.out

编程哲学

1. 面向接口编程
   • 接口的作用：为不同层级的模块提供一个定义好的中间层
2. 面向对象编程
   • Go 不支持 OOP，但可以利用自身特性实现类似效果

软件设计方法

设计模式

针对特定场景的最佳实现方式，同样适用于 Go

SOLID 原则

偏重设计原则 - https://github.com/marmotedu/geekbang-go/blob/master/SOLID原则介绍.md

项目管理

工具