如何将JSON字符串格式化输出

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了如何将JSON字符串格式化输出相关的知识,希望对你有一定的参考价值。

参考技术A 一般在项目中,我们可能会经常需要对返回结果进行格式化处理,比如先把返回结果对象转换为JSON格式的字符串,然后再将其输出。这个JSON格式化处理的过程,我们在前端或者后端都可以实现。

javascript中,我们如果需要将js对象转换为json字符串,可以通过 JSON.stringify() 来实现。

相反,如果需要将json字符串转换为js对象,可以通过 JSON.parse() 来实现。

在Python3中,我们如果需要将Python对象转换为json字符串,可以通过 json.dumps() 来实现。

相反,如果需要将json字符串转换为Python对象,可以通过 json.loads() 来实现。

JSON 格式

下面我们讨论如何在服务器端输出 JSON 格式的数据。以 Java 为例,我们将演示将一个 Java 对象编码为 JSON 格式的文本。

将 String 对象编码为 JSON 格式时,只需处理好特殊字符即可。另外,必须用 (") 而非 () 表示字符串: 

static String string2Json(String s) { 
    StringBuilder sb = new StringBuilder(s.length()+20); 
    sb.append(‘\"‘); 
    for (int i=0; i<s.length(); i++) { 
        char c = s.charAt(i); 
        switch (c) { 
        case ‘\"‘: 
            sb.append("\\\""); 
            break; 
        case ‘\\‘: 
            sb.append("\\\\"); 
            break; 
        case ‘/‘: 
            sb.append("\\/"); 
            break; 
        case ‘\b‘: 
            sb.append("\\b"); 
            break; 
        case ‘\f‘: 
            sb.append("\\f"); 
            break; 
        case ‘\n‘: 
            sb.append("\\n"); 
            break; 
        case ‘\r‘: 
            sb.append("\\r"); 
            break; 
        case ‘\t‘: 
            sb.append("\\t"); 
            break; 
        default: 
            sb.append(c); 
        } 
    } 
    sb.append(‘\"‘); 
    return sb.toString(); 
 } 

将 Number 表示为 JSON 就容易得多,利用 Java 的多态,我们可以处理 Integer,Long,Float 等多种 Number 格式:

 static String number2Json(Number number) { 
    return number.toString(); 
 } 

Boolean 类型也可以直接通过 toString() 方法得到 JSON 的表示:

 static String boolean2Json(Boolean bool) { 
    return bool.toString(); 
 } 
 

要将数组编码为 JSON 格式,可以通过循环将每一个元素编码出来:

 static String array2Json(Object[] array) { 
    if (array.length==0) 
        return "[]"; 
    StringBuilder sb = new StringBuilder(array.length << 4); 
    sb.append(‘[‘); 
    for (Object o : array) { 
        sb.append(toJson(o)); 
        sb.append(‘,‘); 
    } 
    // 将最后添加的 ‘,‘ 变为 ‘]‘: 
    sb.setCharAt(sb.length()-1, ‘]‘); 
    return sb.toString(); 
 } 

最后,我们需要将 Map<String, Object> 编码为 JSON 格式,因为 JavaScript 的 Object 实际上对应的是 Java 的 Map<String, Object> 。该方法如下:

 
 static String map2Json(Map<String, Object> map) { 
    if (map.isEmpty()) 
        return "{}"; 
    StringBuilder sb = new StringBuilder(map.size() << 4); 
    sb.append(‘{‘); 
    Set<String> keys = map.keySet(); 
    for (String key : keys) { 
        Object value = map.get(key); 
        sb.append(‘\"‘); 
        sb.append(key); 
        sb.append(‘\"‘); 
        sb.append(‘:‘); 
        sb.append(toJson(value)); 
        sb.append(‘,‘); 
    } 
    // 将最后的 ‘,‘ 变为 ‘}‘: 
    sb.setCharAt(sb.length()-1, ‘}‘); 
    return sb.toString(); 
 } 

为了统一处理任意的 Java 对象,我们编写一个入口方法 toJson(Object),能够将任意的 Java 对象编码为 JSON 格式:

public static String toJson(Object o) { 
    if (o==null) 
        return "null"; 
    if (o instanceof String) 
        return string2Json((String)o); 
    if (o instanceof Boolean) 
        return boolean2Json((Boolean)o); 
    if (o instanceof Number) 
        return number2Json((Number)o); 
    if (o instanceof Map) 
        return map2Json((Map<String, Object>)o); 
    if (o instanceof Object[]) 
        return array2Json((Object[])o); 
    throw new RuntimeException("Unsupported type: " + o.getClass().getName()); 
 } 
 

我们并未对 Java 对象作严格的检查。不被支持的对象(例如 List)将直接抛出 RuntimeException 。此外,为了保证输出的 JSON 是有效的,Map<String, Object> 对象的 Key 也不能包含特殊字符。细心的读者可能还会发现循环引用的对象会引发无限递归,例如,精心构造一个循环引用的 Map,就可以检测到 StackOverflowException

@Test(expected=StackOverflowError.class) 
 public void testRecurrsiveMap2Json() { 
    Map<String, Object> map = new HashMap<String, Object>(); 
    map.put("key", map); 
    JsonUtil.map2Json(map); 
 } 
 

好在服务器处理的 JSON 数据最终都应该转化为简单的 JavaScript 对象,因此,递归引用的可能性很小。

最后,通过 Servlet 或 MVC 框架输出 JSON 时,需要设置正确的 MIME 类型(application/json)和字符编码。假定服务器使用 UTF-8 编码,则可以使用以下代码输出编码后的 JSON 文本:

response.setContentType("application/json;charset=UTF-8"); 
 response.setCharacterEncoding("UTF-8"); 
 PrintWriter pw = response.getWriter(); 
 pw.write(JsonUtil.toJson(obj)); 
 pw.flush(); 
 

小结

JSON 已经是 JavaScript 标准的一部分。目前,主流的浏览器对 JSON 支持都非常完善。应用 JSON,我们可以从 XML 的解析中摆脱出来,对那些应用 Ajax 的 Web 2.0 网站来说,JSON 确实是目前最灵活的轻量级方案。


 

 

以上是关于如何将JSON字符串格式化输出的主要内容,如果未能解决你的问题,请参考以下文章

如何使用 jq 将 JSON 字符串格式化为表格?

GroovyGroovy 对象转为 json 字符串 ( 使用 JsonBuilder 进行转换 | 使用 JsonOutput 进行转换 | 将 json 字符串格式化输出 )

Python格式化输出json

JSON 格式

JS 将JSON映射到字符串中格式化输出

JS 将JSON映射到字符串中格式化输出