如何编写函数----《代码整洁之道》读书笔记

文中代码皆为不规范的伪代码

程序中曾经包含子程序和函数(可能我没有经历这种年代),如今,程序中仅有函数这种方式保留下来。

编程语言中的函数,分为内置函数和自定义函数或类方法。内置函数可以直接调用,而自定义函数是程序员编写的。

函数是程序的极其重要的组成部分,要写好,需要遵守一些原则。

函数要短小。函数中不应该容得下嵌套结构,如if...else等。在if..else、while、for或foreach等嵌套结构中,代码不应该超过一行,这唯一一行代码,是对函数的调用。请看代码A。

function test($bool){

$age = 0;

if($bool){

$age = 5;

}else{

$age = 0;

}

return  $age;

}

$bool = true;

echo test($bool);

上面这段代码,函数体中包含if...else,嵌套结构,根据”函数要短小“的原则,上面的代码应该改写为代码B:

function testTrue(){

$age = 5;

return $age;

}

function testFalse(){

$age = 0;

return $age;

}

$bool = true;

if($bool){

echo testTrue();

}else{

echo testFalse();

}

我喜欢用代码B风格的代码。它能简化主干代码(抽象层次高的代码)。实际编程中,我综合了代码A和代码B,因为我在代码B的基础上增加了一个函数test。请看代码C。

function testTrue(){

$age = 5;

return $age;

}

function testFalse(){

$age = 0;

return $age;

}

function test($bool){

$age = 0;

if($bool){

$age=testTrue();

}else{

$age=testFalse();

}

$bool = true;

echo test($bool);

三种风格的代码,孰优孰劣?我无法分辨。编程实践中,我选用C风格的代码。写短小的函数,原因是,短小的函数,易读,便于调试。当然,还受制于许多程序员编程实践中总结出的编程原则:一个函数只做一件事情。

《代码整洁之道》用这样的话强调这个编程原则:三十多年来,无数人用无数不同的表达方式传递出这样一个观点,一个函数应该只做一件事情;该函数应该做好这件事情;该函数应该做完这件事情。

掌握这项原则,必须弄明白:怎么叫一件事情?一件事情,是指这些事情都在同一个抽象层次上。举个例子,函数A把订单数据存到数据库,并在这个过程中创建券号、发送短信。表面上看,有三件事情,但由于它们都是同一个抽象层次上的事情,所以,实际上,只有一件事情。如果用创建券号中的代码来取代创建券号函数,函数A就是做了两件事情。

此外,“从上往下“读函数(to...do),也是区分函数是否做了一件事情的好方法。初级程序员要学会这一技巧,并不容易。

看函数的区段,即一个函数能否再分拆出其他的函数,也是识别函数是否只做一件事情的方法。

我觉得,根据”抽象层次“,就可以判断函数是否只做了一件事情。

函数要区分指令和询问。指令是指函数所做的事情,询问是指函数回答了了什么问题。一个函数,要么执行指令,要么回答询问,不可同时做这两件事,否则就违背了“一个函数应该只做好一件事”的原则。改变类属性的值是指令,获取并返回用户信息,是询问;把用户数据存储到数据库是指令,检测用户A是否存在是询问。代码D。

function isUserExists($userArray){

if $userArray exists{

return true;

}else{

save $userArray

return false;

}

}

上面的函数就把指令和询问混合在了一起。

函数要无副作用。具有副作用的函数,违背了“函数应该只做一件事”的原则,甚至还会违背“函数要区分指令和询问”的原则,比如上面的代码D。具有副作用的函数,是隐藏的谎言。请看代码D,函数名告诉读者,它做的事情是检测一个用户是否存在。实际上它还在函数内部“偷偷地”存储了用户数据。不深入函数去看,无法知道它的真正功能。具有副作用的函数,会带来一些预料之外的糟糕后果,要避免写出有副作用的函数。

函数的参数宜少不宜多。无参数最佳,一个参数还好,二个参数勉强还行,三个甚至更多参数,要想办法避免。参数代表不同概念,越多,使用函数的时候越麻烦。即使有注释,可能仍然需要看函数体或其他相关资料,记忆或弄清参数的顺序,也不容易。两个或两个以上的参数,测试函数的时候,这些参数会有多少个组合?需要多少测试用例才能完全覆盖测试?(这是《代码整洁之道》中的说法,我不理解)。代码E。

function getColumnValueById($id, column='*'){

$sql = 'SELECT ' . $column . ' FROM tableName WHERE id=' . $id;

$columnValue = execute($sql);

return $columnValue;

}

我可能会给这段代码写上注释

/**

*@author ggh

*@purpose 根据id从tableName中获取某个或几个字段的值

*@return $columnValue

*/

假设tableName具有username、password等字段,想通过getColumnValueById获取username的值,根据代码并不能知道只需将$column赋值为username就可以了,而是要根据注释找到tableName,然后看存储username的是哪个字段。将代码E改写为代码F。

function getUsernameById($id){

$column='username';

$sql = 'SELECT ' . $column . ' FROM tableName WHERE id=' . $id;

$columnValue = execute($sql);

return $columnValue;

}

想查询username的时候,直接调用getUsernameById就可以了,完全不需要去看tableName的字段。

若采用代码F风格,将产生大量的类似函数(重复代码)。目前,我是这么解决这个问题的。请看代码G。

function getColumnValueById($id, column='*'){

$sql = 'SELECT ' . $column . ' FROM tableName WHERE id=' . $id;

$columnValue = execute($sql);

return $columnValue;

}

function getUsernameById($id){

$column='username';

$username =getColumnValueById($id, column);

return $username;

}

function getPasswordById($id){

$column='password';

$pwd=getColumnValueById($id, column);

return $pwd;

}

上面的一个简单例子,应该可以展示少参数函数的好处。那么如何减少函数的参数呢?无参数输入,函数的内部代码如何运行?工作中,我使用的一个类方法A,参数有十几个,而且还在不断增加。《代码整洁之道》提供了一个方法:当一个函数需要的参数超过3个的时候,就应该创建类,把需要的参数声明为类属性。我那个函数可以用这种思路去减少参数,但会增加很多类属性、设置类属性值的方法。调用A的时候,需要调用同原来A的参数个数一样多的设置类属性值的方法。A的参数从形式上减少了,实质仍未发生变化,调用困难仍然存在。由于类方法A只在一处使用,新增参数,我只需在旧参数末尾加一个就可以。如果A被频繁调用,我每次都将不得不花一些事件询问或看注释这个参数应该赋什么值、那个参数应该赋什么值。

通过创建类来减少函数参数的方法,目前我没有看到它的优势。编程中,我使用PHP中的数组来减少函数的参数。代码H。

function insertUser($username, $pwd, $age, $level){

save user

}

使用数组

$userArray = array('username'=>$username,'pwd'=>$username, 'age'=>$age,'level'=>$level);

function insertUser($userArray){

$username = $userArray['username'];

$pwd= $userArray['pwd'];

$age= $userArray['age'];

$level= $userArray['level'];

}

将许多参数放在数组里,然后将数组作为一个参数,的确有效减少了参数个数,使函数看起来更美观。仅此而已,其他更多好处,有待发掘。

尽量避免使用输出参数,即在函数中输出一个变量。我编程中常使用输出参数。这样可以消除重复代码,能使代码更简洁。是否应该使用输出参数,需要进一步衡量利弊。

能写三篇《代码整洁之道》读书复述笔记,归功于前段时间看了几章内容。写完函数这些章节,若不抽时间看书,就无内容可写了。抛开《代码整洁之道》看来的知识,写作几乎成了无米之炊。可见工作以来,我掌握的知识、准确地说,透彻地掌握、能清楚地讲出来的知识,非常少。

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

推荐阅读更多精彩内容