【笔记51】仔细设计方法签名

        谨慎地选择方法的名称。方法的名称应该始终遵循标准的命名习惯（见第56条）。首要目标应该是选择易于理解的，并且与同一个包中的其他名称风格一致的名称。第二个目标应该是选择与大众认可的名称（如果存在的话）相一致的名称。如果还有疑问，请参考Java类库的API。尽管Java类库的API中也有大量不一致的地方，考虑到这些Java类库的规模和范围，这是不可避免的，但它还是得到了相当程度的的认可。

        不要过于追求提供便利的方法。每个方法都应该尽其所能。方法太多会使类难以学习、使用、文档化、测试和维护。对于接口而言，这无疑是正确的，方法太多会使接口实现者和接口用户的工作变得复杂起来。对于类和接口所支持的每个动作，都提供一个功能齐全的方法。只有当一项操作被经常用到的时候，才考虑为它提供快捷方式。如果不能确定，还是不提供快捷方式为好。

        避免过长的参数列表。目标是四个参数，或者更少。大多数程序员都无法记住更长的参数列表。如果你编写的许多方法都超过了这个限制，你的API就不太便于使用，除非用户不停地参考它的文档。现代的IDE会有所帮助，但最好还是使用简短的参数列表。相同类型的长参数序列格外有害。API的用户不仅无法记住参数的顺序，而且，当他们不小心弄错了参数顺序时，他们的程序仍然可以编译和运行，只不过这些程序不会按照作者的意图进行工作。

        有三种方法可以缩短过长的参数列表。第一种是把方法分解成多个方法，每个方法只需要这些参数的一个子集。如果不小心，这样做会导致方法过多。但是通过提升它们的正交性，还是可以减少方法的数目。例如，考虑java.util.List接口。它并没有提供“在子列表中查找元素的第一个索引和最有一个索引”的方法，这两个方法都需要三个参数。相反，它提供了subList方法，这个方法带两个参数，并返回子列表的一个视图。这个方法可以与indexOf或者lastIndexOf方法结合起来，获得期待的功能，而这两个方法都分别只要一个参数。而且，subList方法也可以与其他任何“针对List实例进行操作”的方法结合起来，在子列表上执行任意的计算。这样得到的API就有很高的“功能-重量”（power-weight）比。

        缩短长参数列表的第二个方式是创建辅助类（helper class），用来保存参数的数组。这些辅助类一般为静态成员类（见第22条）。如果一个频繁出现的参数序列可以被看作是代表了某个独立的实体，则建议使用这些方法。例如，假设正在编写一个表示纸牌游戏的类，你会发现，经常要传递一个两参数的序列来表示纸牌的点数和花色。如果增加辅助类来表示一张纸牌，并且把每个参数序列都转换成这个辅助类的每个参数，那么这个纸牌游戏类的API以及它的内部表示都可以得到改进。

        结合了前两种特征的第三种方法是，从对象构建到方法调用都采用Builder模式（请见第2条）。如果方法带了多个参数，尤其是当他们中有些是可选的时候，最好定义一个对象来表示所有参数，并允许客户端在这个对象上进行多册“setter”调用，每次调用都设置一个参数，或者设置一个较小的相关集合。一旦设置了需要的参数，客户端就调用对象的“执行”（execute）方法，它对参数进行最终的有效性检查，并执行实际的计算。

        对于参数类型，要优先使用接口而不是类（请见52条）。只要有适当的接口可用来定义参数，就优先使用这个接口，而不是使用实现该接口的类。例如，没有理由在编写方法时使用HashMap类作为输入，相反，应当使用Map接口作为参数。这使你可以传入一个Hashtable、HashMap、TreeMap、TreeMap的子映射表（submap），或者任何待于将来编写的Map实现。如果使用的类而不是接口，则限制了客户端只能传入特定的实现，如果碰巧输入的数据是以其他的形式存在，就会导致不必要的、可能非常昂贵的拷贝操作。

        对于boolean参数，要优先使用两个元素的枚举类型。它使代码更易于阅读和编写，尤其当你在使用支持自动完成功能的IDE的时候。它也使以后更易于添加更多的选项。例如，你可能会有一个Thermometer类型，它带有一个静态工厂方法，而这个静态工厂方法的签名需要传入这个枚举的值：

public enum TemperatureScale{ FARENHEIT, CELSIUS}

Thermometer.newInstance（TemperatureScale.CELSIUS）不仅比Thermometer.newInstance（true）更有用，而且你还可以在未来的发行版本中将KELVIN添加到TemperatureScale中，无需非得给Thermometer添加新的静态工厂。你还可以将依赖于温度刻度单位的代码重构到枚举常量的方法中（见第30条）。例如，每个刻度单位都可以有一个方法，它带有一个double值，并将它规格化成摄氏度。