如何在 Java 中整合 HTML 文档

Java 开发者常常面临在高效文件处理工作流中整合文档的挑战。在这种情况下，HTML 可能不是首先想到的文档格式------我们可能会首先想到 PDF 或 Excel 这些更强大、更具"商务性"的格式，但 HTML 在许多现代企业环境中的重要性不容小觑。无论是处理从多个在线来源收集的数据、拼接抓取的网页，还是整合自定义的基于 Web 的报告，程序化地合并和打包 HTML 内容往往具有高度相关性。

在本文中，我们将深入探讨程序化合并 HTML 内容的含义，并指出 Java 开发人员在这一过程中可能遇到的一些具体挑战。在文章的最后，我们将介绍一些开源库和第三方 API，这些工具可以帮助我们将 HTML 合并功能集成到文件处理工作流中，并仔细权衡每种方法的优缺点。

Java 项目中 HTML 合并的常见场景

与合并 Excel 文档类似（Excel 文档由压缩的基于 XML 的文件组成，其结构与普通 HTML 内容惊人地相似），合并 HTML 通常是自动化报告打包工作流中的关键部分。HTML5 是一种出色的解决方案，适用于涉及独特且吸引人的可视化的自定义数据报告。

同样，HTML 合并可以作为 Web 抓取的数据整合手段------这种做法往往会生成一系列单独的 HTML 片段，所有这些片段都需要合并到一个文档中，才能使数据变得有用且易于呈现。

在将 HTML 转换为 PDF 格式之前，HTML 合并也可以是一个优先的预处理步骤。在转换为 PDF 之前合并 HTML（而不是在后处理步骤中合并已转换的 PDF），可以在大规模程序中节省一些内存。

在 Java 中合并 HTML 文件的含义是什么？

很容易低估程序化合并 HTML 内容所涉及的挑战。合并 HTML 并不仅仅是将 HTML 代码行串联起来------它涉及以一种保留其功能、样式和内容完整性的方法来合并网页。它需要一种处理结构、样式和行为的策略。

在 Java 中合并 HTML 文件时，需要考虑几个核心问题。

头部标签

首先，每个有效的 HTML 文档都有自己的 <head> 标签。这些标签可以携带文档的样式、脚本和元标签------所有这些信息对于保留文件的预期功能都至关重要。如果我们不正确处理每个文件的 <head> 标签，很容易意外覆盖或重复关键元素。

在 Java 中手动解析和合并 <head> 部分意味着编写脆弱的逻辑来识别和去重标签。这通常涉及使用 DOM 库或正则表达式，而这些方法在处理边缘情况时通常无法很好地发挥作用。

CSS 和 JavaScript

携带各自 CSS 和 JavaScript 代码的不同 HTML 文档也可能相互"冲突"，这可能会对每个页面的预期功能产生负面影响。例如，如果两个 HTML 文件具有相同的 CSS 选择器或 JavaScript 函数，粗心的合并操作可能会破坏它们。

Java 中缺乏用于处理 CSS/JavaScript 冲突解决的内置工具；解决这一问题意味着编写自定义的预处理步骤，或者依赖第三方解析器来安全地隔离和重写脚本。当然，这是可以做到的，但它既繁琐又不直接相关。

相对路径

任何涉足 HTML 开发的后端程序员都会记得，图像、样式表和脚本通常依赖于相对路径。所有这些在合并 HTML 内容时都可能变成一团糟。在复杂的合并操作中，需要调整引用，以确保每个文件中的各种资源都能正确加载。

在 Java 中处理相对路径时，我们通常需要遍历 DOM 来重写每个单独的 SRC、HREF 或 URL() 引用。这可能非常繁琐，尤其是当我们处理深度嵌套或动态生成的 HTML 内容时。

格式错误的内容

最后，当然还有格式错误的内容这一永恒问题------这不仅是在 HTML 文件合并中，而且在大多数文档处理工作流中都会遇到的问题。在从多个来源合并网络内容时，HTML 文件中通常会遇到不完整的标签、未正确关闭的元素或嵌套不匹配等问题。我们需要确保应用程序在合并文件之前识别并解决这些问题，以避免显示错误------并避免像跨站脚本攻击（XSS）这样邪恶的安全漏洞，当危险的属性或嵌入的脚本未正确清理时，这种情况可能会发生。

Java 中默认的 HTML 解析库（例如 JSoup）可以帮助清理格式错误的内容，但它们仍然需要仔细配置，以避免剥离重要元素或遗漏危险元素。

使用开源 Java 库合并 HTML

构建高效的 Java 程序就是要找到适合工作的工具，而开源工具是许多人的首选。下面，我们将介绍一些用于在 Java 中处理 HTML 文档的流行开源 API。

我们在前一节中提到的一个选项是 JSoup ，它提供了一个流行、强大且易于使用的 API。像 Jsoup.parse()、Jsoup.clean()、Jsoup.select()、Jsoup.text() 等方法让我们可以解析 HTML、清理脏乱的标记，并以复杂的方式操作 DOM。然而，这仍然需要自定义代码来合并文档，因此虽然它非常适合解析和清理单个文件，但它并不能完成全部工作。它也不会直接为我们解决样式和脚本之间的冲突。

Jericho HTML Parser 是另一个值得考虑的选择；如果我们需要对 HTML 内容合并的方式进行精细控制，这是一个特别好的选择。它最显著的特点是提供了在不丢失格式的情况下修改 HTML 文档的选项（例如，Source source = new Source(<html here>) 解析 HTML 时保留原始格式和间距），并且它会逐字复制未识别或无效的 HTML。不过，有些人可能会觉得它冗长，而且它肯定比使用 JSoup 需要更多的额外编码。

最后，如果我们最关注的是清理格式错误的 HTML 并将其转换为一致且格式良好的结构，那么 HTMLCleaner 值得一提。与 Jericho 一样，它没有提供一个完整的开箱即用的合并解决方案，但像 clean(<string html>) 这样的方法在清理输入方面表现良好。

使用 Web API 合并 HTML

在某些情况下，开源工具提供的控制权被需要编写的繁琐代码量所抵消。如果我们要避免增加更多的前期编码和后续调试时间，那么完全实现的转换 API 值得考虑。

为此，我们可以利用第三方 API 在 Java 中合并 HTML，使用下面提供的示例代码。这是一个免费使用的解决方案，但请注意，它需要 API 密钥授权，并且需要利用外部服务器资源来完成工作。

我们可以以两种不同的方式使用这个 API：1）将正好两个 HTML 文件合并在一起，2）将 2 个或更多 HTML 文件合并在一起。我们可以根据需要稍微调整 API 调用的结构。

在这两种情况下，我们都可以通过在 pom.xml 中添加对仓库的引用，使用 Maven 安装 Java SDK：

xml 复制代码

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

然后在 pom.xml 中添加对依赖项的引用：

xml 复制代码

<dependencies>
<dependency>
    <groupId>com.github.Cloudmersive</groupId>
    <artifactId>Cloudmersive.APIClient.Java</artifactId>
    <version>v4.25</version>
</dependency>
</dependencies>

对于 Gradle 项目，我们可以在根 build.gradle 文件的 repositories 部分末尾添加以下内容：

gradle 复制代码

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

然后在 build.gradle 中添加依赖项：

gradle 复制代码

dependencies {
        implementation 'com.github.Cloudmersive:Cloudmersive.APIClient.Java:v4.25'
}

安装完成后，将导入类的代码放在文件的顶部（暂时注释掉，以避免出现问题）：

java 复制代码

// Import classes:
//import com.cloudmersive.client.invoker.ApiClient;
//import com.cloudmersive.client.invoker.ApiException;
//import com.cloudmersive.client.invoker.Configuration;
//import com.cloudmersive.client.invoker.auth.*;
//import com.cloudmersive.client.MergeDocumentApi;

然后，我们可以使用 API 密钥配置 API 客户端：

java 复制代码

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Apikey
ApiKeyAuth Apikey = (ApiKeyAuth) defaultClient.getAuthentication("Apikey");
Apikey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.setApiKeyPrefix("Token");

之后，我们可以构建用于合并 2 个或 2 个以上文件的请求。对于只有 2 个文件的情况，可以使用以下代码：

java 复制代码

MergeDocumentApi apiInstance = new MergeDocumentApi();
File inputFile1 = new File("/path/to/inputfile"); // File | First input file to perform the operation on.
File inputFile2 = new File("/path/to/inputfile"); // File | Second input file to perform the operation on (more than 2 can be supplied).
try {
    byte[] result = apiInstance.mergeDocumentHtml(inputFile1, inputFile2);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MergeDocumentApi#mergeDocumentHtml");
    e.printStackTrace();
}

对于 2 个文件，我们可以改用以下代码：

java 复制代码

MergeDocumentApi apiInstance = new MergeDocumentApi();
File inputFile1 = new File("/path/to/inputfile"); // File | First input file to perform the operation on.
File inputFile2 = new File("/path/to/inputfile"); // File | Second input file to perform the operation on.
File inputFile3 = new File("/path/to/inputfile"); // File | Third input file to perform the operation on.
File inputFile4 = new File("/path/to/inputfile"); // File | Fourth input file to perform the operation on.
File inputFile5 = new File("/path/to/inputfile"); // File | Fifth input file to perform the operation on.
File inputFile6 = new File("/path/to/inputfile"); // File | Sixth input file to perform the operation on.
File inputFile7 = new File("/path/to/inputfile"); // File | Seventh input file to perform the operation on.
File inputFile8 = new File("/path/to/inputfile"); // File | Eighth input file to perform the operation on.
File inputFile9 = new File("/path/to/inputfile"); // File | Ninth input file to perform the operation on.
File inputFile10 = new File("/path/to/inputfile"); // File | Tenth input file to perform the operation on.
try {
    byte[] result = apiInstance.mergeDocumentHtmlMulti(inputFile1, inputFile2, inputFile3, inputFile4, inputFile5, inputFile6, inputFile7, inputFile8, inputFile9, inputFile10);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MergeDocumentApi#mergeDocumentHtmlMulti");
    e.printStackTrace();
}

我们可以将转换中生成的 byte[] 数组写入新的 HTML 文档，然后就完成了。

总结

在本文中，我们介绍了 HTML 合并的一些示例，并讨论了在 Java 中构建 HTML 合并应用程序相关的挑战。我们介绍了用于处理多种不同容量的 HTML 内容的常用开源 Java API，并研究了调用专门用于合并有效 HTML 的 API 的代码示例。