Uber Go 语言编程规范：包名称

Uber Go 语言编码规范 中文版

uber_go_guide_tw：Uber Go 语言编写规范繁体中文翻译 项目介绍 Uber Go 语言编写规范是由Uber公司开源的一套用于指导Go语言编写的最佳实践。这些规范旨在帮助开发者编写易于管理、高效且安全的Go代码。该项目在GitHub上开源，已经吸引了众多开发者的关注和贡献。 项目技术分析 uber_go_guide_tw项目包含了Uber公司内部使用的Go语言编写规范，这些规范不...

值得参考的golang语言开发规范：Uber Go 语言编码规范，一些优秀的技巧可以提升代码的质量、避免代码缺陷和bug漏洞。

通过sync/atomic包的原子操作对原始类型s(int32,int64, etc.) 进行操作的时候，很容易忘记在对变量进行读取和修改的时候，使用原子操作。 而go.uber.org/atomic包通过隐藏基础类型对这些操作增加了类型安全，另外，它还包括了一个方便的atomic.Bool类型。 Bad type foo struct { running int32 // 原子类型 } func (f* foo) start() { //原子操作 if atomic.Swap..

git clone -b v0.20.0 --depth=1 https://github.com/uber/cadence.git -b 后面写上指定 版本标签 , 即 tag, 比如 v0.20.0 --depth 表示克隆深度, 1 表示只克隆最新的版本. 如果项目迭代的版本很多, 克隆会很慢

Go支持raw string literals（" ` " 来表示原生字符串）, 可以跨越多行并包含引号，使用这些可以避免手动转义的字符串，因为后者更难阅读。 Bad wantError := "unknown name:\"test\"" Good wantError := `unknown error:"test"` ...

在GO语言中引入枚举的标准方式是声明一个自定义类型和一个使用了iota的const组,由于变量有一个0的默认值，通常情况下，以非0值开始枚举。 Bad type Operation int const ( Add Operation = iota //从0开始 Subtract Multiply ) // Add=0, Subtract=1, Multiply=2 Good type Operation int const ( Add Operation = iota +

尽可能的避免调用init()方法，当init()是不可避免或必需的时候，代码应该尝试做如下建议： 不管是程序的环境还是调用，必须是完全确定的。 避免依赖其他init()函数的调用顺序或副作用，虽然init()函数是顺序调用是众所周知的，但代码可能会发生变化，因此init()函数之间的关系可能会使代码变得脆弱且容易出错。 避免访问或操纵全局状态或环境状态，例如：服务器信息、环境变量、工作目录、程序参数/输入等。 避免I/O，包括文件系统、网络和系统调用。 不能满足这些需求的代码可能属于一个辅助函数，作

应该有两个导入组： 标准库 其他库 默认情况下，这是goimports设置的分组： Bad import ( "fmt" "os" "go.uber.org/atomic" "golang.org/x/sync/errgroup" ) Good import ( "fmt" "os" "go.uber.org/atomic" "golang.org/x/sync/errgroup" ) ...

避免改变全局变量，而要选择依赖注入。这适用于函数指针以及其他类型的值。 Bad // sign.go //直接定义一个全局变量 var _timeNow = time.Now func sign(msg string) string { now := _timeNow() return signWithTime(msg, now) } // sign_test.go func TestSign(t *testing.T) { oldTimeNow := _timeNow //更

Channel 通道的大小，通常应该为1或不缓冲。默认情况下，通道是不缓冲的，并且通道的大小为0。 任何其他大小都应该必须受到严格的审查。考虑如何确定大小，在负载下如何防止通道被填满和阻塞写入器，以及发生这种情况时会发生什么。 Bad // 对任何人来说应该足够了 c := make(chan int, 64) Good // 大小为1 c := make(chan int, 1) // 或者 // 无缓冲channel, 大小为0 c := make(chan int) ...

我们建议至少使用以下的linters，因为我们认为它们有助于发现最常见的问题，并且在没有不必要的规定的情况下为代码质量建立一个高标准: errcheckto ensure that errors are handled goimportsto format code and manage imports golintto point out common style mistakes govetto analyze code for common mistakes staticcheck...

使用值接收器的方法既可以通过值调用，也可以通过指针调用。使用指针接收器的方法只能通过指针或addressable values调用 例如： type S struct { data string } //值接收器 func (s S) Read() string { return s.data } //指针接收器 func (s *S) Write(str string) { s.data = str } //定义一个map,value为S{1: {"A"} sVals := map[

在编译时适当的时候验证接口的合规性，这主要包括： 作为API契约的一部分，需要实现特定接口的导出类型。 导出和未导出类型都是作为实现同一接口类型集合的一部分。 其他违反接口的情况，将会阻止用户编译。 坏的的代码风格： type Handler struct { // ... } func (h *Handler) ServeHTTP( w http.ResponseWriter, r *http.Request, ) { ... } 好的代码风格： type Handl

如果一个函数或方法调用失败时，有三种方式来传播错误： 如果没有额外的上下文环境需要添加并且你想保持原始的错误类型的话，请返回原始的错误。 通过"pkg/errors".Wrap添加上下文环境，以至于错误消息能够提供更多的上下文信息，并且"pkg/errors".Cause可以用来提取原始的错误。 如果调用者无需断言和处理指定的错误的情况下，请使用fmt.Errorf 强烈建议在可能的情况下，请添加上下文，这样就不会出现“connection refused”这样模糊的错误，你会得到更多有用的错误描述信

如果包名称不能与导入路径的最后一个元素匹配的话，则必须使用导入别名 import ( "net/http" client "example.com/client-go" trace "example.com/trace/v2" ) 在所有其他场景中，应该避免导入别名，除非导入之间有直接冲突 Bad import ( "fmt" "os" nettrace "golang.net/x/trace" //此处，应该避免使用导入别名 ) Good import (

在未导出的顶层变量和常量前面加上_，以便在使用它们时清楚地表明它们是全局的标识符。 异常:未导出的错误值，应该以err作为前缀。 基本原理:顶层变量和常量有一个包的作用域。使用通用名称很容易在不同的文件中意外地使用错误的值。 Bad // foo.go //这两个常量拥有包级作用域 const ( defaultPort = 8080 defaultUser = "user" ) // bar.go func Bar() { //这个文件中，把默认端口给改掉了 defaultP

sync.Mutexand和.RWMutex的零值是有效的，你几乎不需要一个指向mutex的指针。 坏的编程方式： mu := new(sync.Mutex) mu.Lock() 好的编程方式： var mu sync.Mutex mu.Lock() 如果使用结构体指针，mutex可以非指针形式作为结构体的组成字段。 对于一个非导出的结构体(首字母小写)类型或者是要实现Mutex接口的类型，可以自动嵌入mutex. type smap struct { sync.Mutex //..