在 Java 方法中收集错误，空 ArrayList 与 LinkedList答案

【问题标题】：Collecting errors in a Java method, empty ArrayList vs. LinkedList在 Java 方法中收集错误，空 ArrayList 与 LinkedList
【发布时间】：2013-03-04 16:28:02
【问题描述】：

我好像偶尔会创建这两种方法：

// return null on errors, and append errors to 2nd param, otherwise return result
String fetchSomething(String parameter, List<String> errorMessagesOut);

// return empty list or null on no errors, otherwise list of errors
List<String> verifySomething(String parameter);

然后调用这些的代码将使用适当的分隔符（例如简单的逗号、换行符、HTML 标记...）加入错误列表，通常使用 Apache Commons Stringutils.join 方法。正常情况下不会出错，list为空。

所以，我开始思考这两个问题：

您是否发现将错误消息字符串作为列表返回时存在问题？如果是这样，有什么更好的选择？（不是异常，调用这些方法的代码会在需要时抛出异常。）
new LinkedList() 或 new ArrayList(0) 或 new ArrayList() 是否更适合预计保持为空的列表，并且当它不为空时通常应该只有顺序迭代器访问？

编辑：示例用例：

List<String> verifyParameters(JSONObject params) {
    List<String> ret = new ArrayList<String>(0);

    if (!verifyKey(params.get("key"))) 
        ret.add("Invalid key: " + key);

    if (!verifyAccess(params.get("user"), params.get("pass"))) 
        ret.add("Authentication error");

   return ret;
}

...

List<String> errors = verifyParameters(params);
if (!errors.isEmpty()) {

    connection.sendErrorListMessage(errors);
    logger.warn(StringUtils.join(errors, ", "));
    controlPanel.show("Errors: \n- " + StringUtils.join(errors, "\n- ") + '\n');
    throw new AbortException("invalid params); // or maybe return false/null;
}
// proceed with valid params

通常处理错误列表不会包含所有这些，它只是试图说明错误列表是供人类查看的消息列表，与它的显示方式无关，也与/无关有助于以不同方式处理不同的错误。

【问题讨论】：

保持简单，使用new ArrayList()。如果您稍后发现问题，请将其更改为 new ArrayList(0) 甚至是 new LinkedList()。微优化是万恶之源
@LuiggiMendoza - 我喜欢你能在五分钟内使用这句话两次 :) 很好
LinkedList 当然是合适的数据结构。返回一个列表而不是让一个参数被填充，更具可读性。
添加了简化示例，包括生成错误列表和使用错误消息。

标签： java list error-handling

【解决方案1】：

我认为对字符串使用列表很好。我倾向于至少为fetchSomthing 制作一个专用的Result 类并使其成为这样，特别是如果传递的errorMessagesOut 除了一个新的空列表之外什么都不是：

Result result = fetchSomething(String parameter);
if (result.hasErrors()) {
    List<String> errors = result.getErrors();
} else {
    String fetched = result.getValue();
}

然后我还会将处理错误字符串的任何方法也放在此类上，以便您可以执行以下操作：

String errorMessage = result.getErrorString();

这将错误数据及其格式封装在一个类中，这意味着在没有错误的情况下，您无需在 Result 实例内部创建任何列表。

我以上几点主要是关于代码设计的。在没有分析和基准来比较任何更改的结果的情况下尝试微优化是没有意义的。

【讨论】：

【解决方案2】：

这些错误是为了什么？您是否要根据方法返回的错误做出一些业务决策？否则，如果错误只是用于记录，一个简单的记录解决方案会建议在错误发生时立即记录。我说的是那些logger.debug("Error message");。

不管怎样，你能给我们举个例子，说明这些错误返回后如何处理？

不过，我要指出一点：如果您对处理结果和错误使用相同的数组/列表/集合，这往往会令人困惑。如果您的方法返回错误列表（或在没有错误的情况下为空/空列表）也会令人困惑，因为看起来错误是执行您的方法的结果。

【讨论】：

我添加了一个简化的示例使用。无论如何，目的是得到所有错误，而不是仅仅放弃第一个错误。

【解决方案3】：

尝试使用列表收集所有错误信息并没有错。使用ArrayList 可以正常工作，无需担心...

如果您知道没有错误，您可以return Collections.emptyList();。

一般来说，集合避免返回null 或空列表。我总是使用空列表，因为它不会破坏循环。

【讨论】：

【解决方案4】：

您是否发现将错误消息字符串作为列表返回有问题？如果那么，有什么更好的选择呢？

没有。如果列表可以解决您的问题，那么使用列表没有任何问题。

new LinkedList() 或 new ArrayList(0) 或 new ArrayList() 更适合预计保持为空的列表，通常应该有只有不为空时才进行顺序迭代器访问？

知道列表要存储多少元素并用该容量实例化列表不会对性能有任何显着改善：

每个 ArrayList 实例都有一个容量。容量是大小用于存储列表中元素的数组。它总是在至少与列表大小一样大。随着元素被添加到 ArrayList，它的容量会自动增长。成长的细节除了添加元素具有固定摊销时间成本。

但是，如果列表通常为空，则您将使用 new ArrayList(0) 节省一些内存，因为当未指定初始容量时列表的大小被初始化为 10。

【讨论】：