DocumentBuilder.parse 是不是关闭 InputStream

Posted 2023-02-25

【中文标题】DocumentBuilder.parse 是不是关闭 InputStream

【英文标题】：Does DocumentBuilder.parse close the InputStreamDocumentBuilder.parse 是否关闭 InputStream

【发布时间】：2012-03-23 15:26:04

【问题描述】：

类似下面的代码：

InputStream is = new FileInputstream("test.xml");
Document doc = DocumentBuilder.parser(is);

我的问题是我是否需要手动关闭流（调用 is.close()）。 DocumentBuilder 会为我关闭 InputStream 吗？

【参考方案1】：

使用下面的测试代码查看输入流是否关闭，可以看到是哪一行代码关闭了流。

public class DocumentBuilderTest 

 public static void main(String[] args) 
   try 
     InputStream is = new MyInputStream("project.xml");
     DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
     DocumentBuilder documentBuilder = dbf.newDocumentBuilder();
     documentBuilder.parse(is);
    catch (Exception e) 
     e.printStackTrace();
   
 

 static class MyInputStream extends FileInputStream    
   public MyInputStream(String filename) throws FileNotFoundException 
     super(filename);
   

   @Override
   public void close() throws IOException 
     // here we log when the stream is close.
     System.out.println("file input stream closed.");
     Exception e = new Exception();
     e.printStackTrace();
     super.close();
   

 

传递给 DocumentBuilder 的输入流是否关闭取决于 DOMParser 实现。在我的环境中，文件输入流是关闭的，请看下面的堆栈跟踪：

at DocumentBuilderTest$MyInputStream.close(DocumentBuilderTest.java:37)
at com.sun.org.apache.xerces.internal.impl.XMLEntityManager$RewindableInputStream.close(XMLEntityManager.java:3047)
at com.sun.org.apache.xerces.internal.impl.io.UTF8Reader.close(UTF8Reader.java:661)
at com.sun.xml.internal.stream.Entity$ScannedEntity.close(Entity.java:441)
at com.sun.org.apache.xerces.internal.impl.XMLEntityManager.endEntity(XMLEntityManager.java:1406)
at com.sun.org.apache.xerces.internal.impl.XMLEntityScanner.load(XMLEntityScanner.java:1763)
at com.sun.org.apache.xerces.internal.impl.XMLEntityScanner.skipSpaces(XMLEntityScanner.java:1543)
at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl$TrailingMiscDriver.next(XMLDocumentScannerImpl.java:1400)
at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl.next(XMLDocumentScannerImpl.java:648)
at com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl.scanDocument(XMLDocumentFragmentScannerImpl.java:511)
at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:808)
at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:737)
at com.sun.org.apache.xerces.internal.parsers.XMLParser.parse(XMLParser.java:119)
at com.sun.org.apache.xerces.internal.parsers.DOMParser.parse(DOMParser.java:235)
at com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderImpl.parse(DocumentBuilderImpl.java:284)
at javax.xml.parsers.DocumentBuilder.parse(DocumentBuilder.java:124)
at DocumentBuilderTest.main(DocumentBuilderTest.java:22)

因此，您无法在此特定示例中手动关闭流。但是，当您确定该流将不再被使用时，关闭输入流总是一个好主意。在您的情况下，一旦文档被解析，就不再需要输入流，因此可以安全地关闭流，我建议您这样做。

【参考方案2】：

我所做的是扩展FilterInputStream，并重写close()方法实现以防止关闭InputStream

public class HackInputStream
    extends FilterInputStream 

    public HackInputStream(InputStream in) 
        super(in);
    

    @Override
    public void close() 
        // this does not close stream.
        // use hackedClose() instead.
    

    public void hackedClose() 
            throws IOException 
        super.close();
    

【参考方案3】：

通常的约定是获取资源的代码必须释放它。这是一种很好的做法，因为这意味着如果任何中间代码引发异常，您就不会泄漏资源。

使用try-with-resources 块：

try (InputStream in = new FileInputStream("foo")) 
  // process data

对于 Java 7 之前的版本：

InputStream in = new FileInputStream("foo");
try 
  // process data
 finally 
  in.close();

【参考方案4】：

文档没有提到它关闭流，我不希望它为你关闭流。

可以肯定的是，您可以阅读源代码，或者在调用 parse() 后在一个简单的示例案例中检查它是否打开。

但简短的回答：是的，您需要事后手动关闭它。

【讨论】：

谢谢！我举个简单的例子。

没问题。另外，我会假设如果没有明确说明，该方法不会关闭它。我希望方法作用于我传递的对象，以尽可能少地作用于对象。调用 .close() 将被视为违反对我的责任（解析方法没有业务调用 .close()）。

令我惊讶的是，DocumentBuilder.parse 在我的示例中关闭了流。

有趣...我没想到会这样。我觉得他们应该在他们的文档中注意到这一点，尽管我猜从技术上讲它是特定于实现的。我猜他们认为一旦 InputSteam 结束，让它保持打开状态的目的是什么。

是的，它关闭了流，它产生了一个问题，我不能再继续使用这个流了。

【参考方案5】：

如果您需要在 DOM 解析后不关闭您的流（例如，为了能够继续阅读它），请参阅此线程： Java create InputStream from ZipInputStream entry