jjzjj

java - 公开内部集合项时应该使用 Iterator 还是 Iterable？

coder 2024-03-03 原文

我有一个带有私有(private)可变数据列表的类。

我需要在以下条件下公开列表项:

  • 列表不应在外部修改；
  • 使用 getter 函数的开发人员应该清楚，他们获得的列表无法修改。

    • 应将哪个 getter 函数标记为推荐方法？或者你能提供更好的解决方案吗？
    class DataProcessor {
    private final ArrayList<String> simpleData = new ArrayList<>();
    private final CopyOnWriteArrayList<String> copyData = new CopyOnWriteArrayList<>();

    public void modifyData() {
        ...
    }

    public Iterable<String> getUnmodifiableIterable() {
        return Collections.unmodifiableCollection(simpleData);
    }

    public Iterator<String> getUnmodifiableIterator() {
        return Collections.unmodifiableCollection(simpleData).iterator();
    }

    public Iterable<String> getCopyIterable() {
        return copyData;
    }

    public Iterator<String> getCopyIterator() {
        return copyData.iterator();
    }
}

    UPD:这个问题来自关于列表 getter 实现的最佳实践的真实代码审查讨论

    最佳答案

    “最佳”解决方案实际上取决于预期的应用程序模式(而不是像接近投票者所建议的那样取决于“意见”)。每个可能的解决方案都有可以客观判断的优缺点(而 有 由开发人员判断)。

    Edit: There already was a question "Should I return a Collection or a Stream?", with an elaborate answers by Brian Goetz. You should consult this answers as well before making any decision. My answer does not refer to streams, but only to different ways of exposing the data as a collection, pointing out the pros, cons and implications of the different approaches.



    返回迭代器

    仅返回 Iterator不方便，不管进一步的细节，例如是否允许修改。安 Iterator在foreach中不能单独使用环形。所以客户必须写
    Iterator<String> it = data.getUnmodifiableIterator();
while (it.hasNext()) {
    String s = it.next();
    process(s);
}

    而基本上所有其他解决方案都允许他们只写
    for (String s : data.getUnmodifiableIterable()) {
    process(s);
}

    暴露一个 Collections.unmodifiable...查看内部数据:

    您可以公开内部数据结构，包装到相应的 Collections.unmodifiable... 中。 Collection 。任何修改返回集合的尝试都将导致 UnsupportedOperationException被抛出，明确说明客户端不应修改数据。

    此处设计空间的一个自由度是您是否隐藏其他信息:当您有 List 时，你可以提供一个方法
    private List<String> internalData;

List<String> getData() {
    return Collections.unmodifiableList(internalData);
}

    或者，您可以对内部数据的类型不太具体:
  • 如果调用者不能使用 List#get(int index) 进行索引访问方法，那么你可以将该方法的返回类型更改为 Collection<String> .
  • 如果调用者还不能通过调用 Collection'size() 获得返回序列的大小，那么你可以返回一个 Iterable<String> .

    • 还要考虑的是，当暴露不太具体的接口(interface)时，您以后可以选择将内部数据的类型更改为 Set<String> ， 例如。如果您保证返回 List<String> ，然后稍后更改它可能会引起一些头痛。

    暴露内部数据的副本:

    一个非常简单的解决方案是只返回列表的副本:
    private List<String> internalData;

List<String> getData() {
    return new ArrayList<String>(internalData);
}

    这可能具有(可能大且频繁)内存复制的缺点，因此仅应在集合“小”时考虑。

    此外，调用者将能够修改列表，并且他可能希望更改反射(reflect)在内部状态中(事实并非如此)。可以通过将新列表额外包装到 Collections.unmodifiableList 中来缓解此问题。 .

    暴露一个 CopyOnWriteArrayList

    暴露一个 CopyOnWriteArrayList通过其 Iterator或作为 Iterable可能不是一个好主意:调用者可以选择通过 Iterator#remove 修改它调用，而您明确希望避免这种情况。

    暴露一个CopyOnWriteArrayList的解决方法它被包裹成一个 Collections.unmodifiableList可能是一个选择。乍一看，它可能看起来像一个多余的厚防火墙，但它绝对是合理的 - 请参阅下一段。

    一般注意事项

    在任何情况下，您都应该虔诚地记录这种行为。特别是，您应该记录调用者是 不是 应该以任何方式更改返回的数据(无论是否可能而不会导致异常)。

    除此之外，还有一个令人不舒服的权衡:您可以在文档中准确无误，也可以避免在文档中公开实现细节。

    考虑以下情况:
    /**
 * Returns the data. The returned list is unmodifiable. 
 */
List<String> getData() {
    return Collections.unmodifiableList(internalData);
}

    此处的文档实际上还应说明...
    /* ...
 * The returned list is a VIEW on the internal data. 
 * Changes in the internal data will be visible in 
 * the returned list.
 */

    考虑到线程安全和迭代期间的行为，这可能是一个重要信息。考虑一个循环，它对内部数据的不可修改 View 进行迭代。并考虑在这个循环中，有人调用了一个导致内部数据修改的函数:
    for (String s : data.getData()) {
    ...
    data.changeInternalData();
}

    这个循环将以 ConcurrentModificationException 中断，因为内部数据在迭代时被修改。

    这里关于文档的权衡是指，一旦指定了某个行为，客户端将依赖于这个行为。想象一下客户端这样做:
    List<String> list = data.getList();
int oldSize = list.size();
data.insertElementToInternalData();

// Here, the client relies on the fact that he received
// a VIEW on the internal data:
int newSize = list.size();
assertTrue(newSize == oldSize+1);

    诸如 ConcurrentModificationException 之类的东西如果返回了内部数据的真实副本，或者使用 CopyOnWriteArrayList 就可以避免。 (每个包裹成一个 Collections.unmodifiableList )。在这方面，这将是“最安全”的解决方案:
  • 调用方无法修改返回列表
  • 调用者不能直接修改内部状态
  • 如果调用者间接修改了内部状态，那么迭代仍然有效

    • 但是人们必须考虑相应的应用案例是否真的需要如此多的“安全性”，以及如何以一种仍然允许更改内部实现细节的方式记录这一点。

    关于java - 公开内部集合项时应该使用 Iterator 还是 Iterable？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/30194843/

    IteratorIterablecodebrStringjavaarraylistcopyonwritearraylist

    有关java - 公开内部集合项时应该使用 Iterator 还是 Iterable？的更多相关文章

    1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

      我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

    2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

      我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

    3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

      类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

    4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

      很好奇，就使用ruby​​onrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？ 最佳答案 不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提

    5. ruby - 在 Ruby 中使用匿名模块 - 2

      假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？ 最佳答案 三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

    6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

      我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封，在我看来soap请求没有正确的命名空间。任何人都可以建议我

    7. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

      关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

    8. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

      我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t

    9. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

      我想将html转换为纯文本。不过，我不想只删除标签，我想智能地保留尽可能多的格式。为插入换行符标签，检测段落并格式化它们等。输入非常简单，通常是格式良好的html(不是整个文档，只是一堆内容，通常没有anchor或图像)。我可以将几个正则表达式放在一起，让我达到80%，但我认为可能有一些现有的解决方案更智能。 最佳答案 首先，不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案，它会随着HTML的变化而崩溃，或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

    10. ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2

      我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库，所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po

    随机推荐