重构代码:如何避免写出过长的函数

大家刚开始编程的时候都会写几百行的函数,结果同事看得很头疼,最终不得不进行重构。

可是重构之前你必须深刻理解如何避免写出过长的代码,这样才能指导你以后的设计不再出现同样的问题。我归纳下来简单有2个原因:
1.做到事情太多,俗称职责太多。
2.层次复杂。

对于职责太多代码,就是拆分,这个其实还好理解。

比如一个用户注册的函数就包括了注册用户之外的太多功能,这里如果不隐藏代码细节的话,加起来代码肯定要超过100行了。

 function resisteUser(){
  //保存用户到数据库
  //更新用户标签
  //发送优惠券
  //发送通知
}

我们把每个单一的功能替换成一个函数,比如saveUserToDB就是把用户保存到数据库,这比注册用户能涵盖的职责要确定很多,同时把其他代码也封装成函数。

 function registeUser(){
  //保存用户到数据库
  saveUserToDB();
  //更新用户标签
  updateTag();
  //发送优惠券
  updateCoupon();
 //发送通知
  notify();
}

这样看,registeUser是一个入口函数,他通过调用不同函数实现了用户注册,标签,通知全部的功能,每个函数功能单一,可读性增强了。

但是代码层次复杂, 很多人不能很好的去理解。

下面看一个很多行的代码,这个复杂吗?

if(name="a"){
log.info("hello, mr a,are u ok" )
}
if(name="b"){
log.info("hello, mr b, you are so good" )
}
//也许需求会一直加满a-z。。
if(name="z"){
log.info("hello, mr z, i dont like u. #$^$#^" )
}

可能你觉得这个代码很low,加一个判断条件都必须加一个if判断。
但是你好好思考,假如修改点无非是加一个字母,然后打印这个字母特定的输出信息,就算有100个分支,就算是给一个工作半年的程序员,他写出bug的可能性也是很低,为什么?

原因就是这个函数的功能层次很单一,每个分支做的事情都是判断条件,然后输出内容。

举例,业务功能和实现细节写在一起就是跨层次。

随便臆造一个业务场景,保存订单要先查询历史订单和执行保存订单。
1.保存订单和执行保存订单到mysql,重试和事务处理。
2.查询数据和解析查询结果,反序列化JSON加处理字符编码等。

坏的例子就是一个函数混合了业务操作和具体细节

function saveOrder(){
 //查询历史订单
  queryHistoryOrder();
  var res =  executeSaveDb();
  if(!res){
     log,error("保存失败");
     res = executeSaveDb();
  if(!res){
     saveToCache();
    }
  }
}

主函数只有核心操作,保存订单细节放到另外函数

function saveOrder(){
 //查询历史订单
  queryHistoryOrder();
//保存订单
  save();
}

function save(){
 var res =  executeSaveDb();
  if(!res){
     log,error("保存失败");
     res = executeSaveDb();
  if(!res){
     saveToCache();
    }
  }
}

大家都听过一句话,代码是给人看的;
对阅读这来说,代码业务点是第一重要,好的结构一眼就能恰当好的展示全貌,具体细节则是需要再去了解。

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

推荐阅读更多精彩内容