ruby - 是否有必要在 ruby​​ 中关闭 StringIO？

Question

我们是否需要在 Ruby 中使用后关闭 StringIO 对象以释放资源，就像我们处理真正的 IO 对象一样？

obj = StringIO.new "some string"
#...
obj.close # <--- Do we need to close it?

提炼我的问题

关闭文件对象是必要的，因为它将关闭文件描述符。打开文件的数量在操作系统中是有限的，这就是为什么有必要关闭文件。但是，如果我理解正确的话，StringIO 是内存中的抽象。我们需要关闭它吗？

Answer 1

• StringIO#close 不释放任何资源或删除对累积字符串的引用。因此调用它对资源使用没有影响。

• 只有在垃圾回收期间调用的 StringIO#finalize 释放对累积字符串的引用，以便它可以被释放(前提是调用者不保留自己对它的引用)。

• StringIO.open ，它短暂地创建了一个 StringIO 实例，在它返回后不保留对该实例的引用；因此，可以释放 StringIO 对累积字符串的引用(前提是调用者不保留自己对它的引用)。

• 实际上，在使用 StringIO 时很少需要担心内存泄漏。只是不要卡在对 StringIO 的引用上，一旦你完成了它们，一切都会好起来的。

---

深入源代码

StringIO 实例使用的唯一资源是它积累的字符串。您可以在 stringio.c (MRI 1.9.3) 中看到；这里我们看到了保存 StringIO 状态的结构:

static struct StringIO *struct StringIO {
    VALUE string;
    long pos;
    long lineno;
    int flags;
    int count;
};

当一个 StringIO 实例完成(即垃圾收集)时，它对字符串的引用将被丢弃，以便该字符串可以被垃圾收集如果没有其他引用。这是 finalize 方法，它也被 StringIO#open(&block) 调用以关闭实例。

static VALUE
strio_finalize(VALUE self)
{
    struct StringIO *ptr = StringIO(self);
    ptr->string = Qnil;
    ptr->flags &= ~FMODE_READWRITE;
    return self;
}

finalize 方法仅在对象被垃圾回收时调用。 StringIO 没有其他方法可以释放字符串引用。

StringIO#close 只是设置了一个标志。它不会释放对累积字符串的引用或以任何其他方式影响资源使用:

static VALUE
strio_close(VALUE self)
{   
    struct StringIO *ptr = StringIO(self);
    if (CLOSED(ptr)) {
        rb_raise(rb_eIOError, "closed stream");
    }
    ptr->flags &= ~FMODE_READWRITE;
    return Qnil;
}

最后，当您调用 StringIO#string 时，您将获得对 StringIO 实例已累积的完全相同字符串的引用:

static VALUE
strio_get_string(VALUE self)
{   
    return StringIO(self)->string;
}

---

如何在使用StringIO时泄漏内存

所有这一切都意味着 StringIO 实例只有一种方法会导致资源泄漏:您不能关闭 StringIO 对象，并且必须保留它比保留调用 StringIO#string 时获得的字符串更长的时间。例如，假设一个类有一个 StringIO 对象作为实例变量:

class Leaker

  def initialize
    @sio = StringIO.new
    @sio.puts "Here's a large file:"
    @sio.puts
    @sio.write File.read('/path/to/a/very/big/file')
  end

  def result
    @sio.string
  end

end

想象一下，这个类的用户得到结果，短暂地使用它，然后丢弃它，但仍然保留对 Leaker 实例的引用。您可以看到 Leaker 实例通过未关闭的 StringIO 实例保留了对结果的引用。如果文件非常大，或者存在许多 Leaker 实例，这可能是个问题。这个简单的(故意病态的)示例可以通过简单地不将 StringIO 保留为实例变量来修复。如果可以(几乎总是可以)，最好简单地丢弃 StringIO 对象，而不是显式地关闭它:

class NotALeaker

  attr_reader :result

  def initialize
    sio = StringIO.new
    sio.puts "Here's a large file:"
    sio.puts
    sio.write File.read('/path/to/a/very/big/file')
    @result = sio.string
  end

end

除此之外，这些泄漏仅在字符串很大或 StringIO 实例众多时才有意义并且 StringIO 实例存在很长时间，并且您可以看到很少显式关闭 StringIO，如果曾经，需要。