自创实现模式 ~ 以结果驱动代替条件驱动

所属文章系列:寻找尘封的银弹:自创实现模式


今天要写第一篇自创实现模式,也就是我自己独家创造的一个实现模式。

先解释一下什么是实现模式,这个词是Kent Beck《实现模式》的书名,意思就是在代码的最底层的模式,即类内部及函数内部的模式,而设计模式是多个类之间的模式。

说是独家创造,其实很可能早已有人提出来过,或者实践过,只是我不知道而已,就像设计模式的最初作者也并非是《设计模式》书中的四个作者一样,我只是一个模式的总结者而已。无论如何,对程序员有帮助,才是最重要的,也是我的初衷。

【动机】

先看一段看起来逻辑清晰,但有漏洞的代码:

void DoAdjust(ClassA **a, ClassB **b) {

    if ((*a) == NULL) {

        if ((*b)->next != NULL) {

            *a = *b;

            *b = (*b)->next;

        }

    }

}

注:代码中的双指针(**)只是为了在函数体内给外部的指针赋值,本质是输出参数,方式是解引用,即*a。

表面上看起来,这段代码逻辑清晰,但只是看似清晰而已,实际上编写这段代码的人并没有搞清楚这两个变量在所有执行路径到底该如何赋值。

这段代码漏掉了一种情况:当(*a) != NULL时,b也应该根据(*b)->next来决定取值,具体的取值应该有特定的业务逻辑。

当我根据需求编写了较为完备的测试用例之后,我才发现了这个Bug。经过分析,在这段代码中,确实应该有这种业务逻辑,但是这段代码却使用了默认的“不作为”行为,导致错误发生!

于是,我们加上了一些代码来补上这个漏洞:

void DoAdjust(ClassA **a, ClassB **b) {

    if ((*a) == NULL) {

        if ((*b)->next != NULL) {

            *a = *b;

            *b = (*b)->next;

        }

    } else {

        if ((*b)->next != NULL) {

            *b = (*b)->next;

        }

    }

}

漏洞是补上了,但再观察这段代码,总是感觉哪里不对,会不会还有漏洞?这是因为我们无法一眼看出问题,必须用白盒的方式枚举所有的情况。

由于这段代码比较简单,只有三个条件:*a、*b、(*b)->next,需要处理的情况数= 2(*a为空或非空) * 2(*b为空或非空) * 2((*b)->next为空或非空) = 8,所以枚举起来并不太难。

但是,当条件的数目猛增到10个时,它们的变化就会有2的10次方个,也就是1024个,那么枚举的方式就显得很傻,而且容易出错。不过,程序员总是想追求好方法,让自己在检查代码漏洞的时候可以更加“懒惰”一点。

有没有一种方法让这段代码看上去一目了然,一眼就能看出有没有漏洞?

【典型代码】

答案当然是有。用的方法是“以结果驱动代替条件驱动”。

先看修改后的代码,下一小节再给你解释:

void DoAdjust(ClassA **a, ClassB **b) {

   //为a赋值

    if ((*a) != NULL) {

        *a = *a;

    } else if ((*b)->next)

        *a = *b;

    } else {

        *a = NULL;

    }


   //为b赋值

    if ((*b)->next != NULL) {

        *b = *b->next;

    } else {

        *b = *b;

    }

}

【优劣对比】

使用该模式后的代码,看起来有点累赘,但你稍稍看仔细一点,就能完全懂得代码的所有意图和所有变化,做到了然于心。

为什么这样说?

这个函数要解决的根本问题是为*a和*b返回值,而使用该模式的代码恰恰是从这个为*a和*b赋值的角度出发的,我们一下子就能看出*a和*b是不是在退出的时候被赋过值了。这就是“以结果驱动代替条件驱动”这个实现模式中的“结果驱动”。

反观未使用该模式的代码,它是从条件的角度出发,条件包括*a、*b和(*b)->next,我们只看到了眼花缭乱的各种条件组合,却容易忽略掉最终要给每个返回变量赋值。这就是“以结果驱动代替条件驱动”这个实现模式中的“条件驱动”。

【思维进阶(一):单一路径思维、显式思维】

该模式体现出的是两种思维:单一路径思维和显式思维。

单一路径思维:函数必须确保在函数内为每个输出变量赋值的地方只有一处,而不依赖于函数内其他路径中的赋值代码。如“典型代码”小节中的代码:

   //为a赋值

    if ((*a) != NULL) {

        *a = *a;

    } else if ((*b)->next)

        *a = *b;

    } else {

        *a = NULL;

    }


显式思维:在这一处赋值的代码中,所有if/else路径都为那个输出变量赋值,而且必须包含else。代码示例也是如上这段代码。

“单一路径思维”中还提到了“依赖于函数内其他路径中的赋值”,这是反面教材,代码示例如下:

void DoAdjust(ClassA **a, ClassB **b) {

    if (flag == TRUE) {

       *a = NULL; //此处为“其他路径”

    }


    if ((*a) != NULL) {

        *a = *a;

    } else if ((*b)->next)

        *a = *b;

    } else

        *a = NULL;

    }

    ...

}

这种代码就会让人思维混乱,理不清头绪。

【思维进阶(二):多个条件的优先级】

这个模式会迫使你思考:

到底是在什么特定情况下,该给什么值。而不是遇到“条件1”先给赋一个值,再遇到“条件2”再给赋一个值,就像刚举的这个反面教材代码那样。当我们有本文这种模式的思维时,就会豁然开朗,一切逻辑都是那么清晰可见!

再看这种“营养不良”的代码产生的原因:一般是由于多个人先后修改代码产生的。后面修改代码的人不去看已有代码,他也不知道两个条件的优先级是什么,他只是加上自己的逻辑就以为万事大吉。这种情况在真实的产品代码里非常常见,它是一大类Bug的根源,却又藏得很深。

【结束语】

当我们了解了本文所讲的“以结果驱动代替条件驱动”这种实现模式后,即便不能按照这种模式修改“由堆积如山的条件”组成的产品代码,也能通过本文的思路找到Bug的根源,从而找到合适的解决方案。


作于2018-5-23


------------------------------

心定时刻:夫道不欲杂,杂则多,多则扰,扰则忧,忧而不救。

------------------------------

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

推荐阅读更多精彩内容

  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,605评论 18 399
  • Lua 5.1 参考手册 by Roberto Ierusalimschy, Luiz Henrique de F...
    苏黎九歌阅读 13,775评论 0 38
  • 第2章 基本语法 2.1 概述 基本句法和变量 语句 JavaScript程序的执行单位为行(line),也就是一...
    悟名先生阅读 4,138评论 0 13
  • ¥开启¥ 【iAPP实现进入界面执行逐一显】 〖2017-08-25 15:22:14〗 《//首先开一个线程,因...
    小菜c阅读 6,381评论 0 17
  • 电话不停在吵, 老板不停地闹。 总逃不开工作表, 做完了又来了怎样也甩不掉。 回家感觉真好, 别管世俗纷扰。 把一...
    贾小呆520阅读 476评论 0 0