java - 有人破坏了我对列表的排序 - 现在选择哪种方法 : return unmodifiable List or a new List altogether?

Question

我正在 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());
}

这确实是一项不小的工作——但是这样做的性能问题又如何呢？除此之外 - 如果有人从我返回的列表中删除内容，它会默默地破坏应用程序。

所以: 性能问题是什么？这是一个问题吗？

你会做什么？

Answer 1

What would you do?

如果我理解正确的话，这是一个在多个应用程序中使用的生产库。而且，无论您喜欢与否，getMyObjectList() 的事实上的约定是用户可以对列表进行排序而不会出现错误或异常。

我会立即更改此方法并返回防御副本:

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

您现在已经解决了有人对您的内部 Collection 进行排序的问题，并且您没有违反契约(Contract)。事实上，您甚至可以更新 Javadoc 并告诉用户他们可以对副本执行任何操作。

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

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

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

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

您造成了 myObjects 很容易与 myObjectsMap 不同步的情况。 (当有人调用 getMyObjectList 之后将一个项目添加到 myObjectsMap 中时会发生什么？)同时，每次有人调用该方法时，您都会创建列表的副本。所以你一开始就放弃了理论上的性能提升。

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