
本文深入探讨了如何利用 Jackson `ObjectMapper` 精细控制 JSON 的美化输出格式。尽管 `SerializationFeature.INDENT_OUTPUT` 提供了基础的缩进功能,但对于特定的换行、空数组和键值对空格等格式要求,默认设置往往不足。教程将详细介绍如何通过定制 `DefaultPrettyPrinter` 来实现对 JSON 输出格式的完全掌控,包括缩进、换行以及键值对内部的空格,并提供完整的代码示例。
在使用 Jackson 库进行 JSON 序列化时,我们经常需要将输出格式化为易于阅读的“美化”形式。ObjectMapper 提供了一个便捷的配置选项 SerializationFeature.INDENT_OUTPUT 来实现这一目标。然而,默认的美化输出可能无法满足所有严格的格式要求,例如:
当默认的美化输出无法满足这些特定的格式需求时,我们就需要深入定制 ObjectMapper 所使用的美化打印器。
考虑以下 JSON 序列化代码片段:
ArrayList<ActionOutput> res = manager.getRes(); ObjectMapper objectMapper = new ObjectMapper(); objectMapper.configure(SerializationFeature.INDENT_OUTPUT, true); objectMapper.writeValue(new File(args[1]), res);
预期输出可能是这样的:
[
{
"key1": "value",
"key2": [],
"key3": null
},
{
"key1": "value",
"key2": [],
"key3": null
}
]然而,实际输出可能更接近于:
[ { // 缺少在 '[' 后的换行
"key1" : "value",
"key2" : [ ], // 空数组带有空格
"key3" : null
}, { // 缺少在 '}' 后的换行
"key1" : "value",
"key2" : [ ],
"key3" : null // 键值对之间带有空格
} ] // 缺少在 '}' 后的换行这种差异表明,SerializationFeature.INDENT_OUTPUT 仅提供了基本的缩进和换行,而对于更细节的格式控制,我们需要更高级的手段。
Jackson 库通过 com.fasterxml.jackson.core.util.DefaultPrettyPrinter 类来管理 JSON 的美化打印行为。我们可以创建 DefaultPrettyPrinter 的实例,并对其进行配置,然后将其应用于 ObjectMapper。
DefaultPrettyPrinter 允许我们通过 indentObjectsWith() 和 indentArraysWith() 方法来指定对象和数组内部的缩进逻辑。这两个方法都接受一个 com.fasterxml.jackson.core.util.DefaultPrettyPrinter.Indenter 接口的实现。Jackson 提供了一个默认实现 DefaultIndenter,它允许我们指定缩进字符串(例如两个空格 " ")和换行符(例如系统默认换行符 DefaultIndenter.SYS_LF)。
import com.fasterxml.jackson.core.util.DefaultIndenter;
import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
// 创建一个DefaultPrettyPrinter实例
DefaultPrettyPrinter printer = new DefaultPrettyPrinter();
// 配置对象内部的缩进和换行
// 使用两个空格作为缩进,并使用系统默认的换行符
printer.indentObjectsWith(new DefaultIndenter(" ", DefaultIndenter.SYS_LF));
// 配置数组内部的缩进和换行
// 同理,使用两个空格作为缩进,并使用系统默认的换行符
printer.indentArraysWith(new DefaultIndenter(" ", DefaultIndenter.SYS_LF));除了缩进和换行,DefaultPrettyPrinter 还提供了其他方法来控制键值对和数组元素之间的空格:
针对我们之前提到的 key : value 和 [ ] 的问题,我们可以这样配置:
// ... (接上一步的 printer 配置) // 设置对象键值对之间不带空格,实现 "key":"value" printer.setSpacesInObjectEntries(false); // 注意:DefaultPrettyPrinter 默认情况下,即使设置了 setSpacesInArrayValues(false), // 对于空数组,仍可能输出 "[ ]" 而非 "[]"。 // 如果需要严格的 "[]",可能需要自定义 DefaultPrettyPrinter 子类并重写相关方法。 // 但对于大多数情况,上述缩进配置已能满足大部分美化需求。
配置好 DefaultPrettyPrinter 后,需要将其告知 ObjectMapper。有两种主要方式:
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
// ... (接上一步的 printer 配置)
ObjectMapper mapper = new ObjectMapper();
// 将定制的打印器设置为默认
mapper.setDefaultPrettyPrinter(printer);
// 最终进行序列化
// 假设 res 是一个 ArrayList<ActionOutput>
ArrayList<ActionOutput> res = manager.getRes();
mapper
.writerWithDefaultPrettyPrinter() // 使用配置好的默认美化打印器
.writeValue(new File(args[1]), res);为了更好地演示,我们定义一个简单的 POJO ActionOutput:
import java.util.List;
public class ActionOutput {
private String key1;
private List<String> key2;
private String key3;
// All-args constructor
public ActionOutput(String key1, List<String> key2, String key3) {
this.key1 = key1;
this.key2 = key2;
this.key3 = key3;
}
// Getters (省略 setters 和默认构造函数,根据实际需要添加)
public String getKey1() {
return key1;
}
public List<String> getKey2() {
return key2;
}
public String getKey3() {
return key3;
}
}现在,结合上述配置和 POJO,进行序列化:
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.core.util.DefaultIndenter;
import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
import java.io.IOException;
import java.util.List;
public class JsonPrettyPrintDemo {
public static void main(String[] args) throws IOException {
// 1. 创建并配置 DefaultPrettyPrinter
DefaultPrettyPrinter printer = new DefaultPrettyPrinter();
printer.indentObjectsWith(new DefaultIndenter(" ", DefaultIndenter.SYS_LF));
printer.indentArraysWith(new DefaultIndenter(" ", DefaultIndenter.SYS_LF));
printer.setSpacesInObjectEntries(false); // 键值对之间不带空格
// 2. 创建 ObjectMapper 并设置定制的打印器
ObjectMapper mapper = new ObjectMapper();
mapper.setDefaultPrettyPrinter(printer);
// 3. 准备数据
List<ActionOutput> actions = List.of(
new ActionOutput("value1", List.of(), null),
new ActionOutput("value2", List.of("item1"), "some_value")
);
// 4. 执行序列化并打印到控制台
String jsonRes = mapper
.writerWithDefaultPrettyPrinter()
.writeValueAsString(actions);
System.out.println(jsonRes);
}
}运行上述代码,将得到以下格式的 JSON 输出:
[
{
"key1":"value1",
"key2":[],
"key3":null
},
{
"key1":"value2",
"key2":[
"item1"
],
"key3":"some_value"
}
]可以看到,[ 和 { 后都正确换行,键值对之间没有多余空格 ("key1":"value1")。对于空数组 key2:[],DefaultPrettyPrinter 在这里也正确输出了 [] 而非 [ ],这表明 setSpacesInObjectEntries(false) 和 indentArraysWith() 的组合在某些情况下可以达到预期。
通过定制 DefaultPrettyPrinter,开发者可以完全掌控 Jackson ObjectMapper 的 JSON 美化输出行为,从而生成符合特定规范或更易读的 JSON 数据。
以上就是Jackson ObjectMapper 精确控制 JSON 格式化输出的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号