有人打破了我对列表的排序 - 现在选择哪种方法：返回不可修改的列表或一个新的列表？答案

【问题标题】：Someone breaks my sorting of a list - now which approach to choose: return unmodifiable List or a new List alltogether?有人打破了我对列表的排序 - 现在选择哪种方法：返回不可修改的列表或一个新的列表？
【发布时间】：2012-10-29 13:55:28
【问题描述】：

我正在使用 jsf Web 服务器上的列表，例如从网页访问数据模型。对这些列表的访问也可以从其他不同的地方完成（网络服务、工具）。

有一段代码被我返回的列表破坏了。我说的是我的开发团队中的某个人——我们是唯一使用此代码的人。我有大约 300 条关于这个函数的引用，它可能与性能相关，可以很好地进行修复：

该列表可以包含 1 到 10'000 个条目，通常我可能会有 10-100 个这样的列表。实际上，我可能经常有大约 20 个列表，每个列表有 8 个条目 - 所以没什么大不了的。但有时我可以拥有更多

顺便说一句，我说的是这样的函数：

public List<MyObject> getMyObjectList() {
    if (this.myObjects== null) {
        myObjects = new ArrayList<MyObject>(myObjectsMap.values());
    }
    return myObjects;
}

现在我当然可以这样返回：

    public List<MyObject> getMyObjectList() {
        if (this.myObjects== null) {
            myObjects = new ArrayList<MyObject>(myObjectsMap.values());
        }
        return Collections.unmodifiableList(myObjects );
}

但这最终会在不同项目/应用程序的几个地方中断。恕我直言，返回不可修改、添加 javadoc 并修复所有损坏的东西是最干净的。但是 :-D 这是工作。我可能需要测试大约 10 个应用程序。

另一方面，我可以只返回一个新列表，例如

public List<MyObject> getMyObjectList() {
    return new ArrayList<MyObject>(myObjectsMap.values());
}

这不是一件小事 - 但是这方面的性能问题呢？除此之外 - 如果有人从我返回的列表中删除东西，它会默默地破坏应用程序。

所以：什么是性能问题？有问题吗？

你会怎么做？

【问题讨论】：

您应该在典型负载下对其进行测试以获得明确的答案。但是创建 100 个每个引用少于 10k 的新数组列表可能不会花费超过几毫秒的时间。因此，除非您的方法每秒被调用多次，否则您可能不会注意到差异。
我认为答案将更多地与如果我们更改列表（或）使其不可修改会产生什么影响，它在您的应用程序中是如何使用的？
性能只有在成为问题时才是问题。这意味着您甚至应该在有人抱怨之前考虑性能。
@GijsOvervliet 你的意思是应该不我想？
@Toskan 我的意思是，您可以轻松创建一个性能测试，在其中多次复制包含 10,000 个对象的数组列表，然后查看平均需要多长时间 - 您可能会发现它并不多.只要确保你write a correct micro benchmark。

标签： java list sorting unmodifiable

【解决方案1】：

你会怎么做？

如果我理解正确，这是一个用于多个应用程序的生产库。而且，不管你喜不喜欢，getMyObjectList() 的实际约定是用户可以对列表进行排序而不会出现错误或异常。

我会立即更改此方法并返回一个防御性副本：

// good idea
public List<MyObject> getMyObjectList() {
    return new ArrayList<MyObject>(myObjectsMap.values());
}

您现在已经解决了有人对您的内部收藏进行分类并且您没有违反合同的问题。事实上，您甚至可以更新 Javadoc 并告诉用户他们可以对副本做任何他们想做的事情。

这可能会也可能不会导致性能问题。请记住，集合中的对象没有被复制——它们仍然被共享。您只是在创建一个新的数组列表以及它需要跟踪对象的任何内部对象。

如果事实证明这些副本会导致性能问题，那么您可以考虑增强您的类以包含内部集合的只读缓存。要访问它，您必须为该方法指定一个新名称 - 例如 getMySharedObjectList，并且您可以逐步更新客户端代码以根据性能需要使用此新方法。

但不要这样做。我觉得这个方法特别不好：

// bad idea
public List<MyObject> getMyObjectList() {
    if (this.myObjects== null) {
        myObjects = new ArrayList<MyObject>(myObjectsMap.values());
    }
    return Collections.unmodifiableList(myObjects );
}

您创造了一种情况，myObjects 很容易与 myObjectsMap 不同步。（当一个项目被添加到 myObjectsMap 之后有人调用 getMyObjectList 时会发生什么？）同时，每次有人调用该方法时，您都在制作列表的副本。因此，您首先放弃了理论上的性能提升。

无论如何，祝你好运。希望这会有所帮助。

【讨论】：

我在 myObjectsMap.put() 或 remove() 上无效 - 我将运行一些测试并从那里开始，谢谢
您的方法的唯一问题是返回的列表不再是原始列表。如果某个应用程序正在运行，比如说 - getMyObjectList().removeAll() 实际上什么都不会发生，但它仍然被破坏了。
有问题吗？这是一个好处！您的收藏是安全的。如果你想允许 removeAll 向你的类添加一个 removeAll 方法，它只在你的地图上调用 removeAll 。你的类保持对集合的完全控制。

【解决方案2】：

如果您有能力测试应用程序，我会选择 unmodifiableList。它将在将来使您免于其他相关问题。

【讨论】：