java如何将json格式化

Java JSON格式化：从基础到实践，让你的数据更易读**

在Java开发中，JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，被广泛应用于前后端数据交互、配置文件存储等场景，未经格式化的JSON字符串往往是压缩在一行的，可读性极差，尤其在调试或查看复杂JSON数据时，会给开发者带来很大困扰，如何在Java中将JSON进行格式化（美化输出）是一项非常实用的技能,本文将详细介绍几种在Java中格式化JSON的常用方法。

为什么需要格式化JSON？

1. 提高可读性：格式化后的JSON具有清晰的缩进和换行,人类可以轻松阅读和理解数据结构。
2. 便于调试：在日志输出或开发工具中查看格式化的JSON,能更快地定位数据问题。
3. 便于编辑：如果需要手动修改JSON文件,格式化后的文本更易于编辑。

Java中格式化JSON的常用方法

Java中处理JSON的库有很多，其中最常用的是Jackson、Gson和org.json,下面我们将分别介绍如何使用这些库来格式化JSON。

使用Jackson库

Jackson是Java生态中最流行、功能强大的JSON处理库之一,它提供了简洁的API来处理JSON数据。

添加依赖

如果你使用Maven，在pom.xml中添加：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.15.2</version> <!-- 请使用最新版本 -->
</dependency>

如果你使用Gradle，在build.gradle中添加：

implementation 'com.fasterxml.jackson.core:jackson-databind:2.15.2' // 请使用最新版本

格式化JSON

Jackson的ObjectMapper类提供了writerWithDefaultPrettyPrinter()方法,可以轻松实现JSON的格式化输出。

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
public class JacksonJsonFormatter {
    public static String formatJson(String jsonString) {
        ObjectMapper objectMapper = new ObjectMapper();
        try {
            // 将JSON字符串解析为Object
            Object jsonObject = objectMapper.readValue(jsonString, Object.class);
            // 启用美化输出
            objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
            // 将Object格式化为JSON字符串
            return objectMapper.writeValueAsString(jsonObject);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
            return "格式化JSON失败: " + e.getMessage();
        }
    }
    public static void main(String[] args) {
        String unformattedJson = "{\"name\":\"张三\",\"age\":30,\"isStudent\":false,\"courses\":[\"数学\",\"语文\"],\"address\":{\"city\":\"北京\",\"district\":\"海淀\"}}";
        System.out.println("未格式化的JSON:");
        System.out.println(unformattedJson);
        System.out.println("\n格式化后的JSON:");
        String formattedJson = formatJson(unformattedJson);
        System.out.println(formattedJson);
    }
}

输出示例：

未格式化的JSON:
{"name":"张三","age":30,"isStudent":false,"courses":["数学","语文"],"address":{"city":"北京","district":"海淀"}}
格式化后的JSON:
{
  "name" : "张三",
  "age" : 30,
  "isStudent" : false,
  "courses" : [ "数学", "语文" ],
  "address" : {
    "city" : "北京",
    "district" : "海淀"
  }
}

使用Gson库

Google的Gson是另一个广泛使用的JSON处理库,它同样提供了便捷的JSON格式化方法。

添加依赖

Maven (pom.xml):

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.10.1</version> <!-- 请使用最新版本 -->
</dependency>

Gradle (build.gradle):

implementation 'com.google.code.gson:gson:2.10.1' // 请使用最新版本

格式化JSON

Gson的GsonBuilder类可以配置setPrettyPrinting()来实现美化输出。

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
public class GsonJsonFormatter {
    public static String formatJson(String jsonString) {
        Gson gson = new GsonBuilder().setPrettyPrinting().create();
        JsonParser jp = new JsonParser();
        JsonElement je = jp.parse(jsonString);
        return gson.toJson(je);
    }
    public static void main(String[] args) {
        String unformattedJson = "{\"name\":\"李四\",\"age\":25,\"isStudent\":true,\"courses\":[\"英语","编程\"],\"address\":{\"city":"上海","district":"浦东\"}}";
        System.out.println("未格式化的JSON:");
        System.out.println(unformattedJson);
        System.out.println("\n格式化后的JSON:");
        String formattedJson = formatJson(unformattedJson);
        System.out.println(formattedJson);
    }
}

输出示例： （与方法一类似,输出格式化的JSON字符串）

使用org.json库

org.json是一个轻量级的JSON处理库，虽然功能相对前两者简单,但也足够应对基本的JSON处理和格式化需求。

添加依赖

Maven (pom.xml):

<dependency>
    <groupId>org.json</groupId>
    <artifactId>json</artifactId>
    <version>20231013</version> <!-- 请使用最新版本 -->
</dependency>

Gradle (build.gradle):

implementation 'org.json:json:20231013' // 请使用最新版本

格式化JSON

org.json的JSONObject和JSONArray类在转换为字符串时,可以通过构造函数或方法指定缩进。

import org.json.JSONObject;
public class OrgJsonFormatter {
    public static String formatJson(String jsonString) {
        try {
            JSONObject jsonObject = new JSONObject(jsonString);
            // 第二个参数是缩进空格数
            return jsonObject.toString(2);
        } catch (Exception e) {
            e.printStackTrace();
            return "格式化JSON失败: " + e.getMessage();
        }
    }
    public static void main(String[] args) {
        String unformattedJson = "{\"name\":\"王五\",\"age\":28,\"isStudent\":false,\"courses\":[\"物理","化学\"],\"address\":{\"city":"广州","district":"天河\"}}";
        System.out.println("未格式化的JSON:");
        System.out.println(unformattedJson);
        System.out.println("\n格式化后的JSON:");
        String formattedJson = formatJson(unformattedJson);
        System.out.println(formattedJson);
    }
}

输出示例： （与方法一类似，输出格式化的JSON字符串,缩进为2个空格）

总结与选择

如何选择？

• 如果你的项目已经使用了Spring框架，或者需要处理复杂的JSON数据映射、流式读写等，Jackson是首选。
• 如果你需要一个简单易用、文档清晰的JSON库，或者项目与Google其他技术栈结合紧密，Gson是非常好的选择。
• 如果你只需要进行简单的JSON解析、构建和格式化，不希望引入过多的依赖，org.json的轻量级特性会很有吸引力。

注意事项

1. 异常处理：JSON字符串可能格式不正确，解析时需要进行异常捕获（如JsonProcessingException、JsonSyntaxException等）。
2. 性能考虑：对于特别大的JSON文件，格式化（尤其是INDENT_OUTPUT）可能会消耗较多内存和时间,需要权衡。
3. 版本更新：JSON库的API可能会随着版本更新而变化,建议使用稳定的最新版本。

通过以上方法，你可以轻松地在Java中将JSON数据进行格式化