当前位置:首页 > 文章列表 > Golang > Go问答 > 统一命名接收者

统一命名接收者

来源:stackoverflow 2024-02-15 13:48:23 0浏览 收藏

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

问题内容

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

我的意思是,我想象像 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删除
使用参数来执行测试代码的方法使用参数来执行测试代码的方法
上一篇
使用参数来执行测试代码的方法
Go函数中的go func为何需要waitgroup以确保正确退出?
下一篇
Go函数中的go func为何需要waitgroup以确保正确退出?
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    3193次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    3405次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    3436次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    4543次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    3814次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码