译文:对匈牙利命名法说不 —— Jake Wharton


译者:

本文来自 Android 大神 Jake Wharton,他是 ButerKnife 和 RxBinding 的开发者,
OkHttp,RxJava,Retrofit 等流行的 Android 开发库的重要贡献者,对安卓编程风格的演进具有不可磨灭的影响


每一天都会有为安卓应用和库编写的java代码携带着一种传染病诞生,这种传染病的名字就叫做匈牙利命名法。
匈牙利命名法在安卓领域的推广纯粹是个意外,然而它依然受到错误的辩护。让我们先来推垮几个常见的主张:


  • “《安卓 java 代码风格指南》推荐使用匈牙利命名法”

根本就不存在所谓指导程序员如何编写java代码的《安卓java代码风格指南》,绝大部分人口中子虚乌有的编码风格指南来自于 《面向贡献者的 AOSP 代码样式指南》

你可不是在为AOSP项目编写代码,因此你并不需要遵循他们的指南。

即便你正在编写未来可能纳入AOSP的代码,你也不需要遵循这份指南,
几乎所有AOSP所导入的java库都没有遵循它,甚至AOSP项目中的一部分开发人员都没有这么做


  • “Android 样例使用匈牙利命名法”

一些样例诞生于AOSP项目的开发平台所以它们奉行AOSP的风格。而那些不来自AOSP的样例,它们的作者要么错误地相信了别的主张,要么只是单纯地忘了纠正编写这些样例时所使用的风格


  • “那些额外的信息为 code review 提供了帮助”

使用变量名前缀m和s分别可以声明变量是private/package的非静态成员或静态成员①,不然进行code review时将无法得知这些信息。这种方式能够推断那些代码改动②中不可见的变量。从而,不管怎样,一个变量的可见性都可以被显而易见地得知。

在我反驳这种观点之前,我们先来定义一下匈牙利命名法。根据维基百科,匈牙利命名法有两种:

    1. 系统命名法将变量的数据类型加入到变量名当中。
      一个long类型的用户id在java中将被一个名为lUser的变量代表,以此来表示它的用途和数据类型
    1. 应用命名法将变量在语义上的用途而不是逻辑上的用途或目的加入到变量名中。
      保存私有信息的变量带有某种前缀(如mUserId)而保存公有信息的变量则有另一种前缀,或者压根没有前缀

那么当你看见一个成员变量被使用时,究竟哪一种信息对code review来说更重要,是它的可见性还是数据类型?

可见性在code review当中是一种无需关注的属性。成员变量已经出现并且能够被使用,而且它的可见性大概也已经在上一个改动中被审阅过了
然而,成员变量的类型对于其在代码改动中如何被使用有更加直接的影响。被正确调用的方法名,参数的位置,可以被调用的方法,这些全都与变量的类型直接相关。

因此提出应用匈牙利命名法是错误的不单只是因为它没有用处,还因为系统匈牙利命名法能提供更多有关的信息。这可不是在说你应该使用系统匈牙利命名法,数据类型和可见性时常改动,而你将会忘记修改它们的名字。毕竟并不难发现静态的mContext成员变量


  • “额外的信息有助于开发”

Android Studio和IntelliJ IDEA会根据成员身份(静态或非静态)在视觉上区分非成员变量

IDE默认强制使用正确的可见性和数据类型,所以一个命名规定不会带来任何东西。简单敲击键盘,就会有弹窗显示变量的那三种(以及更多)属性。


  • “我想像谷歌官方一样编写java代码”

尽管安卓和AOSP都是该公司的一部分,谷歌在他们的编码风格指南中积极明确地禁止了匈牙利命名法的使用。公开的java风格指南是AOSP经年累月的内部习惯固化的产物。

安卓起源于谷歌之外,AOSP团队早已染上了匈牙利命名的顽疾。现在对其进行修改将是一种无用的扰乱并且会给分支和第三方合作者带来冲突。

但你对下面这个观点的持续支持与实践能够让我们在人生中根除这种疾病

朋友就不该再让朋友使用匈牙利命名法③


— Jake Wharton




译者注:

① field(成员): 根据oracle提供的文档,field这个词在未特指的情况下指的是非静态的成员变量,
    而在本文单纯指成员变量,没有额外的限定

② change(代码改动):在该文中应指git等svn中的提交差异

③ 该文中标题中的不以及结尾处的两个朋友原文中分别使用的是 mNo,mFriends,sFriends,
    这里直接舍弃了匈牙利命名法的前缀来翻译,至于作者使用这些前缀的意图,感兴趣的读者可以自行借助原文进行思考
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,504评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,434评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,089评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,378评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,472评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,506评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,519评论 3 413
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,292评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,738评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,022评论 2 329
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,194评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,873评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,536评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,162评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,413评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,075评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,080评论 2 352

推荐阅读更多精彩内容