go开发规范.pdf资源-CSDN文库

需积分: 22 155 浏览量 2019-10-24 17:27:52 上传评论收藏 633KB PDF 举报

资源详情

资源评论

 
Uber Go  语言编码规范 
Uber 是一家美国硅谷的科技公司，也是  Go  语言的早期  adopter。其开源了很多  golang  项目，诸如被  Gopher  圈熟知的 zap、jaeger 等。
2018  年年末  Uber  将内部的 Go  风格规范 开源到  GitHub，经过一年的积累和更新，该规范已经初具规模，并受到广大  Gopher  的关注。本
文是该规范的中文版本。本版本会根据原版实时更新。 
目录 
Uber Go  语言编码规范 ................................................................................................................................................................................................... 1 
目录 ................................................................................................................................................................................................................................. 1 
版本 ................................................................................................................................................................................................................................. 2 
介绍 ................................................................................................................................................................................................................................. 2 
指导原则 ......................................................................................................................................................................................................................... 2 
指向  interface  的指针 ............................................................................................................................................................................................ 2 
接收器  (receiver)  与接口 ....................................................................................................................................................................................... 2 
零值  Mutex  是有效的 ............................................................................................................................................................................................. 3 
在边界处拷贝  Slices  和  Maps .............................................................................................................................................................................. 4 
使用  defer  释放资源 ............................................................................................................................................................................................... 5 
Channel  的  size  要么是  1，要么是无缓冲的 ..................................................................................................................................................... 5 
枚举从  1  开始 ........................................................................................................................................................................................................... 5 
错误类型 ..................................................................................................................................................................................................................... 6 
错误包装  (Error Wrapping) ................................................................................................................................................................................... 7 
处理类型断言失败 ..................................................................................................................................................................................................... 7 
不要  panic ................................................................................................................................................................................................................. 8 
使用  go.uber.org/atomic ...................................................................................................................................................................................... 8 
性能 ................................................................................................................................................................................................................................. 9 
优先使用  strconv  而不是  fmt .............................................................................................................................................................................. 9 
避免字符串到字节的转换 ......................................................................................................................................................................................... 9 
尽量初始化时指定  Map  容量................................................................................................................................................................................. 9 
规范 ................................................................................................................................................................................................................................. 9 
一致性 ......................................................................................................................................................................................................................... 9 
相似的声明放在一组 ............................................................................................................................................................................................... 10 
import  分组 ............................................................................................................................................................................................................ 11 
包名 ........................................................................................................................................................................................................................... 11 
函数名 ....................................................................................................................................................................................................................... 11 
导入别名 ................................................................................................................................................................................................................... 11 
函数分组与顺序 ....................................................................................................................................................................................................... 12 
减少嵌套 ................................................................................................................................................................................................................... 12 
不必要的  else .......................................................................................................................................................................................................... 12 
顶层变量声明 ........................................................................................................................................................................................................... 13 
对于未导出的顶层常量和变量，使用_作为前缀 ................................................................................................................................................. 13 
结构体中的嵌入 ....................................................................................................................................................................................................... 13 
使用字段名初始化结构体 ....................................................................................................................................................................................... 14 
本地变量声明 ........................................................................................................................................................................................................... 14 
nil  是一个有效的  slice .......................................................................................................................................................................................... 14 
小变量作用域 ........................................................................................................................................................................................................... 15 
避免参数语义不明确(Avoid Naked Parameters) ............................................................................................................................................. 15 
使用原始字符串字面值，避免转义 ....................................................................................................................................................................... 16 

 
初始化  Struct  引用 ................................................................................................................................................................................................ 16 
初始化  Maps ........................................................................................................................................................................................................... 16 
字符串  string format ............................................................................................................................................................................................ 16 
命名  Printf  样式的函数 ........................................................................................................................................................................................ 17 
编程模式 ....................................................................................................................................................................................................................... 17 
表驱动测试 ............................................................................................................................................................................................................... 17 
功能选项 ................................................................................................................................................................................................................... 18 
 
版本 
  当前更新版本：2019-10-24  版本地址：https://github.com/uber-go/guide commit:#55~#61 
  如果您发现任何更新、问题或改进，请随时  fork  和  PR 
  Please feel free to fork and PR if you find any updates, issues or improvement. 
介绍 
样式  (style)  是支配我们代码的惯例。术语样式有点用词不当，因为这些约定涵盖的范围不限于由  gofmt  替我们处理的源文件格式。 
本指南的目的是通过详细描述在  Uber  编写  Go  代码的注意事项来管理这种复杂性。这些规则的存在是为了使代码库易于管理，同时仍然允许
工程师更有效地使用  Go  语言功能。 
该指南最初由 Prashant Varanasi 和 Simon Newton 编写，目的是使一些同事能快速使用  Go。多年来，该指南已根据其他人的反馈进行了修
改。 
本文档记录了我们在  Uber  遵循的  Go  代码中的惯用约定。其中许多是  Go  的通用准则，而其他扩展准则依赖于下面外部的指南： 
1.  Effective Go 
2.  The Go common mistakes guide 
所有代码都应该通过 golint 和 go vet 的检查并无错误。我们建议您将编辑器设置为： 
  保存时运行 goimports 
  运行 golint 和 go vet 检查错误 
您可以在以下  Go  编辑器工具支持页面中找到更为详细的信息： https://github.com/golang/go/wiki/IDEsAndTextEditorPlugins 
指导原则 
指向  interface  的指针 
您几乎不需要指向接口类型的指针。您应该将接口作为值进行传递，在这样的传递过程中，实质上传递的底层数据仍然可以是指针。 
接口实质上在底层用两个字段表示： 
1.  一个指向某些特定类型信息的指针。您可以将其视为"type"。 
2.  数据指针。如果存储的数据是指针，则直接存储。如果存储的数据是一个值，则存储指向该值的指针。 
如果希望接口方法修改基础数据，则必须使用指针传递。 
接收器  (receiver)  与接口 
使用值接收器的方法既可以通过值调用，也可以通过指针调用。 
例如， 
type S struct { 
  data string 
} 
 

剩余18页未读，继续阅读

评论收藏

内容反馈

go开发规范.pdf

评论0

最新资源

go开发规范.pdf

评论0

最新资源

相关推荐

go语言中文教程及手册.pdf

Go编程语言规范

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

Go语言开发手册

最新go语言中文教程及手册（强烈推荐）

Golang api 最新官方中文手册

详解Golang 推荐的命名规范

go开发教程.pdf

Uber+Go+语言编程规范.pdf

Go入门指南.pdf

go语言实战-高清版

Go 学习笔记 第四版.pdf

数据掘金--银行大数据应用探索.pdf

Google C++ Style Guide(Google C++编程规范）高清PDF

问答系统的系统设计方案.pdf

Go语言实战-GO IN Action

java面试题及技巧3

java面试题以及技巧

java面试题目与技巧1

java面试题及技巧4

java面试题以及技巧6

goarabic:一个Go Lang软件包，用于处理阿拉伯文本

2022年最新。Python教程-100天从新手到大师

USB技术及应用设计

Qt 5实现串口调试助手 （源工程文件、0积分下载）

【SystemVerilog】路科验证V2学习笔记（全600页）.pdf

AutoSAR标准协议4.2.2

光伏-储能并网系统仿真.rar

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

Go 学习笔记第四版.pdf

Qt 5实现串口调试助手（源工程文件、0积分下载）