使用返回值是作为参数提供的对象的函数的返回是否是一种好习惯？ [关闭]

Question

我只是想问一下这是否是一个好的 java 实践，或者有更好的方法（官方方式）来做同样的事情。

首先，我需要更新一些hashmap信息：

Map<Date, Object> rows = new HashMap<Date, Object>();

这是 excel 行的对象，每个日期（即 10 月 1 日、10 月 2 日等）和包含该行信息的对象。

所以，为了获取这些信息，我有一些方法，例如：

rows = performQuery1(rows, foo, bar, initDate, endDate);
rows = performQuery2(rows, someDAO, foo);

还有……

private HashMap<Date, Object> performQuery1(rows, foo, bar, Date, Date) {
  // Some code that adds or removes elements from the hashmap "rows"
  rows.put(date1, o1);

  //Then return the same object
  return rows;
}

所以我的问题是：这是一个好的 Java 实践吗？

rows = performQuery1(rows, foo, bar, initDate, endDate);
rows = performQuery2(rows, someDAO, foo);

还是不行？

Answer 1

这个问题确实非常广泛，或者，关注“最佳实践”部分，可能基于意见 - 但不是主要基于意见，因为这样的模式有一个有效的论据。

通常您有一种方法可以在某处获取数据，并且应该将其放入目标数据结构（在您的情况下可能是集合或地图）。

这种方法的 签名 有几个选项（大致在您的示例中，但这种模式可以推广）。

第一个可能是

/**
 * Computes ... something, and returns the result as a map
 */
Map<Date, Result> execute(Date d0, Date d1) { ... }

第二个可能是

/**
 * Computes ... something, and places the results into the
 * given map
 */
void execute(Date d0, Date d1, Map<Date, Result> results)  { ... }

---

但是，为了获得最大的灵活性，我经常提到第三个选项（这是您实际询问的那个）：

/**
 * Computes ... something, and places the results into the
 * given map, which is then returned. If the given map is
 * null, then a new map will be created and returned.
 */
Map<Date, Result> execute(
    Date d0, Date d1, Map<Date, Result> results)  { ... }

这有几个优点：

• 您可以方便地让调用创建一个新地图：

  Map<Date, Result> results = execute(d0, d1, null);
  

• 您可以确定目标数据结构的实现。例如，如果您总是返回新地图，则无法在 HashMap 或 LinkedHashMap 之间进行选择。将目标数据结构传递给方法允许您调用

  Map<Date, Result> results = 
      execute(d0, d1, new HashMap<Date, Result>());
  

  或

  Map<Date, Result> results = 
      execute(d0, d1, new LinkedHashMap<Date, Result>());
  

  分别

• 您不必为每次通话都创建新地图。例如，您可以创建一系列调用

  Map<Date, Result> results = new HashMap<Date, Result>();
  execute(d0, d1, results);
  execute(d2, d3, results);
  

  在给定的地图中累积结果

---

考虑到它可以轻松地模拟这两种选择，这种方法的威力可能会变得更加明显：

class DB {

    // The private method that can emulate both public methods:
    private Map<Date, Result> executeImpl(
        Date d0, Date d1, Map<Date, Result> results);

    // The implementation that returns a new map
    public Map<Date, Result> execute(Date d0, Date d1) {
        return executeImpl(d0, d1, null);
    }

    // The implementation that fills a given map
    public void execute(Date d0, Date d1, Map<Date, Result> results) {
        executeImpl(d0, d1, results);
    }

}

---

顺便说一句：Java SDK 的某些地方也使用了类似的模式。比如在不同的应用案例中：BufferedImageOp#filter:

BufferedImage filter(BufferedImage src, BufferedImage dest)

... 如果目标图像为空，则创建具有适当 ColorModel 的 BufferedImage。

返回：过滤后的 BufferedImage

Answer 2

问题的核心归结为Is Java "pass-by-reference" or "pass-by-value"?

此外，您应该返回一个新创建的对象或修改由参数引用的对象，但不能同时返回。有一些有用的例外 像Method chaining，但这里似乎不是这样。

当您从方法返回数据时，程序员会期望数据是新创建的对象，而通过参数引用的对象保持不变。让方法返回 void（或成功代码）提示程序员该方法修改了参数引用的对象而不是返回新对象，并使您的代码更易于阅读。