访问Java中的私有Collection字段

Question

我的一个类有一个包含集合的字段。该字段仅在构造函数中填充，然后由其他类读取。最初我有这样的想法：

public class Foo {
    public final Set<String> myItems;
    public Foo(Collection<String> theirItems) {
        this.myItems = new LinkedHashSet<String>(theirItems);
    }
}

但这违背了 OO 最佳实践，其中 myItems 应该是私有的，并且只能通过 setter 和 getter 访问。所以后来我把它改成了：

public class Foo {
    private final Set<String> myItems;
    public Foo(Collection<String> theirItems) {
        this.myItems = new LinkedHashSet<String>(theirItems);
    }
    public Set<String> getItems() {
        return myItems;
    }
}

现在 myItems 是私有的，但是无论谁调用 getItems() 仍然可以随意添加/删除项目，这基本上和我之前遇到的情况相同。 （我实际上并不担心有人更改项目内容，这更多的是一个理论问题）

所以然后我更改了 getItems() 以返回一个数组：

public String[] getItems() {
    return myItems.toArray(new String[myItems.size()]);
}

现在我的项目真的是私有的。不幸的是，我知道将读取项目的对象实际上想要使用 Set，因此它必须立即将数组转换回来。我还可以返回 myItems 的副本：

public Set<String> getItems() {
    return new LinkedHashSet<String>(myItems);
}

这为调用者提供了他们想要的内容，但在每次访问时创建一个新的 Set。

在这种情况下，您会做什么 - 不惜一切代价保护隐私，并接受原始结构的转换/复制，或者牺牲对集合内容的控制并依赖负责任的调用者？

Answer 1

我会选择你的最后一个选择：

public Set<String> getItems() {
    return new LinkedHashSet<String>(myItems);
}

Answer 2

我要么制作该集合的副本，要么使用 Collections.unmodifyingSet()。

如果性能是一个问题，我会打破封装规则并返回原始集。

Answer 3

我会克隆该集以返回它，这样如果调用者修改了该集，它就不会影响您自己的集。

Answer 4

作为 Collections.unmodifyingSet(java.util.Set) 的替代方案，名为 Google Collections Library< /a> 有
com.google.common.collect。不可变集。

Answer 5

返回一个不可修改的视图到您的集合上：

public Set<String> getItems() {
    return Collections.unmodifiableSet(myItems);
}

请注意，这意味着调用者仍然会看到您对集合所做的任何更改（如果他们保留在返回的集合上）。如果您不想这样做，您将必须制作一份副本...没有（简单）的方法可以解决这个问题。 （理论上，您可以制作一个不可修改的副本，并返回对同一副本的引用，直到您下次进行更改，但这会变得混乱。）

一个重要的一点是记录您选择的任何内容，以便调用者不会得到任何信息令人讨厌的惊喜。从很多方面来说，我认为这实际上是大多数应用程序中最重要的事情，其中​​调用者实际上并不是恶意的。只要清楚会产生什么影响，在大多数情况下，采取防御措施就不那么重要了。当然，如果您的调用者可能是一些不可信的代码，并且您的设置对于安全性等至关重要，那么您的情况就不同了。

Answer 6

这取决于上下文。有几个选项：

1. 返回集合。调用者可以根据需要修改集合，但不能分配新的集合。这是最便宜的，但提供的保护最少。
2. 返回一个视图（使用Collections类的unmodifyingXXX工厂）。调用者无法修改集合，但集合的更新对调用者来说是可见的。这通常相对便宜，因为没有分配元素存储；仅创建一个包装器。
3. 使用适当集合的复制构造函数返回集合的快照。在这里，调用者获得该集合的副本。他们可以修改副本，但原始副本不会更新，并且对原始副本的更新在副本中不可见。这是最贵的。

Answer 7

您需要有多“安全”？您返回的数组引用了您的集合所保存的相同对象，如果这些对象具有设置器，那么您就允许调用者修改您的集合的内容...可以吗？

可以克隆该集合，或者提供用于访问该集合的不可变接口。这是一个判断。如果我正在开发框架代码，我倾向于在安全和克隆方面犯错误。当客户端耦合更紧密时（例如同一包中的相关类），我倾向于不那么保守。