如何在Java中使用org.json和JSON-B解析与编写JSON_Java

前言

json（javascript object notation）因其轻量、语言无关且易于读写的特性，已成为现代 web 应用中数据交换的标准格式。在 java 中，处理 json 的库众多，其中 org.json 和 json-b 是两种流行的选择。本文将深入探讨这两种库的特点、使用示例、优缺点以及适用场景，帮助开发者根据项目需求选择合适的工具。

1. json 在 java 中的重要性

json 是一种基于文本的数据格式，源自 javascript 编程语言（ecma-262 第 3 版）。它支持两种主要结构：

对象：键值对集合，通常用大括号 {} 表示。
数组：有序值列表，用方括号 [] 表示。

json 的简单性和跨语言兼容性使其成为 api 数据传输和配置文件存储的理想选择。在 java 中，处理 json 需要专门的库来解析 json 字符串并将其转换为 java 对象，或将 java 对象序列化为 json 字符串。本文将重点介绍 org.json 和 json-b 两种库。

2. org.json 概述

org.json（也称为 json-java）是一个轻量级的 java 库，广泛用于 json 数据的解析和生成。它在 android 开发中尤为流行，因为它是 android 平台的默认 json 库。该库提供核心类如 jsonobject 和 jsonarray，用于处理 json 对象和数组。

2.1 org.json 的特点

简单 api：易于上手，适合基本的 json 操作。
解析功能：支持从字符串、输入流或读取器解析 json。
序列化：允许从 java 数据创建 json 对象和数组。
格式转换：支持 json 与 xml、http 头、cookie 等格式的转换。
无依赖：无需外部库，适合轻量级项目。

2.2 使用示例

以下是使用 org.json 解析和编写 json 的示例代码。

解析 json

以下代码展示如何从 json 文件中读取数据并提取特定字段：

public class softwareparseorgjson {
    final static string file_name = "/json/softwareinfo.json";

    public static void main(string[] args) throws exception {
        inputstream jsoninput = softwareparseorgjson.class.getresourceasstream(file_name);
        if (jsoninput == null) {
            throw new nullpointerexception("can't find" + file_name);
        }
        jsonobject obj = new jsonobject(new jsontokener(jsoninput));
        system.out.println("software name: " + obj.getstring("name"));
        system.out.println("version: " + obj.getstring("version"));
        system.out.println("description: " + obj.getstring("description"));
        system.out.println("class: " + obj.getstring("classname"));
        jsonarray contribs = obj.getjsonarray("contributors");
        for (int i = 0; i < contribs.length(); i++) {
            system.out.println("contributor name: " + contribs.get(i));
        }
    }
}

输出：

software name: robinparse
version: 1.2.3
description: another parser for json
class: robinparse
contributor name: robin smythe
contributor name: jon jenz
contributor name: jan ardann

此代码通过 jsontokener 从输入流创建 jsonobject，然后使用 getstring 和 getjsonarray 方法提取字段。注意，jsonarray 不支持 iterable，因此需要使用传统 for 循环遍历。

编写 json

以下代码展示如何创建 json 对象并将其转换为字符串：

.concurrenthashmap

public class writeorgjson {
    public static void main(string[] args) {
        jsonobject jsonobject = new jsonobject();
        jsonobject.put("name", "robinparse")
                  .put("version", "1.2.3")
                  .put("class", "robinparse");
        string printable = jsonobject.tostring();
        system.out.println(printable);
    }
}

输出：

{"name":"robinparse","class":"robinparse","version":"1.2.3"}

此代码利用 jsonobject 的流式 api（支持方法链式调用）添加键值对，并通过 tostring 方法生成格式化的 json 字符串。

2.3 org.json 的优缺点

优点	缺点
api 简单，易于快速上手	功能较少，缺乏高级映射支持
无外部依赖，轻量级	不如 jackson 等库强大
广泛用于 android 开发	定制化能力有限

3. json-b 概述

json-b（json binding）是 java api for json binding（jsr-367），是 jakarta ee 平台的一部分。它旨在通过自动映射简化 java 对象与 json 数据之间的转换。json-b 的参考实现是 yasson，它还被纳入 eclipse microprofile 项目。

3.1 json-b 的特点

标准 api：确保跨实现的可移植性。
自动映射：无需手动解析，支持 java 对象与 json 的双向转换。
定制化：通过注解支持灵活的映射配置。
企业级支持：集成于 jakarta ee，适合复杂应用。
易用性：方法命名直观，减少开发工作量。

3.2 使用示例

以下是使用 json-b 读取和编写 json 的示例代码。

读取和编写 json

以下代码展示如何将 json 字符串转换为 java 对象并反向序列化：

public class readwritejsonb {
    public static void main(string[] args) throws ioexception {
        jsonb jsonb = jsonbbuilder.create();
        // 读取
        string jsoninput = "{\"id\":0,\"firstname\":\"robin\",\"lastname\":\"williams\"}";
        person rw = jsonb.fromjson(jsoninput, person.class);
        system.out.println(rw);
        // 编写
        string result = jsonb.tojson(rw);
        system.out.println(result);
    }
}

输出（假设 person 类有适当的 tostring 方法）：

person{id=0, firstname=robin, lastname=williams}
{"firstname":"robin","id":0,"lastname":"williams"}

此代码通过 jsonbbuilder 创建 jsonb 实例，使用 fromjson 将 json 字符串转换为 person 对象，再通过 tojson 将对象转换回 json 字符串。默认情况下，person 类无需注解即可工作。

定制化示例

json-b 支持通过注解定制映射。例如，排除冗余字段：

public class person {
    private int id;
    private string firstname;
    private string lastname;

    @jsonbtransient
    public string getfullname() {
        return firstname + " " + lastname;
    }
    //  getter 和 setter...
}

运行上述代码后，输出将不包含 fullname 字段：

{"firstname":"robin","id":0,"lastname":"williams"}

通过 @jsonbtransient 注解，getfullname 方法的返回值被排除在 json 输出之外，从而减少数据冗余。

3.3 json-b 的优缺点

优点	缺点
标准 api，跨平台一致性	需要 jakarta ee 环境
自动映射，开发效率高	对于简单任务可能过于复杂
支持高级定制化	依赖外部库

4. org.json 与 json-b 的比较

以下是对 org.json 和 json-b 的详细比较：

特性	org.json	json-b
标准化	非标准，但广泛使用	标准 api（jsr-367）
易用性	适合简单操作	自动映射，开发更高效
定制化	有限	通过注解支持广泛定制
性能	适合中小型数据	优化用于大型数据集
依赖	无需外部依赖	需要 jakarta ee 或类似环境
适用场景	通用 json 解析/编写	java 对象与 json 绑定

5. 适用场景

使用 org.json 的场景：
- 需要轻量级、无依赖的 json 处理库。
- 在 android 项目中进行简单 json 操作。
- 项目对高级功能需求较低。
使用 json-b 的场景：
- 在 jakarta ee 或 microprofile 环境中开发企业级应用。
- 需要标准化的 json 绑定 api。
- 项目要求复杂的对象映射和定制化。

6. 结论

org.json 和 json-b 都是 java 中处理 json 的强大工具，各自适用于不同场景。org.json 因其简单性和无依赖特性，适合轻量级项目和 android 开发；而 json-b 作为标准 api，提供自动映射和高级定制功能，适合企业级应用。开发者应根据项目需求（如环境、复杂性和标准化要求）选择合适的库。

通过理解这两种库的优缺点，您可以为您的 java 项目选择最佳的 json 处理方案。