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

Question

我在 jsf 网络服务器上使用列表，例如从网页访问数据模型。对这些列表的访问也是从其他各种地方完成的(网络服务、工具)。

有一段代码被某人使用我返回的列表破坏了。我说的是我的开发团队中的某个人——我们是唯一使用此代码的人。我有大约 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 时会发生什么情况？)同时，每次有人调用该方法时，您都在制作列表的副本。因此，您只是放弃了最初获得的任何理论性能提升。

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