使用Jackson将JSON字符串转换为漂亮的JSON输出

213

这是我拥有的JSON字符串:

{"attributes":[{"nm":"ACCOUNT","lv":[{"v":{"Id":null,"State":null},"vt":"java.util.Map","cn":1}],"vt":"java.util.Map","status":"SUCCESS","lmd":13585},{"nm":"PROFILE","lv":[{"v":{"Party":null,"Ads":null},"vt":"java.util.Map","cn":2}],"vt":"java.util.Map","status":"SUCCESS","lmd":41962}]}

我需要将上述JSON String 转换为漂亮的JSON输出(使用Jackson),如下所示:

{
    "attributes": [
        {
            "nm": "ACCOUNT",
            "lv": [
                {
                    "v": {
                        "Id": null,
                        "State": null
                    },
                    "vt": "java.util.Map",
                    "cn": 1
                }
            ],
            "vt": "java.util.Map",
            "status": "SUCCESS",
            "lmd": 13585
        },
        {
            "nm": "PROFILE
            "lv": [
                {
                    "v": {
                        "Party": null,
                        "Ads": null
                    },
                    "vt": "java.util.Map",
                    "cn": 2
                }
            ],
            "vt": "java.util.Map",
            "status": "SUCCESS",
            "lmd": 41962
        }
    ]
}

有人能够基于我上面的示例给我提供一个示例吗?如何实现这种情况?我知道有很多例子,但我无法正确理解它们。任何简单示例都将不胜感激。

更新:

以下是我正在使用的代码:

ObjectMapper mapper = new ObjectMapper();
System.out.println(mapper.defaultPrettyPrintingWriter().writeValueAsString(jsonString));

但这种方法不能按照我上面提到的输出方式运行。

这是我用于上述JSON的POJO:

public class UrlInfo implements Serializable {

    private List<Attributes> attribute;

}

class Attributes {

    private String nm;
    private List<ValueList> lv;
    private String vt;
    private String status;
    private String lmd;

}


class ValueList {
    private String vt;
    private String cn;
    private List<String> v;
}

有人能告诉我我是否已经得到正确的POJO用于JSON吗?

更新:

String result = restTemplate.getForObject(url.toString(), String.class);

ObjectMapper mapper = new ObjectMapper();
Object json = mapper.readValue(result, Object.class);

String indented = mapper.defaultPrettyPrintingWriter().writeValueAsString(json);

System.out.println(indented);//This print statement show correct way I need

model.addAttribute("response", (indented));

以下代码会输出类似于这样的内容:

System.out.println(indented);


{
  "attributes" : [ {
    "nm" : "ACCOUNT",
    "error" : "null SYS00019CancellationException in CoreImpl fetchAttributes\n java.util.concurrent.CancellationException\n\tat java.util.concurrent.FutureTask$Sync.innerGet(FutureTask.java:231)\n\tat java.util.concurrent.FutureTask.",
    "status" : "ERROR"
  } ]
}

这就是我需要展示的方式。但是当我像这样将它添加到模型中:

model.addAttribute("response", (indented));

然后在结果形式的 JSP 页面中将其显示出来,如下所示:

    <fieldset>
        <legend>Response:</legend>
            <strong>${response}</strong><br />

    </fieldset>

我得到了这样的结果:

{ "attributes" : [ { "nm" : "ACCOUNT", "error" : "null    
SYS00019CancellationException in CoreImpl fetchAttributes\n 
java.util.concurrent.CancellationException\n\tat 
java.util.concurrent.FutureTask$Sync.innerGet(FutureTask.java:231)\n\tat 
java.util.concurrent.FutureTask.", "status" : "ERROR" } ] }

我不需要这个。我需要上面打印出来的样子。有人能告诉我为什么会这样吗?

11个回答

318

要缩进任何旧的JSON,只需将其绑定为Object,例如:

Object json = mapper.readValue(input, Object.class);

然后按照缩进的方式将其写出:

String indented = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(json);

这样可以避免您定义实际的POJO来映射数据。

或者您也可以使用JsonNode(JSON树)。


谢谢StaxMan,我想这个方法可行。当我打印缩进时,它以我需要的方式呈现。但是当我使用缩进添加到模型中,以便在结果页面中显示它们时,它仍然会被打印成两三行。我已经更新了问题,也许你现在会有更多的想法。 - arsenal
问题出在Spring上--我猜它期望的是一个POJO作为属性,而不是一个预格式化的字符串。所以,你需要告诉Spring去做这件事情,而不是试图自己格式化它。当使用Jackson时,应该可以配置它来使用缩进。虽然说,老实说,我不确定为什么你甚至需要对响应进行缩进。 - StaxMan
34
您好,defaultPrettyPrintingWriter() 已经被弃用。从1.9版本开始,请改用 writerWithDefaultPrettyPrinter()。参考链接:http://jackson.codehaus.org/1.9.0/javadoc/org/codehaus/jackson/map/ObjectMapper.html#defaultPrettyPrintingWriter() - Browny Lin
6
如下所述,对于Jackson 2,请使用SerializationFeature.INDENT_OUTPUT进行缩进输出,Marcelo C.建议如此。 - Mike R
运行完美。感谢 @StaxMan。 - Gaurav
显示剩余2条评论

144

最简单且最紧凑的解决方案(适用于v2.3.3):

ObjectMapper mapper = new ObjectMapper();
mapper.enable(SerializationFeature.INDENT_OUTPUT);
mapper.writeValueAsString(obj)

28
您可以进一步缩短代码:ObjectMapper mapper = new ObjectMapper.enable(SerializationFeature.INDENT_OUTPUT); (意为:您可以使用上述代码来进一步简化代码) - Jason Nichols

30

ObjectMapper.readTree() 可以在一行代码中完成此操作:


mapper.readTree(json).toPrettyString();

由于readTree生成一个JsonNode,因此这几乎总是会生成等效的漂亮格式化的 JSON,因为JsonNode是底层 JSON 字符串的直接树表示。

Jackson 2.10之前

在Jackson 2.10之前,需要第二次调用ObjectMapper才能写入漂亮的格式化结果:JsonNode.toPrettyString() 方法是在Jackson 2.10中添加的。

mapper.writerWithDefaultPrettyPrinter()
        .writeValueAsString(mapper.readTree(json));

3
我喜欢这个答案的原因是它除了直接映射到JSON类型外,没有进行任何对象转换。只要输入字符串是有效的JSON,我们就知道输出字符串将是语义等效的JSON。 - M. Justin
1
这应该是被接受的答案,因为正如@M.Justin所提到的,我们不进行任何对象转换,这是必须的,如果JSON可以是任何东西。为什么要像其他答案中所建议的那样让生活变得困难,当你可以像这个答案中所建议的那样轻松地完成呢... - Akito
1
@Akito,由于Jackson 2.10中添加了toPrettyString(),我甚至进一步简化了答案。 - M. Justin

29

使用Jackson 1.9+的新方法如下:

Object json = OBJECT_MAPPER.readValue(diffResponseJson, Object.class);
String indented = OBJECT_MAPPER.writerWithDefaultPrettyPrinter()
                               .writeValueAsString(json);

输出结果将被正确格式化!


1
不幸的是,如果我的输入是运行时创建的对象,而不是另一个JSON,则这并没有帮助。 - Innokenty
@Innokenty 然后跳过第一行。 - muttonUp
3
是的,显然。我甚至已经这样做了,不知道为什么会留下这样愚蠢的评论=) - Innokenty

18

对于 Jackson 1.9,我们可以使用以下代码进行漂亮的打印。

ObjectMapper objectMapper = new ObjectMapper();
objectMapper.enable(SerializationConfig.Feature.INDENT_OUTPUT);

17

我认为这是美化JSON数据最简单的技巧。

String indented = (new JSONObject(Response)).toString(4);

其中Response是一个字符串。

只需在toString()方法中传递4(indentSpaces)即可。

注意:它在安卓上没有任何库的情况下运行良好。但是在Java中,您需要使用org.json库。


3
值得注意的是,这是使用Java中的JSON库(org.json)进行处理的。 - Steve Chambers
在安卓中,可以直接使用而无需任何库。 - Aman Gupta - ΔMΔN
String indentedJson = (new JSONObject(json)).toString(4);```由于某种原因,第二个代码段会导致键的顺序丢失。 - Michail Michailidis
目前的方法不幸地无法处理JSON对象列表。我的意思是[{"id":"1"}, {"id":"2"}]。 - Geniy

6
你可以通过以下方式实现:

1. 使用Jackson

    String formattedData=new ObjectMapper().writerWithDefaultPrettyPrinter()
.writeValueAsString(YOUR_JSON_OBJECT);

导入以下类:

import com.fasterxml.jackson.databind.ObjectMapper;

它的 Gradle 依赖关系是:

compile 'com.fasterxml.jackson.core:jackson-core:2.7.3'
compile 'com.fasterxml.jackson.core:jackson-annotations:2.7.3'
compile 'com.fasterxml.jackson.core:jackson-databind:2.7.3'

2. 使用来自Google的Gson

String formattedData=new GsonBuilder().setPrettyPrinting()
    .create().toJson(YOUR_OBJECT);

导入以下类:

import com.google.gson.Gson;

它的Gradle是:

compile 'com.google.code.gson:gson:2.8.2'

在这里,您还可以从仓库下载正确的更新版本。

Jackson并非由Apache开发,它只是使用了Apache许可证。 - Gili
@Gili,非常感谢你的指正。我会更改这段文字。 - Md. Sajedul Karim

4

这看起来可能是您问题的答案。它说它正在使用Spring,但我认为在您的情况下仍应该有所帮助。让我在此处嵌入代码以使其更加方便:

import java.io.FileReader;

import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.ObjectWriter;

public class Foo
{
  public static void main(String[] args) throws Exception
  {
    ObjectMapper mapper = new ObjectMapper();
    MyClass myObject = mapper.readValue(new FileReader("input.json"), MyClass.class);
    // this is Jackson 1.x API only: 
    ObjectWriter writer = mapper.defaultPrettyPrintingWriter();
    // ***IMPORTANT!!!*** for Jackson 2.x use the line below instead of the one above: 
    // ObjectWriter writer = mapper.writer().withDefaultPrettyPrinter();
    System.out.println(writer.writeValueAsString(myObject));
  }
}

class MyClass
{
  String one;
  String[] two;
  MyOtherClass three;

  public String getOne() {return one;}
  void setOne(String one) {this.one = one;}
  public String[] getTwo() {return two;}
  void setTwo(String[] two) {this.two = two;}
  public MyOtherClass getThree() {return three;}
  void setThree(MyOtherClass three) {this.three = three;}
}

class MyOtherClass
{
  String four;
  String[] five;

  public String getFour() {return four;}
  void setFour(String four) {this.four = four;}
  public String[] getFive() {return five;}
  void setFive(String[] five) {this.five = five;}
}

感谢Daniel的帮助。我遇到的最困难的部分是如何将我的JSON建模成一个类?如果我能解决这个问题,我就可以轻松编写其余部分了。 - arsenal
你能否看一下我从JSON写的POJO类?它看起来正确吗? - arsenal

3
自从jackson-databind:2.10版本,JsonNode加入了toPrettyString()方法,可以轻松地将JSON格式化。
objectMapper
  .readTree("{}")
  .toPrettyString()
;

来自文档:

public String toPrettyString()

该方法是 toString() 的一种替代方式,使用 Jackson 默认的漂亮打印机序列化此节点。

自版本:
2.10


0
如果您格式化字符串并返回对象,例如RestApiResponse<String>,则会得到不需要的字符,如转义等:\n\"。解决方案是将JSON字符串转换为Jackson JsonNode对象,并返回RestApiResponse<JsonNode>
ObjectMapper mapper = new ObjectMapper();
JsonNode tree = objectMapper.readTree(jsonString);
RestApiResponse<JsonNode> response = new RestApiResponse<>();
apiResponse.setData(tree);
return response;

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接