《代码整洁之道》:5大基本要点

常常有小伙伴推荐罗伯特·C·马丁的《代码整洁之道(Clean Code)》。今天我们就来了解一下这本书,它值不值得一看?

关于此书

《代码整洁之道》出版于2008年,近年来,一直被列为“亚马逊最畅销的五本书”之一。本书作者被亲切地称为“Bob叔叔”,他也是《敏捷宣言》的原作者之一,资历非常丰富。本书在Goodreads上平均评分为4.4(评分人数超13,000)。可以说,这是一本程序员的必读书。

本文将本书精简为五个要点。

1. 尊重抽象

《代码整洁之道》中写到:如果要确保函数仅做一件事,则需要确保每个函数的语句都位于同一抽象层次。

为说明这一点,马丁用了以下示例(出自FitNesse):

public String render() throws Exception 


StringBufferhtml =new StringBuffer("<hr"); 

if (size>0) 

html.append("size="").append(size + 1).append("\""); 

html.append(">"); 

 return html.toString(); 

在GitHub上查看no_abstraction.java源代码

这里至少混合了两个抽象层次。第一个是固定大小的hr标签的高级概念,第二个是处理实际标签构造的低级语法细节。为了说明这一点,对代码进行更清晰地重构,如下所示:

public String render() throws Exception 

HtmlTaghr =new HtmlTag("hr"); 

if (extraDashes>0) 

    hr.addAttribute("size",  hrSize(extraDahses)); 

   return hr.html(); 

 } 

private String hrSize(int height) 

inthrSize = height +1; 

  return String.format("%d", hrSize); 

在GitHub上查看abstraction.java源代码

注意:

1.  Render()函数现在仅负责构建hr标签

2.  将构建标签的底层详细信息的任务转给HtmlTag模块

3.  大小格式被抽象为独立的函数

马丁认为:

“分离抽象层次是重构最重要的功能之一,也是最难实现的功能之一。”

当然,在以后的代码中,我会有更多考虑。

2. 整洁代码关乎规则,要花大量精力

我不希望本文仅是列出编写整洁代码的要点和规则。对本书而言这也无甚作用——因为采取教条式的教学方法是远远不够的。

相反,在本书中马丁呼吁发展强烈的个人原则感,且不断说明将“脏代码”变整洁所需的努力和职责。本书将其称为“代码感”,它要求“严格使用艰难获得整洁代码的大量小技巧。”

“整洁代码并非遵循一组规则编写的。不可能因为学习一套金规玉律就成为软件大师。专业精神和手工艺来自于推动规则形成的价值。” —罗伯特·C·马丁(RobertC. Martin)

就个人而言,我没什么自信,所以很喜欢这种说法。就连Bob叔叔都坚信编写代码是一份需要严肃自律的工作,要花费大量精力,真是极大的安慰。为了真正擅于整洁代码,我们需要迭代我们作为程序员的个人开发以及代码的开发。

3. 代码尽量精简

“函数的首要规则是体积小。第二规则是使其尽可能地变小。” ——罗伯特·C·马丁

这里有两个含义:

函数本身应该简短——几乎不超过20行,大多数情况下少于10行

函数应尽可能不要采用参数

简洁函数能增加代码的易读性。这也使我们倾向于编写功能单一高效的函数。

对于类,他也有类似的看法。他建议使用“职责”而非“代码行”来衡量类的大小。即一个类应该只有一个职责。这就是所谓的“单一职责原则”(SRP)。

保持代码简短是“分划”策略,如果一个大文件包含大量冗长而复杂的代码,则可以将该文件分为多个模块,将模块分为多个函数,再将函数分为多个子函数,直至看到代码逻辑和任务。

4. 编程是工艺

我时常认为,将编程喻为建筑和构造并不恰当。因为程序员不会做一个完整的设计,从头开始建基,再一步步搭建直至完工。

编程的步骤是:先画草图,再反复添加细节。程序员要做的是修改、完善和扩展——这些都在各抽象层次上完成,直到软件满足要求为止。而软件永远不会真正完成。

这就是《代码整洁之道》的中心思想。贯穿全书的要点是:软件是一门艺术,做软件就像“画画”。作者认为编程的本质是一门工艺。

但如何让编程从单纯地写代码变成“工艺”呢?

马丁认为,程序员掌握的主要工具是持续重构和测试驱动开发(TDD)。两者像硬币的两面般协同工作。来看一些概念:

重构是在不更改输出的情况下调整现有计算机代码结构的过程。

测试驱动开发是将需求转换为特定测试用例,再添加代码以使测试通过的过程。

因此,制作软件的过程可能如下所示:

1.  编写测试代码以验证所需但未实现的功能。

2.  编写有效代码(可能不整洁),并通过测试。

3.  逐步重构代码(保证每次通过测试),使代码在每次开发迭代中都更加清晰。

“不要想着一次性编程后系统就能正确、漂亮地运行。今日的任务仅仅是让程序运行起来,而重构和扩展系统是明天的任务。这是迭代和增量敏捷的本质。”            ——罗伯特·C·马丁

因此,本书的中心思想是,整洁代码是在开发和实践中实现的,而非简单地一口气创建出来。

5. 代码本身清晰易读

注释很少却清晰、表达力强的代码优于注释多的混乱、复杂的代码。” ——罗伯特·C·马丁

在“注释、有意义的命名和格式“一章中,马丁强烈主张代码本身应该清晰易读。示例:

// Check to see if theemployee is eligible for full benefits 

if ((employee.flags & HOURLY_FLAG) && 

(employee.age> 65)) 

将其重构为:

if(employee.isEligibleForFullBenefits()) 

注意:

删除注释

条件逻辑封装到一个方法中

因为使用的是方法而不是独立函数,因此可以使用实例变量,从而创建调用零参数的方法

给该方法起一个描述性的名称,使其职责更加明确

《代码整洁之道》关于命名写了整整一个章节,本质上是对Tim Ottinger规则的详细说明。包括:

1.  设置可读性高的名称——例如,int elapsedTimeInDays,而不是in days

2.  使用读得出来的名称——例如,客户而不是DtaRcrd102

3.  避免使用编码——不要用前缀m_表示"members",也不要使用匈牙利表示法

4.  每个概念对应一个词——不要fetch,retrieve,get多个概念对应一个词

每天都会有更新看过的朋友可以点波关注,Java学习路线和优质资源评论或后台回复“Java”获取。

结语

《代码整洁之道》中,并非每个想法都是Bob叔叔提出的,他在书中的各部分都承认了这一点。而这反而是使本书如此成功的一个原因——它是编程界智慧的汇聚,并附有实例。

如果要说一个小瑕疵,那就是与高层概念的章节相比,有关底层细节的章节有点少。“系统”章只有13页,仅仅是“注释“章的一半。但是,我怀疑减少对系统的重视,是为了将讨论保留在他后来的书《架构整洁之道(CleanArchitecture)》中。

综合考虑,这真的是目前最好的编程书籍之一,我会把该书放到我的2021年书单中。

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

推荐阅读更多精彩内容