如何使用Java中的javax.json API对JSON进行漂亮的打印？

1. 概述

JSON（JavaScript Object Notation）是一种非常流行的轻量级数据交换格式，它的设计目标是将数据易于读写和解析。在Java中，我们通常使用JSON来表示和处理数据。

在Java 8中，Java API for JSON Processing (javax.json) 已经被引入，它提供了一个标准API用于解析、生成和操作JSON。在本篇文章中，我们将重点介绍如何使用javax.json API对JSON进行漂亮的打印。

2. 打印未格式化的JSON

在处理JSON数据时，我们通常需要查看它的格式以进行调试或测试。默认情况下，javax.json API不会漂亮地打印JSON数据，这使得难以阅读和理解。下面是一个未格式化的JSON对象：

{

    "name": "John Smith",
    "age": 30,
    "is_married": false,
    "hobbies": ["reading", "traveling", "sports"],
    "address": {
        "city": "New York",
        "state": "NY",
        "zip_code": "10001"
    }
}

我们可以使用javax.json API中的JsonObject.toString()方法来将JSON对象转换为字符串。默认情况下，该方法不会漂亮地打印JSON。

以下是打印未格式化的JSON的示例代码：

import javax.json.Json;

import javax.json.JsonObject;
public class JsonPrinter {
    public static void main(String[] args) {
        JsonObject json = Json.createObjectBuilder()
                .add("name", "John Smith")
                .add("age", 30)
                .add("is_married", false)
                .add("hobbies", Json.createArrayBuilder()
                        .add("reading")
                        .add("traveling")
                        .add("sports")
                        .build())
                .add("address", Json.createObjectBuilder()
                        .add("city", "New York")
                        .add("state", "NY")
                        .add("zip_code", "10001")
                        .build())
                .build();
        String jsonString = json.toString();
        System.out.println(jsonString);
    }
}

运行上面的程序将输出以下未格式化的JSON：

{"name":"John Smith","age":30,"is_married":false,"hobbies":["reading","traveling","sports"],"address":{"city":"New York","state":"NY","zip_code":"10001"}}

由于这个JSON没有进行任何格式化，所以它看起来很混乱，很难阅读和理解。

3. 打印格式化的JSON

为了更好地阅读和理解JSON数据，我们可以使用javax.json API中的JsonWriter类和相应的设置来打印格式化的JSON。JsonWriter类提供了几个设置，允许我们定义输出格式。

以下是我们如何打印格式化的JSON的示例代码：

import javax.json.Json;

import javax.json.JsonObject;
import javax.json.JsonWriter;
import javax.json.stream.JsonGenerator;
import java.io.StringWriter;
public class JsonPrinter {
    public static void main(String[] args) {
        JsonObject json = Json.createObjectBuilder()
                .add("name", "John Smith")
                .add("age", 30)
                .add("is_married", false)
                .add("hobbies", Json.createArrayBuilder()
                        .add("reading")
                        .add("traveling")
                        .add("sports")
                        .build())
                .add("address", Json.createObjectBuilder()
                        .add("city", "New York")
                        .add("state", "NY")
                        .add("zip_code", "10001")
                        .build())
                .build();
        StringWriter stringWriter = new StringWriter();
        try (JsonWriter jsonWriter = Json.createWriterFactory(
                JsonGenerator.PRETTY_PRINTING).createWriter(stringWriter)) {
            jsonWriter.writeObject(json);
        }
        String jsonString = stringWriter.toString();
        System.out.println(jsonString);
    }
}

在上述代码中，我们创建了一个JsonWriter实例，指定了生成格式化输出的方式（JsonGenerator.PRETTY_PRINTING）。接着，我们将JSON对象写入输出流，并将输出流转换为字符串。最后，我们打印格式化的JSON字符串。

运行上面的程序将输出以下格式化的JSON：

{

    "name": "John Smith",
    "age": 30,
    "is_married": false,
    "hobbies": [
        "reading",
        "traveling",
        "sports"
    ],
    "address": {
        "city": "New York",
        "state": "NY",
        "zip_code": "10001"
    }
}

由于我们设置了JsonGenerator.PRETTY_PRINTING，每个元素都按照缩进的格式打印，从而使JSON数据易于阅读和理解。

4. 自定义格式化设置

JsonWriter提供了多个方法来定制格式化设置。例如，我们可以使用indent()方法指定每个级别缩进的空格数。

以下是如何自定义格式化设置的示例代码：

import javax.json.Json;

import javax.json.JsonObject;
import javax.json.JsonWriter;
import javax.json.stream.JsonGenerator;
import java.io.StringWriter;
public class JsonPrinter {
    public static void main(String[] args) {
        JsonObject json = Json.createObjectBuilder()
                .add("name", "John Smith")
                .add("age", 30)
                .add("is_married", false)
                .add("hobbies", Json.createArrayBuilder()
                        .add("reading")
                        .add("traveling")
                        .add("sports")
                        .build())
                .add("address", Json.createObjectBuilder()
                        .add("city", "New York")
                        .add("state", "NY")
                        .add("zip_code", "10001")
                        .build())
                .build();
        StringWriter stringWriter = new StringWriter();
        JsonGenerator generator = Json.createGeneratorFactory(null)
                .createGenerator(stringWriter)
                .writeStartObject()
                .setIndent(" ")
                .write("name", json.getString("name"))
                .write("age", json.getInt("age"))
                .write("is_married", json.getBoolean("is_married"))
                .writeStartArray("hobbies");
        for (String hobby : json.getJsonArray("hobbies").getValuesAs(String.class)) {
            generator.write(hobby);
        }
        generator.writeEnd()
                .writeStartObject("address")
                .setIndent("\t")
                .write("city", json.getJsonObject("address").getString("city"))
                .write("state", json.getJsonObject("address").getString("state"))
                .write("zip_code", json.getJsonObject("address").getString("zip_code"))
                .writeEnd()
                .writeEnd()
                .close();
        String jsonString = stringWriter.toString();
        System.out.println(jsonString);
    }
}

在上面的代码中，我们创建了一个缓冲区（StringWriter），以及使用JsonGenerator实例添加JSON数据。

我们使用setIndent()方法指定每个级别缩进的空格数。在开始数组和对象时，我们可以使用writeStartArray()和writeStartObject()方法来指定每个元素的缩进级别。使用writeEnd()方法来结束数组和对象。最后，我们在关闭JsonGenerator时调用close()方法。

运行上面的程序将输出以下自定义格式化设置的JSON：

{

 "name": "John Smith",
 "age": 30,
 "is_married": false,
 "hobbies": [
  "reading",
  "traveling",
  "sports"
 ],
 "address": {
        "city": "New York",
  "state": "NY",
  "zip_code": "10001"
 }
}

通过使用这些自定义格式化设置，我们可以更好地控制JSON字符串的格式并更容易地读取和理解它。

5. 结论

在本文中，我们学习了如何使用javax.json API来打印格式化JSON。我们看到了如何使用JsonWriter类自定义格式化设置，以及如何在JSON对象上添加缩进。我们还学习了如何使用JsonGenerator类构建JSON数据。

打印格式化的JSON对于调试和测试非常有用。它可以帮助您更好地理解和阅读JSON对象。