程序命名的原则与重构

命名是对事物本质的一种认知探索&＃xff0c;是给读者一份宝贵的承诺。糟糕的命名会像迷雾&＃xff0c;引领读者走进深渊&＃xff1b;而好的命名会像灯塔&＃xff0c;照亮读者前进的路。命名如此美妙&＃xff0c;本文将一步步揭开它的神秘面纱&＃xff01;

命名来源生活

从左到右&＃xff1a;正三角形&＃xff0c;正方形、正六边形  正表示边长相等&＃xff0c;从而得到正XXX的边长一定是相等的。

这些事物的特征比较明显&＃xff0c;容易被人们所记忆。但是也有一些比较难以命名&＃xff0c;比如化学有机物&＃xff1a;

相比于化学有机物&＃xff0c;软件世界的事物更加繁多&＃xff0c;命名将更加的困难。

Phil Karlton (菲儿·卡尔顿)曾说过&＃xff1a;在计算机科学中只有两件困难的事情&＃xff1a;缓存失效和命名规范。

命名一直是软件领域的难题&＃xff0c;好的命名能够信达雅&＃xff1a;

译事三难&＃xff1a;信、达、雅。——严复

信&＃xff1a;含义准确
达&＃xff1a;通顺流畅
雅&＃xff1a;简明优雅

命名的坏味道

查看下面代码&＃xff0c;说出其含义&＃xff1a;

public List getThen(){List list1 &＃61; new ArrayList();for &＃xff08;int[] x: theList&＃xff09;if (x[0] &＃61;&＃61; 4)list1.add(x);return list1;
}

问题不在于代码的简洁度&＃xff0c;而是在于代码的模糊度&＃xff1a;即上下文在代码中未被明确体现的程度。

1. theList  中是什么类型的东西&＃xff1f;

2. theList 零下表条目的意义是什么&＃xff1f;

1. 值4的意义是什么&＃xff1f;

2. 我如何使用返回的列表

问题的答案没体现在代码段中&＃xff0c;可那就是它们该在的地方。

再看看重命名后的代码&＃xff1a;

public List getFlaggedCells(){List flaggedCells &＃61; new ArrayList();for &＃xff08;int[] cell: gameBoard&＃xff09;if (cell[STATUS_VALUE] &＃61;&＃61; FLAGGED)flaggedCells.add(cell);return flaggedCells;
}

注意&＃xff0c;代码的简洁性并未触及。运算符和常量的数量全然保持不变&＃xff0c;嵌套数量也全然保持不变。但代码变得明确多了。

站在使用者的角度&＃xff0c;还可以更近一步吗&＃xff1f;

虽然getFlaggedCells一名表明方法会返回FlaggedCells&＃xff0c;但是返回的数据结构并未表达出来&＃xff1a;

public List getFlaggedCells(){List flaggedCells &＃61; new ArrayList();for &＃xff08;Cell cell: gameBoard&＃xff09;if (cell.isFlagged())flaggedCells.add(cell);return flaggedCells;
}

能否看出代码的两处差异点&＃xff1f;

稍微仔细点观察&＃xff0c;就会发现有两个点被改进&＃xff1a;

1. int[] -> Cell : 将数据进行建模&＃xff0c;赋予其含义

2. cell[STATUS_VALUE] &＃61;&＃61; FLAGGED  &＃61;&＃61;> cell.isFlagged()

• • 建模后可以竟然可以将这条语句语义化&＃xff0c;可读性增强了&＃xff1b;

  • STATUS_VALUE、FLAGGED 都被隐藏至Cell&＃xff0c;更加了内聚&＃xff1b;

只要简单改了以下名称&＃xff0c;就能轻易知道发生了什么&＃xff0c;这就是命名的力量。

命名的游戏

首先来做一个游戏&＃xff0c;游戏名为 “我们住在哪个房间&＃xff1f;”&＃xff0c;如下会为你提供一张图片&＃xff0c;请你说说看这是什么房间

从上面的图片不难看出&＃xff0c;这肯定是客厅。基于一件物品&＃xff0c;我们可以联想到一个房间的名称&＃xff0c;这很简单&＃xff0c;那么请看下图。

基于这张图片&＃xff0c;我们可以肯定的说&＃xff0c;这是厕所。通过上面两张图片&＃xff0c;不难发现&＃xff0c;房间的名称只是一个标签属性&＃xff0c;有了这个标签&＃xff0c;甚至我们不需要看它里面有什么东西。这样我们便可以建立第一个推论&＃xff1a;

▐  推论1&＃xff1a;容器&＃xff08;函数&＃xff09;的名称应包含其内部所有元素

如果有一张床&＃xff1f;那么它就是卧室。我们也可以反过来进行分析。

问题&＃xff1a;基于一个容器名称&＃xff0c;我们可以推断出它的组成部分。如果我们以卧室为例&＃xff0c;那么很有可能这个房间有一张床。这样我们便可以建立第二个推论&＃xff1a;

▐  推论2&＃xff1a;根据容器&＃xff08;函数&＃xff09;的名称推断其内部组成元素

现在我们有了两条推论&＃xff0c;据此我们试着看下面这张图片。

问题 3/3

好吧&＃xff0c;床和马桶在同一个房间&＃xff1f;根据我们的推论&＃xff0c;如上图片使我们很难立即做出判断&＃xff0c;如果依然使用上述两条推论来给它下定义的话&＃xff0c;那么我会称它为&＃xff1a;怪物的房间。

这个问题并不在于同一个房间的物品数量上&＃xff0c;而是完全不相关的物品被认作为具备同样的标签属性。在家中&＃xff0c;我们通常会把有关联的&＃xff0c;意图以及功能相近的东西放在一起&＃xff0c;以免混淆视听&＃xff0c;所以现在我们有了第三条推论&＃xff1a;

▐  推论3&＃xff1a;容器&＃xff08;函数&＃xff09;的明确度与其内部组件的密切程度成正比

这可能比较难理解&＃xff0c;所以我们用下面这一张图来做说明&＃xff1a;

如果容器内部元素属性关联性很强&＃xff0c;那么更容易找到一个用来说明它的名字&＃xff1b;反之&＃xff0c;元素之间的无关性越强&＃xff0c;越难以描述说明。

属性维度可能会关系到他们的功能、目的、战略&＃xff0c;类型等等。关于命名标准&＃xff0c;需要关联到元素自身属性才有实际意义。

在软件工程方面&＃xff0c;这个观点也同样适用。例如我们熟知的组件、类、函数方法、服务、应用。罗伯特·德拉奈曾说过&＃xff1a;“我们的理解能力很大程度与我们的认知相关联”&＃xff0c;那么在这种技术背景下&＃xff0c;我们的代码是否可以使阅读者以最简单的方式感知到业务需求以及相关诉求&＃xff1f;

命名的原则

▐  名副其实

命名应该描述其所做的所有事情(或者它的意图)。

当读者读到上文命名的坏味道里面讲的例子中getThen()&＃xff0c;并不能理解 getThen()的意图是什么&＃xff1f;是获取什么呢&＃xff1f;getFlaggedCells()就能比较准确地表达出来。

// 槽糕的命名
public List getThen();
// 好的命名
public List getFlaggedCells();// 槽糕的命名
private Date userCacheTime;
// 好的命名
private Date customerStayTotalTime;

▐  避免误导

避免留下掩藏代码本意的错误线索。

• 别用accountList来指称一组账号&＃xff0c;除非它真的时List类型。

List一词对于程序员来说有特殊含义。如果包纳账号的容器并非真实一个List, 就会引起错误的判断。所有建议用accountGroup 或 bunchOfAccounts, 甚至是 accounts都会好一些。

• 避免变量名使用小写字母l和大写字母O。

这样的拼写方式容易误导读者或者让读者花较大的力气去辨别。

▐  有意义的区分

如果同一作用范围内有多个命名&＃xff0c;最好让它们之间有区分度。

public static void copyChars(char a1[], char a2[]){for (int i &＃61; 0; i }

这里参数a1&＃xff0c;a2是依义进行命名的&＃xff0c;完全没有提供正确的信息&＃xff0c;没有提供导向作者意图的线索。

如何进行有意义的区分呢&＃xff1f;

如果参数改为source 和 destination&＃xff0c;这个函数的命名就更符合其用途。

public static void copyChars(char source[], char destination[]){for (int i &＃61; 0; i }

• 准确使用对仗词可以提高命名的区分度。

命名时遵守对仗词的命名规则有助于保持一致性&＃xff0c;从而也可以提高可读性。像first/last这样的对仗词就很容易理解&＃xff1b;而像FileOpen() 和 _lclose() 这样的组合则不对称&＃xff0c;容易使人迷惑。下面列出一些常见的对仗词组&＃xff1a;

• 尽量不要使用info/data为结尾去命名类名或变量名。

info和data的含义过于宽泛&＃xff0c;导致没有额外的信息量&＃xff0c;反而增加了读者的阅读成本&＃xff0c;得不偿失。

▐  风格一致

让同一个项目中的代码命名规则保持统一。

比如&＃xff1a;

1. 每个class的Logger取名为logger、log还是LOGGER&＃xff0c;取哪个名字均可&＃xff0c;但是需要保持项目统一

2. 类属性的getter/setter方法的命名统一。getName()还是name()均可&＃xff0c;但是需要保持项目统一

3. 注释的风格统一。

/*** 用户的姓名*/public Sring userName;/** 用户的姓名 **/

▐  抽象一致

 让同一作用域内的变量或方法具有相同的抽象。

public class Employee {...public String getName(){...}public String getAddress(){...}public String getWorkPhone(){...}public boolean isJobClassificaitionValid(JobClassification jobClass){...}public boolean isZipCodeValid(Address address){...}public boolean isPhoneNumberValid(PhoneNumber phoneNumber){...}public SqlQuery getQueryToCreateNewEmployee(){...}public SqlQuery getQueryToModifyEmployee(){...}public SqlQuery getQueryToRetrieveEmployee(){...}...}

查看这个类&＃xff0c;看看它有几个抽象层次&＃xff1f;

通过函数名可以查看&＃xff1a;

1. getName、getAddress、getWorkPhone 都是获取 Employee 的主要属性&＃xff0c;符合Employee的抽象

2. isJobClassificaitionValid 是 校验JobClassification 对象是否有效&＃xff0c;属于JobClassification的抽象层次&＃xff0c;与Employee 无关

3. isZipCodeValid是校验Address的合理性&＃xff0c;属于Address的抽象层次&＃xff0c;而Address是Employee 的属性&＃xff0c;不是一个抽象层次。isPhoneNumberValid 同理。

4. getQueryToCreateNewEmployee/getQueryToModifyEmployee/getQueryToRetrieveEmployee 看似与Employee 有关&＃xff0c;但是这里暴露SQL语句查询细节&＃xff0c;是实现细节&＃xff0c;层次比Employee要低。

多个不同层次的方法会让这个类看起来非常怪&＃xff0c;就像将晶体管、芯片零件、手机放在一个台面上一样。

public class Employee {...public String getName(){...}public String getAddress(){...}public String getWorkPhone(){...}public String createEmployee(...){...}public String updateEmployee(...){...}public String deleteEmployee(...){...}...}

▐  命名建模

如果在一个项目中&＃xff0c;发现有一段组装搜索条件的代码&＃xff0c;在几十个地方都有重复。这个搜索条件还比较复杂&＃xff0c;是以元数据的形式存在数据库中&＃xff0c;因此组装的过程是这样的&＃xff1a;

1. 首先&＃xff0c;我们要从缓存中把搜索条件列表取出来&＃xff1b;

2. 然后&＃xff0c;遍历这些条件&＃xff0c;将搜索的值填充进去&＃xff1b;

//取默认搜索条件
List defaultConditions &＃61; searchConditionCacheTunnel.getJsonQueryByLabelKey(labelKey);
for (String jsonQuery : defaultConditions) {jsonQuery &＃61; jsonQuery.replaceAll(SearchConstants.SEARCH_DEFAULT_PUBLICSEA_ENABLE_TIME,String.valueOf(System.currentTimeMillis() / 1000));jsonQueryList.add(jsonQuery);
}
//取主搜索框的搜索条件
if (StringUtils.isNotEmpty(cmd.getContent())) {List jsonValues &＃61; searchConditionCacheTunnel.getJsonQueryByLabelKey(SearchConstants.ICBU_SALES_MAIN_SEARCH);for (String value : jsonValues) {String content &＃61; StringUtil.transferQuotation(cmd.getContent());value &＃61; StringUtil.replaceAll(value, SearchConstants.SEARCH_DEFAULT_MAIN, content);jsonQueryList.add(value);}
}

简单的重构无外乎就是把这段代码提取出来&＃xff0c;放到一个Util类里面给大家复用。然而我认为这样的重构只是完成了工作的一半&＃xff0c;我们只是做了简单的归类&＃xff0c;并没有做抽象提炼。

简单分析&＃xff0c;不难发现&＃xff0c;此处我们是缺失了两个概念&＃xff1a;一个是用来表达搜索条件的类——SearchCondition&＃xff1b;另一个是用来组装搜索条件的类——SearchConditionAssembler。只有配合命名&＃xff0c;显性化的将这两个概念表达出来&＃xff0c;才是一个完整的重构。

重构后&＃xff0c;搜索条件的组装会变成一种非常简洁的形式&＃xff0c;几十处的复用只需要引用SearchConditionAssembler就好了。

public class SearchConditionAssembler {public static SearchCondition assemble(String labelKey) {String jsonSearchCondition &＃61; getJsonSearchConditionFromCache(labelKey);SearchCondition sc &＃61; assembleSearchCondition(jsonSearchCondition);return sc;}
}

由此可见&＃xff0c;提取重复代码只是我们重构工作的第一步。对重复代码进行概念抽象&＃xff0c;寻找有意义的命名才是我们工作的重点。

因此&＃xff0c;每一次遇到重复代码的时候&＃xff0c;你都应该感到兴奋&＃xff0c;想着&＃xff0c;这是一次锻炼抽象能力的绝佳机会&＃xff0c;当然&＃xff0c;测试代码除外。

▐  语境通用化

• 别抖机灵

如果你使用的命名来自一个比较冷门的语境&＃xff0c;比如俗语或者俚语&＃xff0c;不知道这个语境的人将很难理解它的含义。

如&＃xff1a;用whack来标识kill&＃xff0c;wsBank来标识网商银行

• 使用问题领域的名称

如果不能用程序员熟悉的术语命名&＃xff0c;就采用从所涉及问题领域而来的名称&＃xff0c;至少维护代码的程序员就能去请教领域专家了。这样至少问题域的专家能清晰理解开发者命名的语境&＃xff0c;读者可以询问领域专家或者查询领域词汇含义。

以消息中间件领域为例&＃xff1a;topic、、message、tag、offset、commitLog

改名

如果子程序名称、类名、变量 含糊不清或者名不副实时&＃xff0c;就需要对这个变量进行改名或者重构。

▐  改变函数声明

好的命名让读者一看看出函数的用途&＃xff0c;而不必查询实现代码。

• 动机

函数名&＃xff1a;

改进函数声明的小技巧&＃xff1a;先写一句注释描述这个函数的用途&＃xff0c;再把这句注释变成函数的名字。

函数的参数&＃xff1a;

函数的参数列表阐述了函数如何与外部世界共处&＃xff0c;是函数和函数使用者共同的依赖&＃xff0c;这其实也是一种耦合

1. 最小使用原则&＃xff1a;函数的参数列表正是函数所依赖的&＃xff0c;不会依赖没有用到的信息

• 例如&＃xff1a;一个函数的用途是把某人的电话号码转换成特定的格式&＃xff0c;并且这个函数的参数是一个人&＃xff0c;那么我就没法用这个函数来处理公司的电话号码。如果把函数接收的参数由“人”改成“电话号码”&＃xff0c;这段处理电话格式的代码就能被更广泛地使用。

根据函数的意图引入函数参数。

• • 如果这个函数的意图只是将电话号码转换成特定的格式&＃xff0c;那么只引入电话号码是合适的。

  • 如果这个函数的意图是得到“人”的电话号码格式并且他的号码是通过自身的其他属性合成&＃xff0c; 那么应该引入“人”。

关于如何选择正确的参数&＃xff0c;没有简单的规则可循&＃xff0c;需要视具体情况而定。

• 做法

常用的重构做法有两种&＃xff1a;简单式做法 和迁移式做法

简单式做法&＃xff1a;适用于一步到位地修改函数声明及其所有调用者。

1. 如果想要移除一个参数&＃xff0c;需要先确定函数体内没有使用该参数。

2. 修改函数声明&＃xff0c;使其成为你期望的状态。

3. 找出所有使用旧函数声明的地方&＃xff0c;将它们改为使用新的函数声明。

4. 测试。

最好能把大的修改拆成小的步骤&＃xff0c;所以如果你既想要修改函数名&＃xff0c;又想添加参数&＃xff0c;最好分成两部来做。比较幸运的是&＃xff0c;简单式做法一般可以用IDE工具直接重构完成。

实战&＃xff1a;下列函数的名字太过简略

public long circum(long radius){return 2 * Math.PI * radius;
}

将这个命名改得更加有意义一些&＃xff1a;

public long circumference(long radius){return 2 * Math.PI * radius;
}

迁移式做法&＃xff1a;函数被很多地方调用、修改不容易或者要修改的是一个多态函数或者对函数声明的修改比较复杂

1. 如果有必要的话&＃xff0c;先对函数体内部加以重构&＃xff0c;使后面的提炼步骤易于开展。

2. 使用提炼函数&＃xff08;106&＃xff09;将函数体提炼成一个新函数。

3. Tip如果你打算沿用旧函数的名字&＃xff0c;可以先给新函数起一个易于搜索的临时名字。

4. 如果提炼出的函数需要新增参数&＃xff0c;用前面的简单做法添加即可。

5. 测试。

6. 对旧函数使用内联函数&＃xff08;115&＃xff09;。

7. 如果新函数使用了临时的名字&＃xff0c;再次使用改变函数声明&＃xff08;124&＃xff09;将其改回原来的名字。

8. 测试。

实战&＃xff1a;还是刚才circum方法改名的例子

这个简略的函数名先不做修改。

public long circum(long radius){return 2 * Math.PI * radius;
}

再新增circumference函数&＃xff1a;

public long circumference(long radius){return 2 * Math.PI * radius;
}

逐渐小步地将circum 方法的调用处改成circumference方法&＃xff0c;每次修改都运行一下测试&＃xff1b;如果测试成功&＃xff0c;则提交此次修改进行一下修改&＃xff0c;否则返回至上一步重新进行修改。这样及时中间出错&＃xff0c;也能准确定位至某此修改&＃xff0c;稳定推进重构&＃xff0c;间接提高了重构的效率。

▐  变量改名

• 动机

好的变量命名可以额解释一段程序来干什么——如果变量名起得好的话。

• 机制

1. 如果变量被广泛使用&＃xff0c;考虑运用封装变量将其封装起来。

2. 找出所有使用该变量的代码&＃xff0c;逐一修改。

   如果在另一个代码库中使用了该变量&＃xff0c;这就是一个“已发布变量”&＃xff08;published variable&＃xff09;&＃xff0c;此时不能进行这个重构。

   如果变量值从不修改&＃xff0c;可以将其复制到一个新名字之下&＃xff0c;然后逐一修改使用代码&＃xff0c;每次修改后执行测试。

3. 测试

• 范例

如果要改名的变量只作用于一个函数&＃xff0c;对其改名是最简单的&＃xff0c;直接使用IDE进行重命名即可。

如果变量的作用于不至于单个函数&＃xff0c;重命名的风险就不太好把控&＃xff0c;这时需要对变量进行封装。

变量初始化

int treeName &＃61; "untitled";

变量被修改

treeName &＃61; "bigtree";

变更被读取

leftTree &＃61; treeName;

此时可以考虑采用封装变量进行完成

private int treeName;public void init(){treeName &＃61; "untitled";
}public String getTreeName(){return treeName;
}public void setTreeName(String treeName){this.treeName &＃61; treeName;
}

命名的过程

命名是一个迭代的过程。当你持续很长时间想不到比较好的命名时&＃xff0c;不要掉入取名的陷阱&＃xff0c;可以先用折中的命名commit掉或者重构这段程序。当你想到更合适的命名&＃xff0c;毫不犹豫地去重构它。

命名是一个接近描述事物本质的过程。命名得越好&＃xff0c;越容易接近描述事物的本质。

取好名字最难的地方在于需要良好的描述技巧和共有文化背景。

结语

好的命名是自解释的&＃xff0c;读者不用了解程序实现的细节&＃xff0c;就能知道程序实现的意图(契约式编程)。在项目实战中&＃xff0c;有时候很难给一段子程序取到一个比较好的名字&＃xff0c;这其实是程序在说话--让我干的事情太杂了&＃xff0c;导致不知道我是用来干啥的。一般这种情况下&＃xff0c;需要重构这段子程序&＃xff0c;对齐进行职责拆分&＃xff0c;分而治之。命名是门艺术&＃xff0c;美在它的简单&＃xff0c;美在它的明确&＃xff0c;美在它的名副其实。

加入我们

欢迎加入淘宝终端体验平台基础服务团队&＃xff0c;团队成员大牛云集&＃xff0c;有阿里移动中间件的创始人员、鹰眼全链路追踪平台核心成员、更有一群热爱技术&＃xff0c;期望用技术推动业务的小伙伴。

淘宝终端体验平台基础服务团队&＃xff0c;推进淘系&＃xff08;淘宝、天猫等&＃xff09;架构升级&＃xff0c;致力于为淘系、整个集团提供基础核心能力、产品与解决方案&＃xff1a;

1. 业务高可用的解决方案与核心能力&＃xff08;应用高可用&＃xff1a;为业务提供自适应的限流、隔离与熔断的柔性高可用解决方案&＃xff0c;站点高可用&＃xff1a;故障自愈、多机房与异地容灾与快速切流恢复&＃xff09;

2. 新一代的业务研发模式FaaS&＃xff08;一站式函数研发Gaia平台&＃xff09;

3. 下一代网络协议QUIC实现与落地

4. 移动中间件&＃xff08;API网关MTop、域名调度AMDC、消息/推送、文件上传AUS、移动配置推送Orange 等等&＃xff09;

期待一起参与加入淘系基础平台的建设~
简历投递至&＃x1f4ee;&＃xff1a;泽彬 zebin.xuzb&＃64;alibaba-inc.com &＃xff08;终端体验平台基础服务- 基础架构Leader&＃xff09;

参考文档

1. TwoHardThings&＃xff1a;

   https://martinfowler.com/bliki/TwoHardThings.html

2. Software Complexity: The Art of Naming&＃xff1a;

   https://medium.com/hackernoon/software-complexity-naming-6e02e7e6c8cb

3. 《代码大全》

4. 《代码整洁之道》

✿  拓展阅读

作者|玄苏

编辑|橙子君

出品|阿里巴巴新零售淘系技术