写好方法的一点建议

这篇文章更加像是一个讨论。

参数

关于参数,首先要说的是参数个数。一般以一两个为佳,超过三个就不太好了。但是很多时候我们都未能完全避免写含有多个参数的方法。解决这种问题的一个技巧是,将这些参数封装成一个对象。不过,若是这个封装的对象没有明显的实际含义,那么还不如继续保持原有的悠长的参数列表,但是最多不要超过七个。
要避免输出参数。输出参数,最为典型的应用应该是Java的servlet。它们大概长这个样子:

    public void service(Request request, Response response){
        ...
    }

response就是一个明显的输出参数。真的要使用输出参数实际上也不会造成多大的问题,它只会造成一些阅读障碍(如果你在使用一个使用输出参数的接口的时候,就要小心一点了,因为你无法知道它究竟会怎样使用你的传入的参数,尤其是在多线程的环境下)。按照Java语言设计的初衷来说,返回值才真正代表输出。
如果你无法确保这个方法只有你自己会使用,或者你也不能确保将来自己使用这个方法的时候会传入正确的参数,那么对方法的参数进行校验。对此我们要秉持这样一种信念,就是使用这个方法的人是一个神经病,谁也不知道他会怎么使用,会使用什么参数。对于参数的校验,有两种常见的校验形式:

    public boolean validated(Parameter p){
        return p==null;
    }

    public void validated(Parameter p){
        if (p==null) {
            throw new IllegalArgumentException();
        }
    }

第二种大概要少见一点,它违背了一般的思维习惯,并且丧失了某种灵活性。而第一种还允许在参数检测不过关之后,做一些补救措施,比如使用默认值。但是,第二种有一种独特的优势,这种优势就是,如果你的确真的想在校验不通过之后抛出异常,那么使用第二种校验方式,你可以少些一点代码。推荐使用第一种而不使用第二种。
这里补充一点,除了参数需要校验以外,任何不受你控制的输入都需要经过校验。比如说读取文件,那么应该对文件内容进行校验。
总结成一句话就是,不要相信任何人,即便你自己也不能相信。

抽象

这里我要先讲一个笑话,将大象装进冰箱分成几步?三步,打开冰箱门,把大象塞进去,关门。这个笑话应该是对于抽象的最准确解释了。
抽象要求一个方法只做一件事。这似乎是一个很容易满足的要求,实则不然。比如说,异常处理究竟算不算是一件事?若是异常处理算是一件事,那么代码应该写成这样:

    public void doSomething(){
        try{

            realDoSomething();

        } catch (ExceptionType1 e){

        } catch (ExceptionType2 e){

        }//...
    }

这样看上去有点愚蠢,但是在异常情况很复杂而且对异常的处理很重要的情况下,会有比较好的效果。
除了这种情况外,还有一些情况也会让人疑惑。比如说,方法的分支。如果一个方法包括几个分支,那么这些分支应该单独出来算是一件事,还是它们组成一件事?这种判断依赖于上下文和调用者,在大多数情况下,应该考虑将分支单独出一个方法,而后如果还却是需要一个综合了分支的方法,那也应该用分支方法来组成。
这就造成了一个问题,该如何判断一个方法是否只做了一件事?
有一种说法是,判断一个方法是否只做了一件事,只需要看方法的名字是否概括了方法的全部效果。这种说法不失为一种合适的判断方法。
更加形式化的说法是,判断一个方法是否只做了一件事只需要看方法的语句是否都处在同一个抽象层级。就如同,打开冰箱,把大象塞进去,关上冰箱门,这三个是处在同一个抽象层级上,而打开冰箱,把大象头塞进去,把大象身体塞进去,关上冰箱门,它们就不是同一个层级。
这样说起来不太容易把握。那么可以考虑一种“反证”思维。这是我在尝试实践TDD的时候领悟的,它有点像是数学上的反证法。它的一般形式可以表达为:

  • 如果我要做到某事,我得先做到A,然后做到B...
  • 如果我要做到A,我要做A1,然后做A2...
  • 如果我要做到B,我要做B1,然后做B2...

这个在代码里面大概是这样的:

    public void doSomething(){
        doA();
        doB();
        doC();
        ...
    }

    private void doA(){
        doA1();
        doA2();
        ...
    }

    private void doB(){
        doB1();
        doB2();
        ...
    }
    ...

这种写代码的方式可以很好的与桩模块的思想结合起来,使细节被延迟到真正需要考虑的地方再实现。比如说,我们在实现doSomething的时候,可以假定doA, doB, doC...已经实现了。这样就屏蔽了很多细节,使我们真正关注在doSomething本身的逻辑上。在完成了doSomething之后,我们会继续往下写doA,而这个时候我们可以假定doA1, doA2已经实现了;写完doA之后,应该继续往下写doA1,而不是写doB,因为,显然从逻辑上doA1和doA在逻辑上联系要紧密。
这样一来,最终一个方法会被扩展成一棵树一般的结构。这就引发了我写方法的另外一个原则:只在叶子节点里面写简单操作。这个原则的极端情况就是,即便是拼接字符串,或者做个简单计算(可能仅仅是a+b*c),我也会把它写成一个方法。我推荐这种写法,尤其是在这种简单操作有明显的业务含义或者实际意义的时候,一个方法名字要比一堆的算式好理解。

异常

一个方法很重要的部分是异常处理。这里讨论的主要是在何时处理异常。
第一个原则是,公开的接口,或者暴露的方法,只抛出你已经声明了的,或者在javadoc里面指定了的异常。其余的异常应该在内部被处理掉了。这里所讲的处理,可能是将异常重新包装成声明的异常抛出,而要是在获得了足够的信息的情况下,也可以真正的处理掉;
第二个原则是,只有在知道异常该如何处理,那么就处理掉异常。这句话反过来就是说,如果不能有足够的信息处理异常,那么就继续抛出异常。这里面的关键点是,如何判断是否收集够了足够信息。通常来说,调用者肯定知道被调用方法的异常该如何处理,但是如果继续往上抛出异常,那么调用者的调用者就不得不关注更加多的细节了;私有方法异常会保留到公开调用者进行处理,因为公开调用者会有更加多的决策信息用以决定这个异常是否需要被处理掉。这两种建议是会冲突的,在这种情况下,应该按照词典顺序使用建议。这里还有一种比较常见的情况,即多个子方法抛出同一种异常,并且这些异常原因各不相同,业务又需要区别这些异常。这种情况下,是建议在子方法将异常处理掉的,否则,每一个子方法调用语句都被try...catch包起来显得真的太丑了;
第三个原则是,如果一个方法需要返回一个特殊值标记失败,那么就不要用这种返回值,而是改成直接抛出异常。这种返回一个标记失败的值,是延续了C里面的风格,那里并没有异常这种东西,但是Java自身提供了这种机制,一个异常在语义上要比任何值更加能够说清楚失败的含义。
第四个原则是,使用断言而不是异常来表达绝不会出现的情况。当然,如果断言失败了,那么还是会抛出异常……但是在语义上抛出异常代表的是你知道此处可能会出现失败,而断言抛出的异常则说明发生了你绝对没有意料到的情况。断言用在说明前置条件和后置条件下会比较有效果。

总结

写出一个好的方法是一件困难的事情。很多的时候下,要写出一个好的方法,只能依赖于不断的重构才能完成。程序员应该像一个艺术家一样,对于自己的代码精心打磨。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,579评论 18 139
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,846评论 6 13
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,365评论 25 707
  • 从昨天开始,自己整个人就开始恐慌,害怕,无助~感觉到深深的孤独,以前觉得自己孤独是好事,但是昨晚却感到深深的落寞,...
    花儿向着太阳阅读 214评论 0 1
  • 早就想写一篇关于炸酱面的小文了,微信号有一阵没有写东西了。今天突然间很想唠叨两句有的没的,或许是最近吃的太好了,看...
    卷卷米阅读 1,597评论 4 7