Java 实现 XML 转 JSON 详解

简介

在现代软件开发中，数据格式的转换是一项常见任务。XML（可扩展标记语言）和 JSON（JavaScript 对象表示法）是两种广泛使用的数据交换格式。XML 具有良好的结构化和自描述性，常用于配置文件和数据交换；JSON 则以其简洁性和易于解析的特点，在 Web 开发和移动应用中得到广泛应用。在 Java 开发中，将 XML 数据转换为 JSON 格式是一个常见需求，本文将详细介绍 Java 中实现 XML 转 JSON 的基础概念、使用方法、常见实践以及最佳实践。

基础概念

XML

XML 是一种用于存储和传输数据的标记语言，它使用标签来定义数据的结构。XML 文档由元素、属性和文本组成，具有良好的层次结构和自描述性。例如：

<book>
    <title>Java Programming</title>
    <author>John Doe</author>
    <year>2023</year>
</book>

JSON

JSON 是一种轻量级的数据交换格式，它使用键值对的方式来表示数据。JSON 数据可以是对象、数组、字符串、数字、布尔值或 null。例如，上述 XML 对应的 JSON 格式如下：

{
    "book": {
        "title": "Java Programming",
        "author": "John Doe",
        "year": "2023"
    }
}

XML 转 JSON 的意义

将 XML 转换为 JSON 可以使数据更易于在 Web 应用和移动应用中处理，因为 JSON 格式更简洁，且大多数现代编程语言都提供了内置的 JSON 解析库。此外，JSON 还可以更好地与 JavaScript 集成，方便前端开发。

使用方法

使用 JSON-java 库

JSON-java 是一个简单易用的 Java 库，用于处理 JSON 数据。它也提供了将 XML 转换为 JSON 的功能。

步骤

添加依赖

<dependency>
    <groupId>org.json</groupId>
    <artifactId>json</artifactId>
    <version>20231013</version>
</dependency>

代码示例

import org.json.JSONObject;
import org.json.XML;

public class XmlToJsonExample {
    public static void main(String[] args) {
        String xml = "<book><title>Java Programming</title><author>John Doe</author><year>2023</year></book>";
        JSONObject json = XML.toJSONObject(xml);
        System.out.println(json.toString(2));
    }
}

使用 Jackson 库

Jackson 是一个功能强大的 Java 库，用于处理 JSON 数据。它也可以用于将 XML 转换为 JSON。

步骤

添加依赖

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
    <version>2.15.2</version>
</dependency>

代码示例

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;

import java.io.IOException;

public class XmlToJsonWithJackson {
    public static void main(String[] args) throws IOException {
        String xml = "<book><title>Java Programming</title><author>John Doe</author><year>2023</year></book>";
        XmlMapper xmlMapper = new XmlMapper();
        JsonNode xmlNode = xmlMapper.readTree(xml);
        ObjectMapper jsonMapper = new ObjectMapper();
        String json = jsonMapper.writeValueAsString(xmlNode);
        System.out.println(json);
    }
}

常见实践

处理复杂 XML 结构

当 XML 结构复杂时，可能包含嵌套元素和数组。在转换为 JSON 时，需要确保数据的层次结构正确。

<library>
    <books>
        <book>
            <title>Java Programming</title>
            <author>John Doe</author>
            <year>2023</year>
        </book>
        <book>
            <title>Python Basics</title>
            <author>Jane Smith</author>
            <year>2022</year>
        </book>
    </books>
</library>

使用 JSON-java 库处理：

import org.json.JSONObject;
import org.json.XML;

public class ComplexXmlToJson {
    public static void main(String[] args) {
        String xml = "<library><books><book><title>Java Programming</title><author>John Doe</author><year>2023</year></book><book><title>Python Basics</title><author>Jane Smith</author><year>2022</year></book></books></library>";
        JSONObject json = XML.toJSONObject(xml);
        System.out.println(json.toString(2));
    }
}

处理 XML 命名空间

XML 命名空间用于避免元素和属性名称冲突。在转换为 JSON 时，需要处理命名空间。

<ns:book xmlns:ns="http://example.com/ns">
    <ns:title>Java Programming</ns:title>
    <ns:author>John Doe</ns:author>
    <ns:year>2023</ns:year>
</ns:book>