代码整洁之道—函数

在编程的早期,系统由程序和子程序组成,后来,在Fortran和PL/1的年代,系统由程序,子程序和函数组成。如今,只有函数存活下来。

函数的规则

短小

函数的第一规则是要短小,第二规则还是要更短小。虽无法证实,但是经验告诉作者,函数就该短小。

if ,else,while语句,其中的代码块应该只有一行,该行应该是一个函数调用语句,这样不但能保持函数短小,而且块调用内的函数拥有较具说明性的名称,从而增加了文档的价值。

这也意味着函数不应该大到足以容纳嵌套结构,所以,函数的缩进层级不应该多于一层或两层。当然这样的函数易于理解。

只做一件事

新手写程序的时候,容易觉得函数只是用来重复利用代码块,只要有重复性的东西都提取的函数中,其实不仅仅这样。

函数应该做一件事,做好这件事,只做这一件事。

要判断函数是否不止做了一件事,还有一个方法,就是看能否再拆出一个函数。

每个函数一个抽象层级

要确保函数只做一件事,函数中的语句都要在同一个抽象层级上。函数中混杂不同的抽象层级,往往令人迷惑,读者可能无法判断某个表达式是基础概念还是细节。更恶劣的是,一旦细节与基础概念混杂,更多的细节就会在函数中纠结起来。

自顶向下读程序,每个函数后面跟着位于下一抽象层级的函数。

函数调用过程

看图,理解每个函数的逻辑层级关系。我们自己写的函数能理为如此清晰的思路就够了。

函数参数

最理想的参数量是零个,其实是一个,再次是二,应该尽量避免三个及以上的参数。

如果函数需要两个,三个,或三个以上的参数,就说明其中一些参数该封装为类了。

从测试的角度来看,要编写能确保参数的各种组合运行正常的测试用例,是多么的困难。如果没有参数,就很简单,只有一个参数,也不太困难,有两个参数,问题就麻烦多了。如果参数多于两个,测试覆盖的可能性值的组合令人生畏。

标识函数

最好不要像函数传入bool类型的值,这样做,方法签名立刻变得复杂起来,大声宣布函数不止做一件事,标识为true会这样做,标识为false会那样做。

滚动屏幕,看到render(Boolen isSuite),应该将函数一分为二: renderForSuite()和renderForSingleTest()

分隔指令与询问

函数要么做什么事,要么回答做什么事,但两者不可得兼。函数应该修改某对象的状态,或者返回改对象的有关信息,两样常干常会导致混乱。
含糊不清的语句:这是判断某个属性是否为为某个值,还是给属性设置某个值呢?

public boolen set(String attribute,String value)

修改方案,把指令分隔开来,防止混淆的发生

if (attributesExists("userName")){
  setAttribute("userName","aihe")
}

抽离try/catch代码块

try/catch会把程序弄的丑陋不堪,搞乱了代码结构,把错误与正常流程混为一谈。最好把tray和catch的主体部分抽离出来,另外形成函数。

//只处理错误,无需关心其它的
public void delete(Page page){
  try{
        deletePageAndAllReferences(page);
   }
   catch(Exception e ){
       logError(e)
   }
}

//只处理逻辑,无需关心错误
public void  deletePageAndAllReferences(Page page) throw Exception{
    ....
}

结构化编程

结构化编程规则:
每个函数,函数中的代码块都应该只有一个入口,一个出口。遵循这些规则,意味着每个函数中只该由一个return语句,循环中不能有break货continue语句。

结构化编程的目标和规范可以遵守,但偶尔出现的return语句没有多大坏处,但是尽量遵守规则。

书小结

每个系统都是使用某种领域特定语言搭建,而这种语言是程序员设计来描述那个系统的。函数是语言的动词,类是名词。
大师级程序员把系统当做故事来写,而不是当做程序来写。他们使用编程语言提供的工具构建一种更为丰富且更具有表达力的语言,用来讲那个故事。

最后

仔细品味开发的精髓,代码整洁之道,获益良多。

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

推荐阅读更多精彩内容

  • 序,前言 重视代码facebook把code review作为重点KPI考核,并采用连坐制。code wins a...
    高稷阅读 2,438评论 0 4
  • 目录及笔记链接 序 丹麦谚语:小处诚实非小事。 建筑师路德维希:神在细节之中。 日本的 5S 哲学: 整理(整理、...
    小镭Ra阅读 1,494评论 3 3
  • 海到无边天作岸,山登绝顶我为峰。作为猿类的我们,对自己创造的代码有着一种天生的无比自信。这是好事~可是,对于我们的...
    独钓寒江雪_520阅读 990评论 0 0
  • 我最近得病了,浑身无力,咳嗽不断,多说几句话都会上不来气,原来走路健步如飞,现在动辄头晕虚弱,到底是怎么了? 信赖...
    展颉阅读 425评论 2 1
  • 人到中年宜收敛 (汤剑平喜欢和推荐的美文) 一、沉淀朋友 “穷在大路无人问,富住深山有远亲”。在你生活的低潮和困境...
    汤剑平阅读 346评论 1 1