没有合适的资源？快使用搜索试试~ 我知道了~

首页Uber Go 语言编程规范中文版.pdf

Uber Go 语言编程规范中文版.pdf

uber

golang

3星 · 超过75%的资源需积分: 5 42 下载量 82 浏览量更新于2023-03-16 评论 1 收藏 426KB PDF 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

试读

36页

Uber Go 语言编程规范中文版 Uber 是一家美国硅谷的科技公司，也是 Go 语言的早期 adopter. 其开源了很多 golang 项目，诸如被 Gopher 圈熟知的 zap、jaeger 等。2018 年年末 Uber 将内部的 Go 风格规范开源到 GitHub，经过一年的积累和更新，该规范已经初具规模，并受到广大 Gopher 的关注。本文是该规范的中文版本。

资源详情

资源评论

资源推荐

uber-go/guide 的中⽂翻译

English

Uber Go 语⾔编码规范

Uber 是⼀家美国硅⾕的科技公司，也是 Go 语⾔的早期 adopter. 其开源了很多 golang 项

⽬，诸如被 Gopher 圈熟知的 zap、jaeger 等。2018 年年末 Uber 将内部的 Go ⻛格规范开源

到 GitHub，经过⼀年的积累和更新，该规范已经初具规模，并受到⼴⼤ Gopher 的关注。本⽂

是该规范的中⽂版本。本版本会根据原版实时更新。

1. 版本

当前更新版本:2019-10-23 版本地址：commit:#55~#61

如果您发现任何更新、问题或改进，请随时 fork 和 PR

Please feel free to fork and PR if you ﬁnd any updates, issues or improvement.

2. ⽬录

介绍

指导原则

指向 interface 的指针

接收器 (receiver) 与接⼝

零值 Mutex 是有效的

在边界处拷⻉ Slices 和 Maps

使⽤ defer 释放资源

Channel 的 size 要么是 1，要么是⽆缓冲的

枚举从 1 开始

错误类型

错误包装 (Error Wrapping)

处理类型断⾔失败

不要 panic

使⽤ go.uber.org/atomic

性能

优先使⽤ strconv ⽽不是 fmt

避免字符串到字节的转换

尽量初始化时指定 Map 容量

规范

⼀致性

相似的声明放在⼀组

import 分组

包名

函数名

导⼊别名

函数分组与顺序

减少嵌套

不必要的 else

顶层变量声明

对于未导出的顶层常量和变量,使⽤_作为前缀

结构体中的嵌⼊

使⽤字段名初始化结构体

本地变量声明

nil 是⼀个有效的 slice

⼩变量作⽤域

避免参数语义不明确（Avoid Naked Parameters）

使⽤原始字符串字⾯值,避免转义

初始化 Struct 引⽤

Initializing Maps

字符串 string format

命名 Printf 样式的函数

编程模式

表驱动测试

功能选项

3. 介绍

样式 (style) 是⽀配我们代码的惯例。术语样式有点⽤词不当，因为这些约定涵盖的范围不

限于由 gofmt 替我们处理的源⽂件格式。

本指南的⽬的是通过详细描述在 Uber 编写 Go 代码的注意事项来管理这种复杂性。这些规

则的存在是为了使代码库易于管理，同时仍然允许⼯程师更有效地使⽤ Go 语⾔功能。

该指南最初由 [Prashant Varanasi] 和 [Simon Newton] 编写，⽬的是使⼀些同事能快速使

⽤ Go。多年来，该指南已根据其他⼈的反馈进⾏了修改。

本⽂档记录了我们在 Uber 遵循的 Go 代码中的惯⽤约定。其中许多是 Go 的通⽤准则，⽽

其他扩展准则依赖于下⾯外部的指南：

1. Eﬀective Go

2. The Go common mistakes guide

所有代码都应该通过 golint 和 go vet 的检查并⽆错误。我们建议您将编辑器设置为：

保存时运⾏ goimports

运⾏ golint 和 go vet 检查错误

您可以在以下 Go 编辑器⼯具⽀持⻚⾯中找到更为详细的信息： https://github.com/golan

g/go/wiki/IDEsAndTextEditorPlugins

4. 指导原则

4.1. 指向 interface 的指针

您⼏乎不需要指向接⼝类型的指针。您应该将接⼝作为值进⾏传递，在这样的传递过程中，

实质上传递的底层数据仍然可以是指针。

接⼝实质上在底层⽤两个字段表示：

1. ⼀个指向某些特定类型信息的指针。您可以将其视为"type."

2. 数据指针。如果存储的数据是指针，则直接存储。如果存储的数据是⼀个值，则存储指向该值的指

针。

如果希望接⼝⽅法修改基础数据，则必须使⽤指针传递。

4.2. 接收器 (receiver) 与接⼝

使⽤值接收器的⽅法既可以通过值调⽤，也可以通过指针调⽤。

例如，

同样，即使该⽅法具有值接收器，也可以通过指针来满⾜接⼝。

type S struct {

data string

}

func (s S) Read() string {

return s.data

}

func (s *S) Write(str string) {

s.data = str

}

sVals := map[int]S{1: {"A"}}

// 你只能通过值调⽤ Read

sVals[1].Read()

// 这不能编译通过：

// sVals[1].Write("test")

sPtrs := map[int]*S{1: {"A"}}

// 通过指针既可以调⽤ Read，也可以调⽤ Write ⽅法

sPtrs[1].Read()

sPtrs[1].Write("test")

Bad Good

Eﬀective Go 中有⼀段关于 pointers vs. values 的精彩讲解。

4.3. 零值 Mutex 是有效的

sync.Mutex 和 sync.RWMutex 是有效的。因此你⼏乎不需要⼀个指向 mutex 的指针。

如果你使⽤结构体指针，mutex 可以⾮指针形式作为结构体的组成字段，或者更好的⽅式

是直接嵌⼊到结构体中。如果是私有结构体类型或是要实现 Mutex 接⼝的类型，我们可以使⽤

嵌⼊ mutex 的⽅法：

type F interface {

f()

}

type S1 struct{}

func (s S1) f() {}

type S2 struct{}

func (s *S2) f() {}

s1Val := S1{}

s1Ptr := &S1{}

s2Val := S2{}

s2Ptr := &S2{}

var i F

i = s1Val

i = s1Ptr

i = s2Ptr

// 下⾯代码⽆法通过编译。因为 s2Val 是⼀个值，⽽ S2 的 f ⽅法中没有使⽤值接收器

// i = s2Val

mu := new(sync.Mutex)

mu.Lock()

var mu sync.Mutex

mu.Lock()

type smap struct {

sync.Mutex // only for unexported types（仅适⽤于⾮导出类型）

为私有类型或需要实现互斥接⼝的类型嵌⼊。对于导出的类型，请使⽤专⽤字段。

4.4. 在边界处拷⻉ Slices 和 Maps

slices 和 maps 包含了指向底层数据的指针，因此在需要复制它们时要特别注意。

4.4.1. 接收 Slices 和 Maps

请记住，当 map 或 slice 作为函数参数传⼊时，如果您存储了对它们的引⽤，则⽤户可以

对其进⾏修改。

data map[string]string

}

func newSMap() *smap {

return &smap{

data: make(map[string]string),

}

func (m *smap) Get(k string) string {

m.Lock()

defer m.Unlock()

return m.data[k]

}

type SMap struct {

mu sync.Mutex // 对于导出类型，请使⽤私有锁

data map[string]string

}

func NewSMap() *SMap {

return &SMap{

data: make(map[string]string),

}

func (m *SMap) Get(k string) string {

m.mu.Lock()

defer m.mu.Unlock()

return m.data[k]

}

剩余35页未读，继续阅读

weixin_42048567

2023-05-16

好像是不全啊 #待补充教程

uber_go_guide_cn：Uber Go语言编码规范中文版。 Uber Go风格指南

Go编程语言规范

Go编程语言规范，建议Golang的初学者尽快下载阅读，避免走弯路。

Uber Go 语言编码规范中文版.md

C:\Users\xfr17\go\pkg\mod\go.uber.org\multierr@v1.10.0\error.go:224:20: undefined: atomic.Bool note: module requires Go 1.19

关于问题的报错信息"undefined: atomic.Bool"表明在该代码中使用了Go语言的atomic包中的Bool类型，但是该类型在当前的Go版本中是未定义的。根据引用中的提示，该模块要求Go版本为1.19。因此，解决该问题的方法是升级...

flink-shaded-hadoop-3-uber.jar

flink-shaded-hadoop-3-uber.jar是一个用于Flink的Hadoop 3.x Uber JAR包。Hadoop是一个用于处理大规模数据的开源分布式计算框架，而Flink则是另一个用于流处理和批处理的分布式计算框架。 Hadoop 3.x是Hadoop的...

uber - standard shader ultra

Uber - 标准着色器 Ultra是指优质的渲染效果，它是一种高级的着色器技术，可以为3D计算机图形提供更加真实的视觉效果。Uber - 标准着色器 Ultra提供了更高的分辨率和更细致的细节，这使得它可以呈现更加真实的光照和...

flink shaded hadoop 2 uber 2.7.5-10.0 源码下载

Flink shaded hadoop 2 uber 2.7.5-10.0 是一个用于 Apache Hadoop 的 Flink shaded hadoop uber 发行版。该版本包含了许多来自 Apache Hadoop 2.7.5 的库，同时也集成了 Flink 所需的库和依赖项。如果您需要运行...

hive-jdbc-uber-jar 下载

Hive-JDBC Uber Jar 是一个包含了所有依赖项的单一 JAR 文件，使得使用 Hive JDBC 连接数据库更加方便。为了下载 hive-jdbc-uber-jar，您可以按照以下步骤进行操作： 1. 打开您的网络浏览器并访问 Apache Hive 的...

怎么解决Job running in uber mode : false？

如果您的作业在 Hadoop 中运行时显示 "Job running in uber mode : false"，这意味着该作业没有在 Uber Mode 下运行。这可能是由于多种原因引起的，以下是一些可能的解决方法： 1. 增加 Hadoop 配置的内存限制。在 ...

gozero 输出的日志是堆在一起的怎么格式化输出

go-zero 默认使用的是 zap 作为日志框架，可以通过修改 zap 的配置来实现日志格式化输出。如果要将日志格式化输出，可以使用 zap 库提供的 JSONEncoder 或 ConsoleEncoder。以下是一个简单的示例，使用 ...

golang 链路追踪

Go语言的链路追踪通常使用OpenTracing和Jaeger实现，具体步骤如下： 1. 安装Jaeger：可以在官网下载Jaeger的可执行文件进行安装，也可以使用Docker容器进行安装。 2. 引入OpenTracing和Jaeger相关库：在Go语言中，...

sea_way

粉丝: 8
资源: 20

上传资源快速赚钱

我的内容管理收起

我的资源快来上传第一个资源

我的收益

登录查看自己的收益

我的积分登录查看自己的积分

我的C币登录后查看C币余额

我的收藏

我的下载

下载帮助

会员权益专享

Uber Go 语言编程规范中文版.pdf

评论1

会员权益专享

最新资源

Uber Go 语言编程规范 中文版.pdf

评论1

uber_go_guide_cn：Uber Go语言编码规范中文版。 Uber Go风格指南

Go编程语言规范

Uber Go 语言编码规范中文版.md

v1.9-2.6.5/hive-jdbc-uber-2.6.5.0-292.jar

hive-jdbc-uber-2.6.5.0-292.zip

hive-jdbc-uber-2.6.5.0-292.jar

uber golang 规范

hive-jdbc-uber-2.6.5.0-292jar 下载

go语言中dig.In的用法

go语言前景及适应范围

hive-jdbc-uber-2.6.5.0-292下载

flink-shaded-hadoop-2-uber-2.7.5-10.0.jar

C:\Users\xfr17\go\pkg\mod\go.uber.org\multierr@v1.10.0\error.go:224:20: undefined: atomic.Bool note: module requires Go 1.19

flink-shaded-hadoop-3-uber.jar

uber - standard shader ultra

flink shaded hadoop 2 uber 2.7.5-10.0 源码下载

hive-jdbc-uber-jar 下载

怎么解决Job running in uber mode : false？

gozero 输出的日志是堆在一起的怎么格式化输出

golang 链路追踪

会员权益专享

最新资源

Uber Go 语言编程规范中文版.pdf