Go 中的接口命名约定
问题:
Go 中接口命名的最佳实践,尤其是那些定义单个方法或一组相关的方法
答案:
-
单一方法接口: 对于具有单一方法的接口,约定是使用后缀像“-er”一样创建代理名词。示例包括“Reader”、“Writer”、“Closer”。
-
多方法接口:当接口有多个方法时,选择一个反映其预期用途的描述性名称。示例包括“net.Conn”、“http.ResponseWriter”、“io.ReadWriter”。
详细说明:
单一方法接口:
- “-er”后缀有助于为单一方法接口建立一致的命名模式。
- 此约定可以避免与具有相似含义的函数名称混淆。例如,不要将接口方法命名为“ToString”,除非它具有与“String”方法相同的签名和功能。
多方法接口:
- 当一个接口包含多个方法时,名称应清楚地描述其总体用途。
- 这确保开发人员可以无需阅读每个方法的文档即可轻松理解接口的功能。
方法中的接收器名称:
- 不要使用通用接收器像“this”或“self”这样的名称。
- 相反,请使用反映接收者的简短的、一个或两个字符的名称 类型。这有助于提高代码可读性和一致性。
其他资源:
- [有效的 Go:接口名称](https://go.dev /doc/ effective_go#interface_names)
- [接口类型@名称中包含什么? - golang.org 上的演讲](https://talks.golang.org/2011/names.slide)
- [接收者@名字中有什么? - golang.org 上的演讲](https://talks.golang.org/2011/names.slide#47)
- [Go 代码评审评论:接收者名称](https://github.com/ golang/go/wiki/CodeReviewComments#receiver-names)
以上是如何在 Go 中有效地命名接口,特别是当它们定义单个方法或一组相关方法时?的详细内容。更多信息请关注PHP中文网其他相关文章!