如何格式化具有大参数列表的方法

Question

我从未见过一种很好地做到这一点的方法，我很想看看其他人是如何做到的。目前我的格式是这样的：

public Booking createVehicleBooking(Long officeId, 
                                    Long start, 
                                    Long end,
                                    String origin, 
                                    String destination, 
                                    String purpose,         
                                    String requirements, 
                                    Integer numberOfPassengers) throws ServiceException {
/*..Code..*/
}

Answer 1

public Booking createVehicleBooking(
    Long officeId, 
    Long start, 
    Long end,
    String origin, 
    String destination, 
    String purpose,                 
    String requirements, 
    Integer numberOfPassengers)

throws ServiceException {
/*..Code..*/
}

Answer 2

像这样的大量参数通常（但不总是）表明您可以使用对象来表示参数集。在以下情况下尤其如此：

• 有几种方法具有相似的大参数集，可以用带参数对象的单个方法替换。

• 方法调用create...

所以你上面的代码可能会变成（请原谅我的 C++，我是 Java 开发人员）：

class BuildVehicleBooking {
    Long officeId;
    Long start;
    Long end;
    String origin;
    String destination;
    String purpose;             
    String requirements;
    Integer numberOfPassengers;

    Booking createVehicleBooking () throws ServiceException { ... }
}

这是建造者模式。这种模式的优点是，您可以在最终调用create 方法之前，分段构建一组复杂的参数，包括参数之间如何相互关联的多种变体，甚至在新信息可用时覆盖参数结束。

另一个潜在的优势是您可以添加一个verifyParameters 方法，在您到达最终对象creating 之前检查它们的一致性。这适用于创建对象涉及不可逆步骤的情况，例如写入文件或数据库。

请注意，与所有模式一样，这并不适用于所有情况，也可能不适用于您的情况。如果您的代码足够简单，那么这种模式可能会过度设计它。如果代码变得杂乱无章，重构为这种模式可能是简化它的好方法。

Answer 3

我倾向于使用几个对象而不是一个对象。

这样就变成了

public Booking createVehicleBooking(Long officeId, DateRange dates, TripDetails trip)

虽然 DateRange 和 Trip 详细信息仅包含数据的相关部分。虽然可以说 dateRange 可能是行程的一部分，而 Requirements 和 Number of Passengers 可以从 TripDetails 中删除并成为请求的一部分。

事实上，有几种方法可以对数据进行切分，但我不得不说，将您的大列表分成相关参数组并为它们构建一个对象将允许更清晰的编程风格并增加可能的重用。

请记住，始终可以将对象嵌入对象中，从而让您拥有

public Booking createVehicleBooking(BookingParameters parameters)

而 BookingParameters 包含 TripDetails 和 DateRange 对象以及其他参数。

Answer 4

在调用端，我喜欢使用这样的 cmets 来模拟命名参数：

booking.createVehicleBooking(
    getOfficeId(),      // Long officeId 
    startVariable,      // Long start 
    42,                 // Long end
    getOrigin(),        // String origin 
    "destination",      // String destination 
    "purpose",          // String purpose       
    "requirements",     // String requirements
    3                   // Integer numberOfPassengers
);

Answer 5

我喜欢您展示的每行一个参数的方法。我发现很容易用肉眼扫描它并查看其中的内容。

我发现当人们使用像 Guice 这样的东西时，你通常会得到大量的参数，这使得它更容易阅读。

Answer 6

Google Java Style Guide 没有直接解决这个问题，但我同意他们在 Guava 中的格式化方式，即

在com.google.common.collect.Collections2.transform:

public static <F, T> Collection<T> transform(
    Collection<F> fromCollection, Function<? super F, T> function) {
  return new TransformedCollection<>(fromCollection, function);
}

在com.google.common.collect.ImmutableRangeMap.toImmutableRangeMap

public static <T, K extends Comparable<? super K>, V>
    Collector<T, ?, ImmutableRangeMap<K, V>> toImmutableRangeMap(
        Function<? super T, Range<K>> keyFunction,
        Function<? super T, ? extends V> valueFunction) {
  return CollectCollectors.toImmutableRangeMap(keyFunction, valueFunction);
}

我认为规则是：

• （如果可能，尽量保持一行）
• 在方法名和大括号后分开
• 将参数缩进一级以将它们与正文区分开来

就个人而言，如果我不得不中断，我更喜欢在每个参数之后中断，即

public static Foo makeFoo(
    Foo foo,
    Bar bar,
    Baz baz)
      throws FooException {
  f();
}