登录
首页 >  Golang >  Go问答

统一命名接收者

来源:stackoverflow

时间:2024-02-15 13:48:23 476浏览 收藏

亲爱的编程学习爱好者,如果你点开了这篇文章,说明你对《统一命名接收者》很感兴趣。本篇文章就来给大家详细解析一下,主要介绍一下,希望所有认真读完的童鞋们,都有实质性的提高。

问题内容

官方文档建议在所有地方使用相同的接收者名称。但遵守这一点真的有意义吗?

我的意思是,我想象像 func (first Foo) concat(second Foo) (combined Foo) 这样的东西更具表现力,而 first 仅在串联的上下文中才有意义。如果我们不走这条路,我们基本上就被迫求助于一些不可知但无用的接收器命名,例如 f,浪费了自我记录代码的机会。


正确答案


Go Wiki: Receiver Names:

方法接收者的名称应该反映其身份;通常,其类型的一两个字母缩写就足够了(例如“c”或“cl”代表“client”)。不要使用诸如“me”、“this”或“self”之类的通用名称,这些是面向对象语言的典型标识符,它们赋予该方法特殊的含义。在 go 中,方法的接收者只是另一个参数,因此应该相应地命名。该名称不必像方法参数那样具有描述性,因为它的作用是显而易见的并且没有任何文档用途。它可以非常短,因为它几乎会出现在该类型的每个方法的每一行上;熟悉承认简洁。 也要保持一致:如果您在一种方法中将接收者称为“c”,则不要在另一种方法中将其称为“cl”。

如果您只有一个方法,那可能并不重要。如果你的类型有很多(甚至可能有几十个方法),那么如果你全部使用相同的接收者名称,它确实会有所帮助。它更容易阅读和理解。

此外,如果您想要/必须将一些代码从一种方法复制到另一种方法(重构),如果接收者名称相同,您只需复制/粘贴即可完成,您不必开始编辑不同的名字。

还有 dave cheney:practical go:编写可维护的 go 程序的真实建议:

2.4. Use a consistent naming style

好名字的另一个属性是它应该是可预测的。读者第一次遇到名称时应该能够理解该名称的用法。当他们遇到常见名称时,他们应该能够假设自上次看到它以来它的含义没有改变。

例如,如果您的代码传递数据库句柄,请确保每次出现该参数时,它都具有相同的名称。而不是 d *sql.dbdbase *sql.dbdb *sql.dbdatabase *sql.db 的组合,而是合并类似的内容;

db *sql.DB

这样做可以提高熟悉度;如果您看到 db,您就知道它是 *sql.db 并且它已在本地声明或由调用者为您提供。

类似的建议适用于方法接收者;该类型的每个方法都使用相同的接收者名称。这使得读者更容易内化这种类型的方法中接收器的使用。

也是一个有趣的阅读:Neither self nor this: Receivers in Go

考虑到 1. 你有一个好的方法名称,2. 接收者类型从方法声明中很容易看出,大多数时候像 f 这样的短名称是很好。在您需要区分接收器和参数的情况下,建议您可以使用常规函数而不是方法,因为显然接收器没有从方法名称中得出的明显含义。

好了,本文到此结束,带大家了解了《统一命名接收者》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多Golang知识!

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>