【工具】使用 Jackson 实现优雅的 JSON 格式化输出

说明

在 Java 开发中，我们经常需要处理 JSON 数据。无论是从服务器端返回的数据，还是本地存储的数据，JSON 格式都因其轻量级和易于解析的特点而被广泛使用。当我们需要查看或调试 JSON 数据时，优雅、格式化的输出将大大提高我们的工作效率。这里使用 Jackson 工具库来实现 JSON 字符串的格式化输出。
Jackson 是一个高效的 Java JSON 处理库，广泛用于 Java 企业级应用。它支持对象与 JSON 字符串之间的相互转换，拥有高效的性能和良好的兼容性。在处理 JSON 数据时，Jackson 还能提供许多有用的功能，比如自定义序列化和反序列化、数据格式化输出等。

代码

        <dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.7.4</version></dependency><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-core</artifactId><version>2.7.4</version></dependency><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-annotations</artifactId><version>2.7.4</version></dependency>

import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;public class JsonFormatter {public static void main(String[] args) throws IOException {// 已知一个 JSON 字符串String json = "{\"name\":\"zhangSan\",\"age\":23,\"address\":\"anhui\"}";// 创建 ObjectMapper 对象ObjectMapper mapper = new ObjectMapper();// 将 JSON 字符串解析为 Java 对象Object obj = mapper.readValue(json, Object.class);// 使用默认的 PrettyPrinter 格式化输出 JSON 字符串String prettyJson = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(obj);// 输出格式化后的 JSON 字符串System.out.println(prettyJson);}
}

代码详解

ObjectMapper 的使用：ObjectMapper 是 Jackson 库中用于 JSON 处理的核心类。我们使用它将 JSON 字符串解析为 Java 对象，或者将 Java 对象转换为 JSON 字符串。
readValue 方法：readValue 方法用于将 JSON 字符串解析为指定类型的 Java 对象。在这个例子中，我们将 JSON 字符串转换为通用的 Object 对象。
writerWithDefaultPrettyPrinter 方法：这个方法返回一个配置了默认“漂亮打印机”的 ObjectWriter，用于将 JSON 对象格式化为漂亮的字符串。
writeValueAsString 方法：该方法将 Java 对象转换为 JSON 字符串，在这个例子中是格式化的输出。