Golang高效开发与测试工具插件库Trybe的使用

Trybe Go风格指南

本指南定义了Trybe在编写Go代码时采用的标准和最佳实践。指南按主题组织，并根据对代码质量的影响和需求进行优先级排序。

注意：这是一个动态文档，会随着Trybe需求的变化以及我们解决问题的决策而更新。

架构

整洁架构

我们使用整洁架构来组织代码。关于该架构及其概念的更多信息：

• Clean Architecture, 2 years later
• Software Architecture and the Clean Architecture (pt-BR slides)

配置变量

根据12 factor项目的建议，我们将随环境(staging、dev、production)变化的配置存储在环境变量中。而不依赖环境的配置则存储在仓库内的TOML格式文件中。为了更轻松地管理配置，我们使用Viper库。

仓库结构

我们采用monorepo概念，多个项目共享同一个Github仓库。

优点：

• 易于管理依赖和重用代码

缺点：

• 更复杂的CI/CD流程

我们分析了优缺点后认为monorepo是我们的最佳选择。

仓库结构示例：

├── README.md
├── app1
│   ├── Makefile
│   ├── api
│   │   ├── handler
│   │   └── presenter
│   ├── cmd
│   ├── config
│   ├── entity
│   ├── infrastructure
│   └── usecase
├── app2
│   └── api
├── go.mod
└── internal
    ├── cache
    ├── errors
    └── test

错误处理

错误消费者

错误需要针对不同消费者有不同的处理方式。系统中有三类消费者：应用程序、终端用户和运维人员。

应用程序角色：能够从错误状态快速恢复 终端用户角色：需要可读的错误消息来解决问题 运维角色：需要尽可能多的错误信息，包括错误代码、消息和逻辑堆栈跟踪

错误模式结构

我们构建了一个错误类型来处理这些情况：

package errors

import (
	"bytes"
	"encoding/json"
	"fmt"
)

// 应用错误码
const (
	ECONFLICT  = "conflict"  // 操作无法执行
	EINTERNAL  = "internal"  // 内部错误
	EINVALID   = "invalid"   // 验证失败
	ENOTFOUND  = "not_found" // 实体不存在
	EFORBIDDEN = "forbidden" // 操作禁止
	EEXPECTED  = "expected"  // 预期错误不需要记录
	ETIMEOUT   = "timeout"
)

// Error定义标准应用错误
type Error struct {
	Code    string // 机器可读的错误码(应用角色)
	Message string // 人类可读的消息(终端用户角色)
	Op      string // 逻辑操作(运维角色)
	Err     error  // 嵌入错误(运维角色)
	Detail  []byte // JSON编码数据(运维角色)
}

分角色错误管理

应用/运维：

• 始终返回存在的错误，不记录日志
• 始终设置Code、Op和Err字段
• 不需要设置Message字段

终端用户：

• 在Controller层定义Message字段

外部包

HTTP路由器

我们使用Chi，选择因素包括：

• 功能丰富
• 项目活跃度
• 大型项目使用案例
• 高性能
• 无外部依赖

测试

我们使用testify使测试代码更可读：

package yours

import (
	"testing"
	"github.com/stretchr/testify/assert"
)

func TestSomething(t *testing.T) {
	// 断言相等
	assert.Equal(t, 123, 123, "they should be equal")

	// 断言不等
	assert.NotEqual(t, 123, 456, "they should not be equal")

	// 断言nil(适合错误)
	assert.Nil(t, object)

	// 断言非nil(适合期望值)
	if assert.NotNil(t, object) {
		assert.Equal(t, "Something", object.Value)
	}
}

Mock

我们使用testify/mock和mockery作为测试中的mock解决方案。

ORM vs SQL

待定义。

IDE

我们推荐使用Visual Studio Code，这也是Trybe所有团队使用的IDE。

必须安装官方Go语言扩展。

VS Code配置建议

{
  "go.testFlags": [
    "-failfast",
    "-v"
  ],
  "go.toolsManagement.autoUpdate": true,
  "gopls": {
    "ui.semanticTokens": true
  },
  "go.lintOnSave": "file",
  "go.lintTool": "golint", 
  "go.formatTool": "goimports",
  "go.useLanguageServer": true,
  "[go]": {
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.organizeImports": true
    }
  },
  "go.docsTool": "godoc"
}