改善参数过多的方法

参数过多的方法，该如何改善？

问题

按照《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, "[email protected]", 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模式可以有效改善构造器参数参数过多带来的问题。

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