Question

我正在查看的当前代码库使用DOM解析器。以下代码片段在5种方法中重复：

 DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
 DocumentBuilder builder = factory.newDocumentBuilder();

如果在循环中调用包含上述代码的方法或者在应用程序中多次调用该方法，我们将承担为每次调用此类方法创建新的DocumentBuilderFactory实例和新的DocumentBuilder实例的开销。。

在DocumentBuilder工厂和DocumentBuilder实例周围创建一个单独的包装器是一个好主意，如下所示：

public final class DOMParser {
   private DocumentBuilderFactory = new DocumentBuilderFactory();
   private DocumentBuilder builder;

   private static DOMParser instance = new DOMParser();

   private DOMParser() {
      builder = factory.newDocumentBuilder();
   }

   public Document parse(InputSource xml) {
       return builder.parser(xml);
   }
}

如果在多个线程之间共享上述单例，是否会出现任何问题？如果没有，使用上述方法在应用程序的整个生命周期内只创建一次DocumentBuilderFactory和DocumentBuilder实例会有什么性能提升吗？

修改：

我们唯一能遇到问题的是，如果DocumentBuilder在解析可能影响下一个XML文件解析的XML文件时保存了一些状态信息。

Answer 1

有关同一事项的其他问题，请参阅评论部分。 您的问题的简短回答：不，将这些类放入单例中并不是。 DocumentBuilderFactory和DocumentBuilder都不保证是线程安全的。如果您有多个解析XML的线程，请确保每个线程都有自己的DoumentBuilder版本。每个线程只需要其中一个，因为重置后可以重用DocumentBuilder。

编辑一个小小的片段，表明使用相同的DocumentBuilder是不好的。使用java 1.6_u32和1.7_u05时，此代码将失败并显示org.xml.sax.SAXException: FWK005 parse may not be called while parsing。在构建器上取消注释同步，它可以正常工作：

        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        final DocumentBuilder builder = factory.newDocumentBuilder();

        ExecutorService exec = Executors.newFixedThreadPool(10);
        for (int i = 0; i < 10; i++) {
            exec.submit(new Runnable() {
                public void run() {
                    try {
//                        synchronized (builder) {
                            InputSource is = new InputSource(new StringReader("<?xml version=\"1.0\" encoding=\"UTF-8\" ?><俄语>данные</俄语>"));
                            builder.parse(is);
                            builder.reset();
//                        }
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            });
        }
        exec.shutdown();

所以这是你的答案 - 不要从多个线程中调用DocumentBuilder.parse()。是的，这种行为可能是特定于JRE的，如果你使用的是IBM java或JRockit，或者给它一个不同的DocumentBuilderImpl，它可能工作正常，但是对于默认的xerces实现 - 它没有。

Answer 2

JAXP规范（V 1.4）说：

预计SAXParserFactory实现的newSAXParser方法，DocumentBuilderFactory的newDocumentBuilder方法和TransformerFactory的newTransformer方法将是线程安全的，没有副作用。这意味着应用程序员应该能够从共享工厂一次创建多个线程中的转换器实例，而不会产生副作用或问题。

https://jaxp.java.net/docs/spec/html/#plugabililty-thread-safety

因此，例如，您应该能够通过DocumentBuilderFactory.newInstance创建单个DocumentBuilderFactory实例，然后使用该单个工厂通过DocumentBuilderFactory.newDocumentBuilder为每个线程创建一个DocumentBuilder。您还可以创建一个DocumentBuilders池。

我无法在任何地方找到，例如，静态方法DocumentBuilderFactory.newInstance是线程安全的。该实现看起来是线程安全的，因为有一些方法同步正在完成，但规范明确指出DocumentBuilderFactory.newDocumentBuilder是线程安全的。

Answer 3

您需要了解三件事：

创建工厂的成本是多少？如果成本低，您的性能增益可能接近于零。
创建构建器的成本是多少？如果成本低，您的性能增益可能接近于零。
工厂和/或建造者线程是否安全？如果没有，您需要确保使用synchronized关键字使访问它们的方法成为线程安全的。

我不熟悉您正在使用的DocumentBuilder类，但所有这些信息都应该在其javadoc或其他文档中提供。如果某些对象的创建成本很高，他们通常会向您提供此信息。

Answer 4

首要回答您的问题，文档生成器不是线程安全的。但是我们可以通过两种方式使其成为线程安全的：

已同步
ThreadLocal

对于同步，我们可以做的只是制作一个同步块，这将对我们有用，我们应该在小块上使用同步，因为它非常昂贵，有时会使事情变得很慢。

   DocumentBuilder documentBuilder=DocumentBuilderFactory.newInstance().newDocumentBuilder();
   synchronized(documentBuilder)
   {
      documentBuilder.parse(xmlFile.getInputStream());           
   }

我们可以遵循的另一种更好的方法是使用ThreadLocal。

    public class XmlParser {

    private static ThreadLocal<DocumentBuilder> documentBuilder;

    public XmlParser() {
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        factory.setNamespaceAware(true);
        documentBuilder = ThreadLocal.withInitial(() -> documentBuilder(factory));
    }
    private DocumentBuilder documentBuilder(DocumentBuilderFactory factory) {
        try {
            return factory.newDocumentBuilder();
        } catch (ParserConfigurationException e) {
            throw new Exception("file is not valid);
        }
    }
    public Document parse(MultipartFile xmlFile) {
        try {
            Document parse = documentBuilder.get().parse(xmlFile.getInputStream());
            documentBuilder.remove();
            parse.normalizeDocument();
            return parse;

        } catch (IOException | SAXException e) {
            throw new Exception(e);
        }
    }

Answer 5

我们可以重用DocumentBuilder实例而不是每次都创建它吗，因为创建新对象占用了3％的CPU使用率。

样品：-

类级别变量：- 私有静态易失性DocumentBuilder builder = null;

    if (Common.builder == null) {
        synchronized (DocumentBuilder.class) {
            if (Common.builder == null) {
                SplunkLogger.info("DocBuilderInstance=New_Instance");
                Common.builder =
                        XMLUtil.getDocumentBuilderFactory()
                        .newDocumentBuilder(); // DocumentBuilderFactory.newInstance().newDocumentBuilder();
            } else {
                SplunkLogger.info("DocBuilderInstance=Re-Use_Existing_Instance_InnerIf");
            }
        }
    } else {
        SplunkLogger.info("DocBuilderInstance=Re-Use_Existing_Instance");
}
    final InputSource source = new InputSource();
    source.setCharacterStream(new StringReader(responseString));
    final Document doc = Common.builder.parse(source);
    return doc.getElementsByTagName(firstKey);
}

DocumentBuilder线程安全吗？

5 个答案: