给 Go 库做者的建议

Golang Practice Advice

视频信息

Practical Advice for Go Library Authors by Jack Lindamood at GopherCon 2016

www.youtube.com/watch?v=5v2…

幻灯地址： go-talks.appspot.com/github.com/…

命名

包名是未来使用过程当中的一部分，因此避免重复包名和结构与函数。好比

var h client.Client → var h http.Client
复制代码

context.NewContext() => context.Background()
复制代码

Object Creation

golang 没有构造函数，所以建立对象通常有两种办法:

• 默认的0值
• 单独的构造函数，NewSomething()

推荐使用默认 0 值的构造方法

在默认0值的状况下，各个方法要处理好0值，好比有些东西发现是0值后，给入一个默认值。

New() 构造函数很灵活，能够作任何事情，所以对于代码阅读上不利，意味着隐藏了不少东西。

有些库使用私有 struct，公开接口的方法，authImpl struct and Auth interface，这是反模式，不推荐使用。

不推荐使用 Singleton，虽然标准库中大量使用了 Singleton 模式，可是 Jack 我的不喜欢这种模式。

使用高阶函数做为选项这种形式不推荐：NewSomething(WithThingA(), WithThingB())

日志

一些日志是直接打印到标准输出去，这是很是很差的设计，由于用户若是想关根本关不了。

建议

• 肯定一下做为库是否是真的须要打印日志，是否是应该把输出日志的工做交给调用方决定？
• 若是必定须要日志，那么使用回调函数方式
• 输出日志到一个 interface
• 不要假定传进来的就是标准库的 log ，有不少选择。
• 尊重 stdout 和 stderr
• 不要使用 singleton

interface vs struct

接受 interface ，但返回的是 struct

这点和 Java 不一样，Java 更倾向于全部东西都是经过 interface 操做。而 golang 不须要，golang 使用的是隐性interface。

何时 panic

最好都不 panic。若是非要 panic，可能最合适的地方是 init 的时候，由于刚一运行就能看到挂了，比较容易处理。但即便如此，也尽可能不要 panic。

检查 error

问：咱们是须要检查全部的 error 么？好比有些彷佛不大容易出错。 答：须要，特别是你说的这些不大容易出错的！！

咱们用 error 代替了 exception，因此不要忽略这个东西。

处理的办法

• 最好的办法是 Bubble up，也就是传回调用方
• 但有的时候（好比 goroutine) 不适合，那就：
  • 作日志
  • 或者增长某个计数器

何时应该返回错误比较合适？

• 当不知足约定
• 当须要的答案没法获得

容许启用库的调试能力

为测试而设计

• 为了方便本身测试
• 为了方便库用户测试

并发

channels

虽然 channel 是 golang 一个处理并发很好地东西，可是并不是全部场合都须要。好比标准库中就不多有在 API 中使用 channel 的。

• 将使用 channel 的位置向上层移动。
• 可使用回调函数。
• 不要混合使用 mutex 和 channel

何时发起 goroutine

• 有一些库的 New() 会发起他们的 goroutine，这是很差的。
• 标准库使用的是 Serve() 函数。以及对应的 Close() 函数
• 将 goroutine 向上层推

何时使用 context.Context

• 全部的阻塞、长时间的操做，都应该能够被 cancel
• 因为 context.Context 很容易存储东西，因此很容易被滥用。要尽力去避免使用 Context
• Singleton 和 context.Value() 是一样性质的东西，像全局变量同样，对于程序状态来讲是个黑箱。

其它注意事项

• 若是什么东西很难作，嗯，那就让别人去作吧
• 为了效率而升级
  • 可是，正确性要比效率重要，在正确性的前提下，注意效率
• 不要在库中使用 /vendor （在 main 包中能够）
• 注意 build tag
• 保持干净
  • 尽可能使用全部的静态分析工具来检查代码。

原文

blog.lab99.org/post/golang…

博主

我的微信公众号：

我的github：

github.com/jiankunking

我的博客：

jiankunking.com