改善参数过多的方法

参数过多的方法,该如何改善?


问题

按照《Clean Code》中的标准,方法参数超过3个就已经是“过多”了。
参数多带来的问题:

  • 首先是调用的地方难以理解,特别是多个参数是同一类型的时候。不仅调用时要小心对应每个参数的位置。在方法参数数目变动时,更有造成bug的隐患。
  • 过多的参数也体现出方法责任过多,可能缺乏内聚的问题。

这个问题可以用简单的重构入手进行改进。

示例代码

下面示例的重构代码来源于
https://github.com/xpmatteo/birthday-greetings-kata

public void sendGreetings(String fileName, XDate xDate, String smtpHost, int smtpPort) throws IOException, ParseException, AddressException, MessagingException {
        ...
        if (employee.isBirthday(xDate)) {
            String recipient = employee.getEmail();
            String body = "Happy Birthday, dear %NAME%".replace("%NAME%", employee.getFirstName());
            String subject = "Happy Birthday!";
            sendMessage(smtpHost, smtpPort, "sender@here.com", subject, body, recipient);
        }
    }
}

private void sendMessage(String smtpHost, int smtpPort, String sender, String subject, String body, String recipient) throws AddressException, MessagingException {
    // Create a mail session
    java.util.Properties props = new java.util.Properties();
    props.put("mail.smtp.host", smtpHost);
    props.put("mail.smtp.port", "" + smtpPort);
    Session session = Session.getInstance(props, null);

    // Construct the message
    Message msg = new MimeMessage(session);
    msg.setFrom(new InternetAddress(sender));
    msg.setRecipient(Message.RecipientType.TO, new InternetAddress(recipient));
    msg.setSubject(subject);
    msg.setText(body);

    // Send the message
    Transport.send(msg);
}

参数对象 (Parameter Object)

使用抽取参数对象的方式,可以把多个有关联的参数组成一个对象来传递。
往往在采用了这个重构后,会浮现出原本代码中缺失的业务概念。
这个重构也是消除“基本类型迷恋”坏味道的利器。
过程演示如下:

Parameter Object

用Builder代替构造器

从上面的演示可以发现,多个参数从调用方法的地方转移到了产生参数对象的地方。
采取用Builder代替构造器的重构方法,可以使代码的意图更为明确。

Builder

方法对象 (Method Object)

另一种思路是把使用过多参数的方法抽取成一个对象。
采用这种方法,参数会成为对象的属性。
演示如下:

Method Object & Builder

同样,也结合使用了Builder。

结论

  • 参数对象可以把多个原始类型的参数合并为一个有业务意义的对象。
  • 方法对象可以把较为复杂的操作独立为单独的对象。原本的参数变为对象的状态。
  • Builder模式可以有效改善构造器参数参数过多带来的问题。

当然,以上仅仅是进行改进的开始。实际中往往会发现并非所有的参数都应该属于同一对象。也可能被重构的方法本身需要拆分成不同的部分。需要结合其它方法进行更深入的重构。

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

推荐阅读更多精彩内容

  • 刚看完Love Roise,突然有感而发。 哈哈哈只是看的有点,好吧不是有点,是很糟心,终于有了想写东西的冲动。寒...
    心血来潮的Sara阅读 147评论 0 2
  • 从11月份订阅《通往财富自由之路》《5分钟商学院》,开始背《道德经》《素书》《心经》《孙子兵法》,并坚持每天写文章...
    wml专注一点阅读 284评论 0 1
  • 欣欣跟我说,她和她最要好的闺蜜吵架了,原因是欣欣委婉地拒绝了闺蜜介绍给她的男生,可是闺蜜却在饭桌上漫不经心地说: ...
    L姐的故事阅读 499评论 1 2
  • 07店任务制定400件,完成141件还差259件 按13天完成评价每天20件件,周一到周五制定20件周六日制定25...
    首席搭配师唐唐阅读 100评论 0 0
  • 你好,大学。 今天是2018年3月11日星期日,扳着手指头数数,我来这儿已经148天了,离高考毕业已经过了半年多...
    断离愁阅读 237评论 0 0