首页 > 编程学习 > 这可能是最权威、最全面的Go语言编码风格规范了!

每种编程语言除了固定的语法之外,都会有属于自己的地道的(idiomatic)写法。其实,自然语言也不例外,你想,你用心想想是不是这样。

语言的设计者们希望开发人员都能编写统一风格的地道的代码,这样不仅代码可读性好,便于社区统一代码风格,而且针对惯用法的优化也可能会让地道的代码拥有更好的运行效率。语言团队也会不遗余力的通过各种方式(文档[2]、blog[3]、演讲[4]、书籍[5]、视频等)向开发者传授如何写出更地道、更高效、可读性更好的代码。

以Go语言为例,为了能让Gopher更好的了解如何写出高效、地道的Go代码,Go开源伊始就编写了《Effective Go》[6]和《Go FAQ》[7]两篇文档。前者负责介绍Go惯用法,后者则担负着将Go语言设计层面的问题以及解决思路与Gopher进行对齐的重任:

e80a5d2d44b87d50a2b146b24069ef39.png

同时,Go语言之父们以及Go团队核心成员们在早期十分活跃并不遗余力的向Go社区推广Go的惯用法,Go官方站点上积累的各个早期的blog文章[8]以及各个talk资料[9]也成为了gopher学习地道Go编码的重要参考:

128b8727657235f1d8fca72ea10409ab.png

这些资料为了全世界Gopher的Go编码风格建立了基线。大多数情况下只要遵循这些资料并借助gofmt工具的自动格式化就可以写出风格比较地道的Go代码了。

然而《Effective Go》更像是说明地道风格Go代码的总体原则,不能“面面俱到”的覆盖每个编码的细节,而大公司对内部代码的风格一致性有着严格的要求。这不仅是高质量的要求,也是内部高效协作的要求。于是在若干年后,一些较早接纳Go且成为Go重度用户的大厂和初创公司结合自己的工程实践纷纷推出了公司内使用的Go编码风格规范,这里就包含我们耳熟能详的Uber[10]、鹅厂[11]、sourcegraph[12]、CockroachDB[13]、gitlab[14] 等。这些Go代码风格指南也成为Go社区开发人员在代码风格规范性方面的重要参考

不过,这些公司推出的代码风格指南有一个共同特点,那就是规范性有余,但权威性和全面性不足。Go社区都期待这Go语言的发源地:Google公司的Go编码风格规范的推出。之前,Google已经在其style guide站点[15]上推出了其内部使用的很多主流编程语言的style guide,包括:C++[16]、Java[17]、C#[18]、JavaScript[19]、Python[20]、Shell[21]等。

25dbf9b3106840543ccc018b6b7078fc.png

在2022年11月份中旬,就在Go刚刚过完其第13个生日[22]而步入青少年成长阶段之际,Google内部的Go语言编码风格规范[23]终于出现在其style guide站点上了!

e89ec8dd026fe2b998744b494a70c50b.png

不过,在介绍Google Go style guide前,我们首先要知道有关google style guide的几点内容:

  • 这些guide的主要目的是Google内部自用,所有开发人员、代码审查人员、代码可读性导师必须要遵守并达成一致;

  • 所有语言的style guide都会随着语言的演进而持续更新优化;

  • 各个语言的style guide的结构布局与写作风格都不相同;

  • 这些style guide都不接受Google之外人员的pr。

如上图,Google内部的Go语言编码风格规范系列文档目前由四个部分组成,它们分别是概述、指南、决定和最佳实践。根据概述篇的内容我们可以大体知道每篇文档的功用。这一系列文档汇集了当前编写可读的且地道的(idiomatic)Go代码的最佳方法,其目的是使刚接触这门语言的开发者能够避免常见的错误,同时也为那些在Google内部审查Go代码的人提供统一的风格。

这些文档的重要性略有不同:

  • 指南篇[24](https://google.github.io/styleguide/go/guide)概述了Google的Go编码风格的基础。这份文件是权威性的,并被用作风格决定最佳实践两个文档中建议的基础。

  • 决定篇[25] (https://google.github.io/styleguide/go/decisions) 是一份内容更详细的文档,总结了关于特定风格点的决定,并在适当的地方讨论了决定背后的理由。这些决定可能偶尔会根据新的数据、新的语言特性、新的库或新出现的模式而改变。

  • 最佳实践篇[26](https://google.github.io/styleguide/go/best-practices)记录了一些随着时间的推移而发展起来的模式,这些模式可以解决常见的问题,且可读性好并足够健壮,可以满足对代码可维护性的要求。

初步阅读了一下,这系列文档份的确算是目前最权威、最全面的Go语言编码风格规范了!其中决定篇和最佳实践篇涵盖的内容非常全面,内容和例子也非常到位。只不过,这套规范由于刚刚推出,还有很多改善优化和标记todo的地方。并且,其中有些内容是与Google是强相关的,但这依然是一份值得每个gopher认真阅读的资料。

此外,整套文档中经常引用一个名为“Go tips”的文档,不过该文档尚未放出,但从行文中引用的go tips的章节标题来看,很值得期待!

本博客正在将这套文档翻译为中文供大家参考,目前概述篇[27]、指南篇[28]和决定篇[29]和最佳实践篇[30]均已经初步翻译完毕(机翻辅助)。待go tips文档发布后,这里也会将其译为中文。


“Gopher部落”知识星球[31]旨在打造一个精品Go学习和进阶社群!高品质首发Go技术文章,“三天”首发阅读权,每年两期Go语言发展现状分析,每天提前1小时阅读到新鲜的Gopher日报,网课、技术专栏、图书内容前瞻,六小时内必答保证等满足你关于Go语言生态的所有需求!2022年,Gopher部落全面改版,将持续分享Go语言与Go应用领域的知识、技巧与实践,并增加诸多互动形式。欢迎大家加入!

512966b63395f6cb3674f1dfc9cd996d.png

5ddc5de9e312d1885ddaf475dd617613.png

2a9b07167fdd789413a5649bc1c38824.png

cae7140c51420f76947873918b866023.jpeg

Gopher Daily(Gopher每日新闻)归档仓库 - https://github.com/bigwhite/gopherdaily

我的联系方式:

  • 微博(暂不可用):https://weibo.com/bigwhite20xx

  • 微博2:https://weibo.com/u/6484441286

  • 博客:tonybai.com

  • github: https://github.com/bigwhite

8b4b55c773d7b136847eb234e05874fc.png

商务合作方式:撰稿、出书、培训、在线课程、合伙创业、咨询、广告合作。

参考资料

[1] 

本文永久链接: https://tonybai.com/2022/11/26/intro-of-google-go-style

[2] 

文档: https://go.dev/doc

[3] 

blog: https://go.dev/blog

[4] 

演讲: https://go.dev/talks

[5] 

书籍: http://www.gopl.io

[6] 

《Effective Go》: https://go.dev/doc/effective_go

[7] 

《Go FAQ》: https://go.dev/doc/faq

[8] 

blog文章: https://go.dev/blog/all

[9] 

各个talk资料: https://go.dev/talks/

[10] 

Uber: https://tonybai.com/2019/10/12/uber-go-style-guide/

[11] 

鹅厂: https://github.com/Tencent/secguide

[12] 

sourcegraph: https://about.sourcegraph.com/handbook/engineering/go_style_guide

[13] 

CockroachDB: https://github.com/cockroachdb/cockroach/blob/master/docs/style.md

[14] 

gitlab: https://docs.gitlab.com/ee/development/go_guide/

[15] 

style guide站点: https://google.github.io/styleguide/

[16] 

C++: https://google.github.io/styleguide/cppguide.html

[17] 

Java: https://google.github.io/styleguide/javaguide.html

[18] 

C#: https://google.github.io/styleguide/csharp-style.html

[19] 

JavaScript: https://google.github.io/styleguide/jsguide.html

[20] 

Python: https://google.github.io/styleguide/pyguide.html

[21] 

Shell: https://google.github.io/styleguide/shellguide.html

[22] 

第13个生日: https://tonybai.com/2022/11/11/go-opensource-13-years

[23] 

Google内部的Go语言编码风格规范: https://google.github.io/styleguide/go/

[24] 

指南篇: https://tonybai.com/google-go-style/google-go-style-guide

[25] 

决定篇: https://tonybai.com/google-go-style/google-go-style-decisions

[26] 

最佳实践篇: https://tonybai.com/google-go-style/google-go-style-best-practices

[27] 

概述篇: https://tonybai.com/google-go-style

[28] 

指南篇: https://tonybai.com/google-go-style/google-go-style-guide

[29] 

决定篇: https://tonybai.com/google-go-style/google-go-style-decisions

[30] 

最佳实践篇: https://tonybai.com/google-go-style/google-go-style-best-practices

[31] 

“Gopher部落”知识星球: https://wx.zsxq.com/dweb2/index/group/51284458844544

Copyright © 2010-2022 dgrt.cn 版权所有 |关于我们| 联系方式