在 Jackson ObjectMapper 上配置缩进间距的最简单方法是什么?
What is the simplest way to configure the indentation spacing on a Jackson ObjectMapper?
在解决这个问题时,我真的很难理解我所感受到的复杂程度。正如标题所说:用4-spacePrettyPrinter
创建JacksonObjectMapper
的简单方法是什么?
加分:我如何修改现有的 ObjectMapper
使其漂亮打印 4 spaces?
通过我的研究,我发现最简单的方法是启用漂亮的打印,通常是在映射器上设置 INDENT_OUTPUT
:
objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
但是,这只会启用 DefaultPrettyPrinter
,它有 2 space 的缩进。我想要 4。为此,似乎我必须构建自己的 ObjectMapper
,提供 JsonFactory
和 JsonGenerator
,PrettyPrinter
执行 4 space秒。对于在其他平台上如此简单的东西来说,这太激烈了。请告诉我有更简单的方法。
我不确定这是否是最简单的方法,但是...您可以将ObjectMapper
与自定义打印机结合使用。如果您修改缩进行为,则可以使用 DefaultPrettyPrinter
。
// Create the mapper
ObjectMapper mapper = new ObjectMapper();
// Setup a pretty printer with an indenter (indenter has 4 spaces in this case)
DefaultPrettyPrinter.Indenter indenter =
new DefaultIndenter(" ", DefaultIndenter.SYS_LF);
DefaultPrettyPrinter printer = new DefaultPrettyPrinter();
printer.indentObjectsWith(indenter);
printer.indentArraysWith(indenter);
// Some object to serialize
Map<String, Object> value = new HashMap<>();
value.put("foo", Arrays.asList("a", "b", "c"));
// Serialize it using the custom printer
String json = mapper.writer(printer).writeValueAsString(value);
// Print it
System.out.println(json);
输出将是:
{
"foo" : [
"a",
"b",
"c"
]
}
如果您打算像我一样编写多个对象,以便在 IntelliJ(具有非常好的多行比较工具)中的 JUnit 测试中进行 JSON 比较 运行:
// could likely be simplified to `new ObjectMapper().writer(new DefaultPrettyPrinter())`
ObjectWriter writer = new ObjectMapper()
.setDefaultPrettyPrinter(new DefaultPrettyPrinter())
.writerWithDefaultPrettyPrinter();
try {
String expected = writer.writeValueAsString(testCase.getThing());
String actual = writer.writeValueAsString(actual.getThing());
assertEquals(expected, actual);
} catch (JsonProcessingException e) {
fail("JSON exception: " + e.toString());
}
这样做非常简单,您不需要实施任何 interface/Abstract Class。
仅创建一个新打印机并将其用作映射器编写器的参数:
ObjectMapper mapper = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT);
DefaultPrettyPrinter printer = new DefaultPrettyPrinter().withObjectIndenter(new DefaultIndenter(" ", "\n"));
String json = mapper.writer(printer).writeValueAsString(result);
基于非常有帮助的@wassgren 回答,以及对@Kervvv 问题的回答,我给你我对这个问题的回答:
我稍微改进了解决方案以满足我的要求
- 没有space,字段名后
- 空数组的方括号之间没有 space
你至少需要 Jackson 2.9
public class MyPrettyPrinter extends DefaultPrettyPrinter {
public MyPrettyPrinter() {
DefaultPrettyPrinter.Indenter indenter = new DefaultIndenter(" ", System.getProperty("line.separator"));
indentObjectsWith(indenter);
indentArraysWith(indenter);
_objectFieldValueSeparatorWithSpaces = ": ";
}
private MyPrettyPrinter(MyPrettyPrinter pp) {
super(pp);
}
@Override
public void writeEndArray(JsonGenerator g, int nrOfValues) throws IOException {
if (!_arrayIndenter.isInline()) {
--_nesting;
}
if (nrOfValues > 0) {
_arrayIndenter.writeIndentation(g, _nesting);
}
g.writeRaw(']');
}
@Override
public DefaultPrettyPrinter createInstance() {
return new MyPrettyPrinter(this);
}
}
和用法
mapper.writer(new MyPrettyPrinter()).writeValueAsString(value);
在解决这个问题时,我真的很难理解我所感受到的复杂程度。正如标题所说:用4-spacePrettyPrinter
创建JacksonObjectMapper
的简单方法是什么?
加分:我如何修改现有的 ObjectMapper
使其漂亮打印 4 spaces?
通过我的研究,我发现最简单的方法是启用漂亮的打印,通常是在映射器上设置 INDENT_OUTPUT
:
objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
但是,这只会启用 DefaultPrettyPrinter
,它有 2 space 的缩进。我想要 4。为此,似乎我必须构建自己的 ObjectMapper
,提供 JsonFactory
和 JsonGenerator
,PrettyPrinter
执行 4 space秒。对于在其他平台上如此简单的东西来说,这太激烈了。请告诉我有更简单的方法。
我不确定这是否是最简单的方法,但是...您可以将ObjectMapper
与自定义打印机结合使用。如果您修改缩进行为,则可以使用 DefaultPrettyPrinter
。
// Create the mapper
ObjectMapper mapper = new ObjectMapper();
// Setup a pretty printer with an indenter (indenter has 4 spaces in this case)
DefaultPrettyPrinter.Indenter indenter =
new DefaultIndenter(" ", DefaultIndenter.SYS_LF);
DefaultPrettyPrinter printer = new DefaultPrettyPrinter();
printer.indentObjectsWith(indenter);
printer.indentArraysWith(indenter);
// Some object to serialize
Map<String, Object> value = new HashMap<>();
value.put("foo", Arrays.asList("a", "b", "c"));
// Serialize it using the custom printer
String json = mapper.writer(printer).writeValueAsString(value);
// Print it
System.out.println(json);
输出将是:
{
"foo" : [
"a",
"b",
"c"
]
}
如果您打算像我一样编写多个对象,以便在 IntelliJ(具有非常好的多行比较工具)中的 JUnit 测试中进行 JSON 比较 运行:
// could likely be simplified to `new ObjectMapper().writer(new DefaultPrettyPrinter())`
ObjectWriter writer = new ObjectMapper()
.setDefaultPrettyPrinter(new DefaultPrettyPrinter())
.writerWithDefaultPrettyPrinter();
try {
String expected = writer.writeValueAsString(testCase.getThing());
String actual = writer.writeValueAsString(actual.getThing());
assertEquals(expected, actual);
} catch (JsonProcessingException e) {
fail("JSON exception: " + e.toString());
}
这样做非常简单,您不需要实施任何 interface/Abstract Class。 仅创建一个新打印机并将其用作映射器编写器的参数:
ObjectMapper mapper = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT);
DefaultPrettyPrinter printer = new DefaultPrettyPrinter().withObjectIndenter(new DefaultIndenter(" ", "\n"));
String json = mapper.writer(printer).writeValueAsString(result);
基于非常有帮助的@wassgren 回答,以及对@Kervvv 问题的回答,我给你我对这个问题的回答:
我稍微改进了解决方案以满足我的要求
- 没有space,字段名后
- 空数组的方括号之间没有 space
你至少需要 Jackson 2.9
public class MyPrettyPrinter extends DefaultPrettyPrinter {
public MyPrettyPrinter() {
DefaultPrettyPrinter.Indenter indenter = new DefaultIndenter(" ", System.getProperty("line.separator"));
indentObjectsWith(indenter);
indentArraysWith(indenter);
_objectFieldValueSeparatorWithSpaces = ": ";
}
private MyPrettyPrinter(MyPrettyPrinter pp) {
super(pp);
}
@Override
public void writeEndArray(JsonGenerator g, int nrOfValues) throws IOException {
if (!_arrayIndenter.isInline()) {
--_nesting;
}
if (nrOfValues > 0) {
_arrayIndenter.writeIndentation(g, _nesting);
}
g.writeRaw(']');
}
@Override
public DefaultPrettyPrinter createInstance() {
return new MyPrettyPrinter(this);
}
}
和用法
mapper.writer(new MyPrettyPrinter()).writeValueAsString(value);