题 如何使用JavaScript漂亮地打印JSON?


如何以易于阅读(针对人类读者)的格式显示JSON?我主要是寻找缩进和空白,甚至可能是颜色/字体样式等。


1666
2018-01-26 22:33


起源


可能重复 如何以编程方式美化JSON? - hippietrail
@hippietrail meta.stackoverflow.com/q/251938/3853934 - Michał Perłakowski
如果你只是输出到html,你可以将它包装成一个 <pre> 标签。 - Ryan Walker


答案:


漂亮的打印是本地实现的 JSON.stringify()。第三个参数启用漂亮打印并设置要使用的间距:

var str = JSON.stringify(obj, null, 2); // spacing level = 2

如果你需要语法高亮,你可能会使用一些正则表达式魔术:

function syntaxHighlight(json) {
    if (typeof json != 'string') {
         json = JSON.stringify(json, undefined, 2);
    }
    json = json.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
    return json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, function (match) {
        var cls = 'number';
        if (/^"/.test(match)) {
            if (/:$/.test(match)) {
                cls = 'key';
            } else {
                cls = 'string';
            }
        } else if (/true|false/.test(match)) {
            cls = 'boolean';
        } else if (/null/.test(match)) {
            cls = 'null';
        }
        return '<span class="' + cls + '">' + match + '</span>';
    });
}

请看这里的行动: 的jsfiddle

或者下面提供的完整代码段:

function output(inp) {
    document.body.appendChild(document.createElement('pre')).innerHTML = inp;
}

function syntaxHighlight(json) {
    json = json.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
    return json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, function (match) {
        var cls = 'number';
        if (/^"/.test(match)) {
            if (/:$/.test(match)) {
                cls = 'key';
            } else {
                cls = 'string';
            }
        } else if (/true|false/.test(match)) {
            cls = 'boolean';
        } else if (/null/.test(match)) {
            cls = 'null';
        }
        return '<span class="' + cls + '">' + match + '</span>';
    });
}

var obj = {a:1, 'b':'foo', c:[false,'false',null, 'null', {d:{e:1.3e5,f:'1.3e5'}}]};
var str = JSON.stringify(obj, undefined, 4);

output(str);
output(syntaxHighlight(str));
pre {outline: 1px solid #ccc; padding: 5px; margin: 5px; }
.string { color: green; }
.number { color: darkorange; }
.boolean { color: blue; }
.null { color: magenta; }
.key { color: red; }


3709
2017-08-28 10:56



太棒了。我在一个新窗口中添加了一个函数来弹出这个函数进行调试:var json = syntaxHighlight(JSON.stringify(obj,undefined,4);); var w = window.open(); var html =“<head> <style> pre {outline:1px solid #ccc; padding:5px; margin:5px;} .string {color:green;}”; html + =“。number {color:darkorange;} .boolean {color:blue;} .null {color:magenta;} .key {color:red;} </ style> </ head> <body>”; html + =“<pre>”+ json +“</ pre>”; w.document.writeln(HTML); - JayCrossler
尼斯。别忘了它需要css和a <pre>但是。 - NoBugs
出于某种原因,当我提醒它时,它确实显示格式化但是当我通过jQuery将它吐出到div时仍显示扁平字符串:$(“#transactionResponse”)。show()。html(prettifyObject(data), null,'\ t');其中prettifyObject是我创建的一个方法,它包含上面的前两行。 - PositiveGuy
@CoffeeAddict确保你的 #transactionResponse 元素有 white-space: pre; 作为CSS风格。 - user123444555621
注意 stringify(...) 适用于JSON 对象,而不是JSON字符串。如果你有一个字符串,你需要 JSON.parse(...) 第一 - Vihung


用户Pumbaa80的答案很棒,如果你有一个 目的 你想要漂亮印刷。如果您从有效的JSON开始  你想要打印漂亮的,你需​​要先将它转换为一个对象:

var jsonString = '{"some":"json"}';
var jsonPretty = JSON.stringify(JSON.parse(jsonString),null,2);  

这将从字符串构建一个JSON对象,然后使用JSON stringify的漂亮打印将其转换回字符串。


181
2018-06-21 20:35



这对我有用,但是使用了一个错误 JSON.parse 所以我修改了它 JSON.stringify(jsonString, null, 2)。取决于您的JSON /对象。 - Jazzy
请注意,显示字符串时需要将其包装 <pre></pre> 标签。 - Undistraction
@Jazzy JSON.parse 只有在你有一个无效的JSON str或者它已经被转换为一个对象时才会死掉...在尝试之前确保你知道你正在处理什么数据类型 JSON.parse - Kolob Canyon
@Undistraction您的评论对我有用,我会检查需要检查究竟是什么 pre 确实。 - Dhaval Jardosh
@Jazzy如果你必须这样做,你没有JSON字符串,你有一个普通的对象。 JSON是 总是一个字符串。它只是一个基于字符串的Javascript对象表示。 - Clonkex


根据Pumbaa80的回答,我修改了代码以使用console.log颜色(肯定是在Chrome上工作),而不是HTML。输出可以在控制台内看到。您可以编辑函数内的_variables,添加更多样式。

function JSONstringify(json) {
    if (typeof json != 'string') {
        json = JSON.stringify(json, undefined, '\t');
    }

    var 
        arr = [],
        _string = 'color:green',
        _number = 'color:darkorange',
        _boolean = 'color:blue',
        _null = 'color:magenta',
        _key = 'color:red';

    json = json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, function (match) {
        var style = _number;
        if (/^"/.test(match)) {
            if (/:$/.test(match)) {
                style = _key;
            } else {
                style = _string;
            }
        } else if (/true|false/.test(match)) {
            style = _boolean;
        } else if (/null/.test(match)) {
            style = _null;
        }
        arr.push(style);
        arr.push('');
        return '%c' + match + '%c';
    });

    arr.unshift(json);

    console.log.apply(console, arr);
}

这是您可以使用的书签:

javascript:function JSONstringify(json) {if (typeof json != 'string') {json = JSON.stringify(json, undefined, '\t');}var arr = [],_string = 'color:green',_number = 'color:darkorange',_boolean = 'color:blue',_null = 'color:magenta',_key = 'color:red';json = json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, function (match) {var style = _number;if (/^"/.test(match)) {if (/:$/.test(match)) {style = _key;} else {style = _string;}} else if (/true|false/.test(match)) {style = _boolean;} else if (/null/.test(match)) {style = _null;}arr.push(style);arr.push('');return '%c' + match + '%c';});arr.unshift(json);console.log.apply(console, arr);};void(0);

用法:

var obj = {a:1, 'b':'foo', c:[false,null, {d:{e:1.3e5}}]};
JSONstringify(obj);

编辑:我只是试图在变量声明后用这一行转义%符号:

json = json.replace(/%/g, '%%');

但我发现Chrome不支持在控制台中进行%转义。奇怪......也许这将在未来发挥作用。

干杯!

enter image description here


23
2018-01-29 13:16



我使用了你的代码,但我得到了json格式的输出,但我没有得到颜色,也在最后我得到颜色标签这是输出{“错误”:{“代码”:0,“消息”: “O”}},颜色:红色,颜色:红色,颜色:暗色 - ramesh027
+1用于建议用作书签!谢谢 - Renato Gama


我用 JSONView Chrome扩展程序 (它很漂亮:):

编辑:已添加 jsonreport.js

我还发布了一个在线独立的JSON漂亮打印查看器jsonreport.js,它提供了一个人类可读的HTML5报告,可用于查看任何JSON数据。

您可以在中阅读有关格式的更多信息 新的JavaScript HTML5报告格式


20
2018-01-26 22:37



我需要一个Javascript * .js库,它可以打印一个添加html元素和类的JSON字符串。像var result = prettyPrint('{“key”:“value”}'); - Mark
这很棒,因为它很容易添加。您甚至可以更改颜色设置<3 - Luca Steeb


您可以使用 console.dir(),这是一个捷径 console.log(util.inspect())。 (唯一的区别是它绕过任何习惯 inspect() 在对象上定义的函数。)

它用 语法高亮聪明的缩进从键中删除引号 并使输出尽可能美观。

const object = JSON.parse(jsonString)

console.dir(object, {depth: null, colors: true})

并为命令行:

cat package.json | node -e "process.stdin.pipe(new stream.Writable({write: chunk => console.dir(JSON.parse(chunk), {depth: null, colors: true})}))"


16
2017-11-14 09:46



任何方式得到它,它开始扩大? - Daniel Sokolowski
你是什​​么意思@DanielSokolowski? - adius
在Chrome开发者工具中我必须点击小三角形来获取对象键,以任何方式让它自动扩展? snag.gy/7wPqsl.jpg - Daniel Sokolowski
MH。好问题。我不知道一个,但它确实会有帮助... - adius


更好的方法。

在Javascript中整理JSON数组

JSON.stringify(jsonobj,null,'\t')

11
2017-10-21 10:19



比什么和如何更好? - Dan Dascalescu
@DanDascalescu比以上所有更好? - adamj


var jsonObj = {"streetLabel": "Avenue Anatole France", "city": "Paris 07",  "postalCode": "75007", "countryCode": "FRA",  "countryLabel": "France" };

document.getElementById("result-before").innerHTML = JSON.stringify(jsonObj);

如果以HTML格式显示,则应添加应答器 <pre></pre>

document.getElementById("result-after").innerHTML = "<pre>"+JSON.stringify(jsonObj,undefined, 2) +"</pre>"

例:

var jsonObj = {"streetLabel": "Avenue Anatole France", "city": "Paris 07",  "postalCode": "75007", "countryCode": "FRA",  "countryLabel": "France" };

document.getElementById("result-before").innerHTML = JSON.stringify(jsonObj);

document.getElementById("result-after").innerHTML = "<pre>"+JSON.stringify(jsonObj,undefined, 2) +"</pre>"
div { float:left; clear:both; margin: 1em 0; }
<div id="result-before"></div>
<div id="result-after"></div>


7
2018-03-01 15:42





出于调试目的,我使用:

console.debug(“%o”,data);

5
2018-01-10 14:11



-1;这等同于做 console.debug(data); 在(至少)Chrome和Firefox中。它不显示JSON表示 data,更不用说漂亮的了。 - Mark Amery
@MarkAmery 2年前这个功能对于浏览器来说是新的,只有我描述的才能工作。如果你太年轻 - 我很高兴你!语法也一样 console.debug("%s: %o x %d", str, data, cnt); 可能仍然对某人有帮助。 - gavenkoa
另外看看 console.dir 它允许导航数据。 - Christophe Roussy


对于Ruby的其他漂亮的打印机不满意,我写了自己的(NeatJSON) 接着 将它移植到JavaScript 包含 免费的在线格式化程序。该代码在MIT许可下是免费的(非常宽松)。

功能(全部可选):

  • 设置一个线宽并以一种方式包装,使对象和数组在适合时保持在同一条线上,当它们不适合时,每行包装一个值。
  • 如果您愿意,可以排序对象键。
  • 对齐对象键(排列冒号)。
  • 将浮点数格式化为特定的小数位数,而不会弄乱整数。
  • “短”包装模式将开始和结束括号/大括号放在与值相同的行上,提供了一些偏好的格式。
  • 在冒号和逗号之前/之后,在括号之间对数组和对象的间距进行粒度控制。
  • 函数可用于Web浏览器和Node.js.

我将复制源代码,这不仅仅是一个库的链接,但我鼓励你去 GitHub项目页面,因为这将保持最新,下面的代码不会。

(function(exports){
exports.neatJSON = neatJSON;

function neatJSON(value,opts){
  opts = opts || {}
  if (!('wrap'          in opts)) opts.wrap = 80;
  if (opts.wrap==true) opts.wrap = -1;
  if (!('indent'        in opts)) opts.indent = '  ';
  if (!('arrayPadding'  in opts)) opts.arrayPadding  = ('padding' in opts) ? opts.padding : 0;
  if (!('objectPadding' in opts)) opts.objectPadding = ('padding' in opts) ? opts.padding : 0;
  if (!('afterComma'    in opts)) opts.afterComma    = ('aroundComma' in opts) ? opts.aroundComma : 0;
  if (!('beforeComma'   in opts)) opts.beforeComma   = ('aroundComma' in opts) ? opts.aroundComma : 0;
  if (!('afterColon'    in opts)) opts.afterColon    = ('aroundColon' in opts) ? opts.aroundColon : 0;
  if (!('beforeColon'   in opts)) opts.beforeColon   = ('aroundColon' in opts) ? opts.aroundColon : 0;

  var apad  = repeat(' ',opts.arrayPadding),
      opad  = repeat(' ',opts.objectPadding),
      comma = repeat(' ',opts.beforeComma)+','+repeat(' ',opts.afterComma),
      colon = repeat(' ',opts.beforeColon)+':'+repeat(' ',opts.afterColon);

  return build(value,'');

  function build(o,indent){
    if (o===null || o===undefined) return indent+'null';
    else{
      switch(o.constructor){
        case Number:
          var isFloat = (o === +o && o !== (o|0));
          return indent + ((isFloat && ('decimals' in opts)) ? o.toFixed(opts.decimals) : (o+''));

        case Array:
          var pieces  = o.map(function(v){ return build(v,'') });
          var oneLine = indent+'['+apad+pieces.join(comma)+apad+']';
          if (opts.wrap===false || oneLine.length<=opts.wrap) return oneLine;
          if (opts.short){
            var indent2 = indent+' '+apad;
            pieces = o.map(function(v){ return build(v,indent2) });
            pieces[0] = pieces[0].replace(indent2,indent+'['+apad);
            pieces[pieces.length-1] = pieces[pieces.length-1]+apad+']';
            return pieces.join(',\n');
          }else{
            var indent2 = indent+opts.indent;
            return indent+'[\n'+o.map(function(v){ return build(v,indent2) }).join(',\n')+'\n'+indent+']';
          }

        case Object:
          var keyvals=[],i=0;
          for (var k in o) keyvals[i++] = [JSON.stringify(k), build(o[k],'')];
          if (opts.sorted) keyvals = keyvals.sort(function(kv1,kv2){ kv1=kv1[0]; kv2=kv2[0]; return kv1<kv2?-1:kv1>kv2?1:0 });
          keyvals = keyvals.map(function(kv){ return kv.join(colon) }).join(comma);
          var oneLine = indent+"{"+opad+keyvals+opad+"}";
          if (opts.wrap===false || oneLine.length<opts.wrap) return oneLine;
          if (opts.short){
            var keyvals=[],i=0;
            for (var k in o) keyvals[i++] = [indent+' '+opad+JSON.stringify(k),o[k]];
            if (opts.sorted) keyvals = keyvals.sort(function(kv1,kv2){ kv1=kv1[0]; kv2=kv2[0]; return kv1<kv2?-1:kv1>kv2?1:0 });
            keyvals[0][0] = keyvals[0][0].replace(indent+' ',indent+'{');
            if (opts.aligned){
              var longest = 0;
              for (var i=keyvals.length;i--;) if (keyvals[i][0].length>longest) longest = keyvals[i][0].length;
              var padding = repeat(' ',longest);
              for (var i=keyvals.length;i--;) keyvals[i][0] = padRight(padding,keyvals[i][0]);
            }
            for (var i=keyvals.length;i--;){
              var k=keyvals[i][0], v=keyvals[i][1];
              var indent2 = repeat(' ',(k+colon).length);
              var oneLine = k+colon+build(v,'');
              keyvals[i] = (opts.wrap===false || oneLine.length<=opts.wrap || !v || typeof v!="object") ? oneLine : (k+colon+build(v,indent2).replace(/^\s+/,''));
            }
            return keyvals.join(',\n') + opad + '}';
          }else{
            var keyvals=[],i=0;
            for (var k in o) keyvals[i++] = [indent+opts.indent+JSON.stringify(k),o[k]];
            if (opts.sorted) keyvals = keyvals.sort(function(kv1,kv2){ kv1=kv1[0]; kv2=kv2[0]; return kv1<kv2?-1:kv1>kv2?1:0 });
            if (opts.aligned){
              var longest = 0;
              for (var i=keyvals.length;i--;) if (keyvals[i][0].length>longest) longest = keyvals[i][0].length;
              var padding = repeat(' ',longest);
              for (var i=keyvals.length;i--;) keyvals[i][0] = padRight(padding,keyvals[i][0]);
            }
            var indent2 = indent+opts.indent;
            for (var i=keyvals.length;i--;){
              var k=keyvals[i][0], v=keyvals[i][1];
              var oneLine = k+colon+build(v,'');
              keyvals[i] = (opts.wrap===false || oneLine.length<=opts.wrap || !v || typeof v!="object") ? oneLine : (k+colon+build(v,indent2).replace(/^\s+/,''));
            }
            return indent+'{\n'+keyvals.join(',\n')+'\n'+indent+'}'
          }

        default:
          return indent+JSON.stringify(o);
      }
    }
  }

  function repeat(str,times){ // http://stackoverflow.com/a/17800645/405017
    var result = '';
    while(true){
      if (times & 1) result += str;
      times >>= 1;
      if (times) str += str;
      else break;
    }
    return result;
  }
  function padRight(pad, str){
    return (str + pad).substring(0, pad.length);
  }
}
neatJSON.version = "0.5";

})(typeof exports === 'undefined' ? this : exports);

4
2018-04-19 21:49





非常感谢@all! 根据之前的答案,这是另一种提供自定义替换规则作为参数的变体方法:

 renderJSON : function(json, rr, code, pre){
   if (typeof json !== 'string') {
      json = JSON.stringify(json, undefined, '\t');
   }
  var rules = {
   def : 'color:black;',    
   defKey : function(match){
             return '<strong>' + match + '</strong>';
          },
   types : [
       {
          name : 'True',
          regex : /true/,
          type : 'boolean',
          style : 'color:lightgreen;'
       },

       {
          name : 'False',
          regex : /false/,
          type : 'boolean',
          style : 'color:lightred;'
       },

       {
          name : 'Unicode',
          regex : /"(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?/,
          type : 'string',
          style : 'color:green;'
       },

       {
          name : 'Null',
          regex : /null/,
          type : 'nil',
          style : 'color:magenta;'
       },

       {
          name : 'Number',
          regex : /-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/,
          type : 'number',
          style : 'color:darkorange;'
       },

       {
          name : 'Whitespace',
          regex : /\s+/,
          type : 'whitespace',
          style : function(match){
             return '&nbsp';
          }
       } 

    ],

    keys : [
       {
           name : 'Testkey',
           regex : /("testkey")/,
           type : 'key',
           style : function(match){
             return '<h1>' + match + '</h1>';
          }
       }
    ],

    punctuation : {
          name : 'Punctuation',
          regex : /([\,\.\}\{\[\]])/,
          type : 'punctuation',
          style : function(match){
             return '<p>________</p>';
          }
       }

  };

  if('undefined' !== typeof jQuery){
     rules = $.extend(rules, ('object' === typeof rr) ? rr : {});  
  }else{
     for(var k in rr ){
        rules[k] = rr[k];
     }
  }
    var str = json.replace(/([\,\.\}\{\[\]]|"(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, function (match) {
    var i = 0, p;
    if (rules.punctuation.regex.test(match)) {
               if('string' === typeof rules.punctuation.style){
                   return '<span style="'+ rules.punctuation.style + '">' + match + '</span>';
               }else if('function' === typeof rules.punctuation.style){
                   return rules.punctuation.style(match);
               } else{
                  return match;
               }            
    }

    if (/^"/.test(match)) {
        if (/:$/.test(match)) {
            for(i=0;i<rules.keys.length;i++){
            p = rules.keys[i];
            if (p.regex.test(match)) {
               if('string' === typeof p.style){
                   return '<span style="'+ p.style + '">' + match + '</span>';
               }else if('function' === typeof p.style){
                   return p.style(match);
               } else{
                  return match;
               }                
             }              
           }   
            return ('function'===typeof rules.defKey) ? rules.defKey(match) : '<span style="'+ rules.defKey + '">' + match + '</span>';            
        } else {
            return ('function'===typeof rules.def) ? rules.def(match) : '<span style="'+ rules.def + '">' + match + '</span>';
        }
    } else {
        for(i=0;i<rules.types.length;i++){
         p = rules.types[i];
         if (p.regex.test(match)) {
               if('string' === typeof p.style){
                   return '<span style="'+ p.style + '">' + match + '</span>';
               }else if('function' === typeof p.style){
                   return p.style(match);
               } else{
                  return match;
               }                
          }             
        }

     }

    });

  if(true === pre)str = '<pre>' + str + '</pre>';
  if(true === code)str = '<code>' + str + '</code>';
  return str;
 }

3
2017-09-09 07:40



什么是“rr”论点? - manking
@manking ... rules = $ .extend(rules,('object'=== typeof rr)?rr:{}); ...它是由一个rulset对象扩展规则集。 (也许你找到更新: github.com/frdl/-Flow/blob/master/api-d/4/js-api/library.js/... ) - webfan


Douglas Crockford在JavaScript库中的JSON将通过stringify方法打印JSON。

您可能还会发现这个旧问题的答案很有用: 如何在(unix)shell脚本中打印JSON?


2
2018-02-19 05:17