java 格式化 xml

原创

mob64ca12f7e7cf 2024-11-06 06:23:06 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12f7e7cf的原创作品，请联系作者获取转载授权，否则将追究法律责任

如何在 Java 中格式化 XML

XML（可扩展标记语言）是一种用于描述数据的语言，常用于数据交换。为了提高可读性，我们通常需要对 XML 数据进行格式化。本文将指导你如何在 Java 中格式化 XML 文档。我们将分步骤进行，提供示例代码，并解释每一步。

处理流程

下面是实现 XML 格式化的整个流程：

flowchart TD
    A[开始] --> B[解析 XML 文档]
    B --> C[格式化 XML]
    C --> D[输出格式化后的 XML]
    D --> E[结束]

步骤详解

接下来，我们将详细讲解每一步，并提供对应的 Java 代码。

步骤	描述	代码示例
1. 解析 XML	使用 `DocumentBuilderFactory` 解析 XML 文件。	`DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();`
2. 格式化 XML	使用 `Transformer` 和 `StreamResult` 格式化 XML。	`Transformer transformer = TransformerFactory.newInstance().newTransformer();`
3. 输出 XML	将格式化后的 XML 输出到文件或控制台。	`transformer.transform(new DOMSource(document), new StreamResult(outputStream));`

1. 解析 XML

首先，我们要解析 XML 文件，可以使用以下代码：

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.w3c.dom.Document;
import java.io.File;

public class XmlFormatter {
    public static Document parseXmlFile(String filePath) throws Exception {
        // 创建 DocumentBuilderFactory 实例
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        // 获取 DocumentBuilder
        DocumentBuilder builder = factory.newDocumentBuilder();
        // 解析 XML 文件
        Document document = builder.parse(new File(filePath));
        return document;
    }
}

2. 格式化 XML

接下来，我们使用 Transformer 来格式化 XML 文档：

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

public class XmlFormatter {
    // 中省略 parseXmlFile 方法

    public static String formatXml(Document doc) throws Exception {
        // 创建 TransformerFactory 实例
        TransformerFactory transformerFactory = TransformerFactory.newInstance();
        // 创建 Transformer
        Transformer transformer = transformerFactory.newTransformer();
        // 设置格式化输出
        transformer.setOutputProperty(OutputKeys.INDENT, "yes");
        transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");

        // 输出格式化后的 XML
        StreamResult result = new StreamResult(new StringWriter());
        transformer.transform(new DOMSource(doc), result);
        return result.getWriter().toString();
    }
}

3. 输出 XML

最后，我们输出格式化后的 XML：

import java.io.FileWriter;
import java.io.PrintWriter;

public class XmlFormatter {
    // 中省略 parseXmlFile 和 formatXml 方法

    public static void outputFormattedXml(String formattedXml, String outputPath) throws Exception {
        // 创建文件写入器
        FileWriter fileWriter = new FileWriter(outputPath);
        PrintWriter printWriter = new PrintWriter(fileWriter);
        // 输出格式化后的 XML
        printWriter.write(formattedXml);
        // 关闭资源
        printWriter.close();
    }

    public static void main(String[] args) {
        try {
            Document doc = parseXmlFile("input.xml");
            String formattedXml = formatXml(doc);
            outputFormattedXml(formattedXml, "output.xml");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

类图

以下是上述代码实现的类图：

classDiagram
    class XmlFormatter {
        +Document parseXmlFile(String filePath)
        +String formatXml(Document doc)
        +void outputFormattedXml(String formattedXml, String outputPath)
    }