2020年7月7日 Go生态洞察：保持模块兼容性

2020年7月7日 Go生态洞察：保持模块兼容性 🌱

摘要：🐆 猫头虎博主在此，携带Go生态的最新洞察！今天我们要深入挖掘如何在Go语言中保持模块的兼容性。作为技术探索的狂热者，我将带领大家一探究竟，了解如何在添加新功能时，保持现有代码的稳定性。跟随我，一起探索Go的奥秘吧！🐾

引言 📘

亲爱的读者们，这篇博客是Go模块系列的第5部分。

• 第1部分 — 使用Go模块
• 第2部分 — 迁移到Go模块
• 第3部分 — 发布Go模块
• 第4部分 — Go模块：v2及以后
• 第5部分 — 保持模块兼容性（本文）

我们将深入探讨如何在不破坏现有用户代码的前提下，对Go模块进行迭代和升级。

向函数添加内容 🛠️

对于函数参数的变更，我们提出了一种常见但不适用的技术：变参。例如：

func Run(name string, size ...int)

虽然这种方式看似兼容，实际上可能会导致类型不匹配的编译错误。

解决方案：不要修改现有函数签名，而是添加新函数。如context.Context的引入，database/sql包就通过添加新方法来适应：

func (db *DB) QueryContext(ctx context.Context, query string, args ...interface{}) (*Rows, error)

若未来函数可能需要更多参数，可以预先通过单一结构体参数进行设计，如crypto/tls.Dial的做法。

与接口协作 🖇️

当新功能要求修改公开接口时，可以通过定义新接口并在使用旧接口的地方进行类型检查来实现兼容性。例如archive/tar包的处理方式，通过在tar.Reader方法中检查io.Seeker，而不是直接修改io.Reader接口。

添加配置方法 🔧

对于可能改变行为的更新，应通过配置方法而非强制行为变更来实现。例如json.Decoder中添加的Decoder.DisallowUnknownFields方法。

维护结构体兼容性 🏗️

向导出的结构体添加字段通常是向后兼容的，但要确保新字段的零值具有意义。例如，net.ListenConfig的演变。

总结 📝

在设计API时，要考虑其对未来变化的扩展性。当需要添加新功能时，遵循“添加而不是更改或删除”的原则，除了接口、函数参数和返回值外，这些通常不能以向后兼容的方式添加。

本文被猫头虎的Go生态洞察专栏收录，详情点击 这里

参考资料 📚

• Jean de Klerk and Jonathan Amsterdam, “Keeping Your Modules Compatible”. 7 July 2020.
• Go官方博客和文档。

下一篇预告 🚀

下一篇博客将聚焦于“Go 1.15版本发布”，我们将探索这个版本的新特性和变化，敬请期待！