使用 Java 编程式 HTML 文档生成

Question

有谁知道如何在Java中以编程方式生成HTMLDocument对象，而不需要在外部生成字符串，然后使用HTMLEditorKit#read来解析它？ 我问的原因有两个：

首先，我的 HTML 生成例程需要非常快，并且我认为将字符串解析为内部模型比直接构建该模型成本更高。

其次，面向对象的方法可能会产生更清晰的代码。

我还应该提到，出于许可原因，我无法使用 JVM 附带的库以外的任何库。

Answer 1

一种面向对象的方法是使用名为 ECS 的库。

这是一个非常简单的库，并且已经很长时间没有改变了。 话又说回来，HTML 4.01 规范也没有改变；）我使用过 ECS，并认为它比仅使用 Strings 或 StringBuffers/StringBuilders 生成大型 HTML 片段要好得多。

小示例：

Option optionElement = new Option();
optionElement.setTagText("bar");
optionElement.setValue("foo");
optionElement.setSelected(false);   

optionElement.toString() 现在将产生：

<option value='foo'>bar</option>

该库支持 HTML 4.0 和 XHTML。 最初唯一让我困扰的是与 XHTML 版本相关的类名以小写字母开头：option、input、 a、tr等等，这违背了最基本的Java约定。 但如果您想使用 XHTML，您可以习惯这一点； 至少我做到了，速度快得惊人。

Answer 2

我会研究 JSP 的工作原理 - 即，它们编译成一个 servlet，该 servlet 基本上是一组巨大的 StringBuffer 附加。 这些标签还会编译成 Java 代码片段。 这很混乱，但是非常非常快，除非深入研究 Tomcat 的工作目录，否则您永远不会看到这段代码。 也许您想要的是从以 HTML 为中心的视图（如 JSP）实际编写 HTML 生成代码，并添加循环标记等，并在项目内部使用类似的代码生成引擎和编译器。

或者，只需在一个实用程序类中自行处理 StringBuilder，该实用程序类具有“openTag”、“closeTag”、“openTagWithAttributes”、“startTable”等方法......它可以使用 Builder 模式，并且您的代码将如下所示喜欢：

public static void main(String[] args) {
    TableBuilder t = new TableBuilder();
    t.start().border(3).cellpadding(4).cellspacing(0).width("70%")
      .startHead().style("font-weight: bold;")
        .newRow().style("border: 2px 0px solid grey;")
          .newHeaderCell().content("Header 1")
          .newHeaderCell().colspan(2).content("Header 2")
      .end()
      .startBody()
        .newRow()
          .newCell().content("One/One")
          .newCell().rowspan(2).content("One/Two")
          .newCell().content("One/Three")
        .newRow()
          .newCell().content("Two/One")
          .newCell().content("Two/Three")
      .end()
    .end();
    System.out.println(t.toHTML());
}

Answer 3

在处理 XHTML 时，我使用 Java 6 的 XMLStreamWriter 接口。

OutputStream destination = ...;
XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
XMLStreamWriter xml = outputFactory.createXMLStreamWriter(destination);

xml.writeStartDocument();
xml.writeStartElement("html");
xml.writeDefaultNamespace("http://www.w3.org/1999/xhtml");

xml.writeStartElement("head");
xml.writeStartElement("title");
xml.writeCharacters("The title of the page");
xml.writeEndElement();
xml.writeEndElement();

xml.writeEndElement();
xml.writeEndDocument();

Answer 4

我认为通过 StringBuilder（或直接生成流）之类的东西手动生成 HTML 将是您的最佳选择，特别是如果您无法使用任何外部库。

由于无法使用任何外部库，您将在开发速度而不是性能方面遭受更多损失。

Answer 5

javax.swing.text.html 有 HTMLWriter 和 HTMLDocument 类等。 我没有用过它们。 我已经在.Net中使用了HtmlWriter，它完全符合您的要求，但java版本可能不一样。

这是文档： http ://java.sun.com/j2se/1.5.0/docs/api/javax/swing/text/html/HTMLWriter.html

另外，我无法想象 StringBuilder比使用对象层构建要慢。 在我看来，任何面向对象的方法都必须构建对象图，然后生成字符串。 不对这些内容使用原始字符串的主要原因是，您肯定会遇到编码错误以及产生格式错误的文档的其他错误。

选项 2：您可以使用您最喜欢的 XML api 并生成 XHTML。

Answer 6

您可能想使用 render() 方法构建一些 Element 对象，然后将它们组装成树结构； 通过访问算法，您可以继续设置值，然后渲染整个内容。

PS：您是否考虑过像 freemarker 这样的模板引擎？

Answer 7

看来您可以使用直接构造 HTMLDocument.BlockElement 和 HTMLDocument.BlockElement 对象来完成您尝试的任务。 这些构造函数的签名表明至少可以直接使用。

我建议检查 OpenJDK 中的 Swing 源代码，看看解析器如何处理这个问题，并从那里导出您的逻辑。

我还建议这种优化可能为时过早，也许这应该是一种速度优化的替代方法，以替代更简单的方法（即生成 HTML 文本），只有在这确实成为应用程序中的性能热点时才引入。

Answer 8

您可以使用任何合适的 xml 库，例如 JDom、Xom 或 XStream。 Html 只是 XML 的一个特例。

或者，您可以使用服务器端 java 的现有模板引擎之一，例如 jsp 或velocity。

Answer 9

基本上，您可以使用插入方法之一 insertBeforeEnd()、insertAfterEnd()、insertBeforeStart()、insertAfterStart() 将 html 插入 HTMLDocument。
您向该方法提供要插入的 html 以及要插入 html 的文档树中的位置。

例如。

doc.insertBeforeEnd(元素, html);

HTMLDocument 类还提供了遍历文档树的方法。