JavaScript数据格式化/漂亮的打印机

时间:2008-09-24 22:46:54

标签: javascript debugging json

我正在尝试以人类可读的形式找到pretty print JavaScript数据结构的方法以进行调试。

我有一个相当大而复杂的数据结构存储在JS中,我需要编写一些代码来操作它。为了弄清楚我正在做什么以及我哪里出错了,我真正需要的是能够完整地查看数据结构,并在我通过UI进行更改时更新它。

除了找到一种将JavaScript数据结构转储为人类可读字符串的好方法之外,我可以处理所有这些事情。 JSON会这样做,但它确实需要很好地格式化和缩进。我通常会使用Firebug优秀的DOM转储器,但我真的需要能够立刻看到整个结构,这在Firebug中似乎是不可能的。

欢迎任何建议。

提前致谢。

16 个答案:

答案 0 :(得分:226)

像这样使用Crockford's JSON.stringify

var myArray = ['e', {pluribus: 'unum'}];
var text = JSON.stringify(myArray, null, '\t'); //you can specify a number instead of '\t' and that many spaces will be used for indentation...

变量text看起来像这样:

[
  "e",
   {
      "pluribus": "unum"
   }
]

顺便说一下,这只需要JS文件 - 它可以与任何库等一起使用。

答案 1 :(得分:30)

我编写了一个以可读形式转储JS对象的函数,虽然输出没有缩进,但是添加它不应该太难:我从我为Lua创建的函数中创建了这个函数(这是更复杂的是处理这个缩进问题。

这是“简单”版本:

function DumpObject(obj)
{
  var od = new Object;
  var result = "";
  var len = 0;

  for (var property in obj)
  {
    var value = obj[property];
    if (typeof value == 'string')
      value = "'" + value + "'";
    else if (typeof value == 'object')
    {
      if (value instanceof Array)
      {
        value = "[ " + value + " ]";
      }
      else
      {
        var ood = DumpObject(value);
        value = "{ " + ood.dump + " }";
      }
    }
    result += "'" + property + "' : " + value + ", ";
    len++;
  }
  od.dump = result.replace(/, $/, "");
  od.len = len;

  return od;
}

我会稍微改进一下 注1:要使用它,请执行od = DumpObject(something)并使用od.dump。令人费解,因为我想要len值(物品数量)用于其他目的。使函数只返回字符串是微不足道的 注2:它不处理引用中的循环。

修改

我制作了缩进版。

function DumpObjectIndented(obj, indent)
{
  var result = "";
  if (indent == null) indent = "";

  for (var property in obj)
  {
    var value = obj[property];
    if (typeof value == 'string')
      value = "'" + value + "'";
    else if (typeof value == 'object')
    {
      if (value instanceof Array)
      {
        // Just let JS convert the Array to a string!
        value = "[ " + value + " ]";
      }
      else
      {
        // Recursive dump
        // (replace "  " by "\t" or something else if you prefer)
        var od = DumpObjectIndented(value, indent + "  ");
        // If you like { on the same line as the key
        //value = "{\n" + od + "\n" + indent + "}";
        // If you prefer { and } to be aligned
        value = "\n" + indent + "{\n" + od + "\n" + indent + "}";
      }
    }
    result += indent + "'" + property + "' : " + value + ",\n";
  }
  return result.replace(/,\n$/, "");
}

使用递归调用在行上选择缩进,并通过在此之后切换注释行来支撑样式。

......我看到你掀起了自己的版本,这很好。游客可以选择。

答案 2 :(得分:20)

您可以使用以下

<pre id="dump"></pre>
<script>
   var dump = JSON.stringify(sampleJsonObject, null, 4); 
   $('#dump').html(dump)
</script>

答案 3 :(得分:15)

Firebug中,如果您只是console.debug ("%o", my_object),则可以在控制台中单击它并输入交互式对象资源管理器。它显示整个对象,并允许您展开嵌套对象。

答案 4 :(得分:11)

对于Node.js,请使用:

util.inspect(object, [options]);

API Documentation

答案 5 :(得分:9)

对于那些寻找查看对象的绝佳方式的人,check prettyPrint.js

创建一个包含可配置视图选项的表,以便在doc上的某个位置打印。比console更好看。

var tbl = prettyPrint( myObject, { /* options such as maxDepth, etc. */ });
document.body.appendChild(tbl);

enter image description here

答案 6 :(得分:6)

我在Rhino编程,我对此处发布的任何答案都不满意。所以我写了自己漂亮的打印机:

function pp(object, depth, embedded) { 
  typeof(depth) == "number" || (depth = 0)
  typeof(embedded) == "boolean" || (embedded = false)
  var newline = false
  var spacer = function(depth) { var spaces = ""; for (var i=0;i<depth;i++) { spaces += "  "}; return spaces }
  var pretty = ""
  if (      typeof(object) == "undefined" ) { pretty += "undefined" }
  else if ( typeof(object) == "boolean" || 
            typeof(object) == "number" ) {    pretty += object.toString() } 
  else if ( typeof(object) == "string" ) {    pretty += "\"" + object + "\"" } 
  else if (        object  == null) {         pretty += "null" } 
  else if ( object instanceof(Array) ) {
    if ( object.length > 0 ) {
      if (embedded) { newline = true }
      var content = ""
      for each (var item in object) { content += pp(item, depth+1) + ",\n" + spacer(depth+1) }
      content = content.replace(/,\n\s*$/, "").replace(/^\s*/,"")
      pretty += "[ " + content + "\n" + spacer(depth) + "]"
    } else { pretty += "[]" }
  } 
  else if (typeof(object) == "object") {
    if ( Object.keys(object).length > 0 ){
      if (embedded) { newline = true }
      var content = ""
      for (var key in object) { 
        content += spacer(depth + 1) + key.toString() + ": " + pp(object[key], depth+2, true) + ",\n" 
      }
      content = content.replace(/,\n\s*$/, "").replace(/^\s*/,"")
      pretty += "{ " + content + "\n" + spacer(depth) + "}"
    } else { pretty += "{}"}
  }
  else { pretty += object.toString() }
  return ((newline ? "\n" + spacer(depth) : "") + pretty)
}

输出如下:

js> pp({foo:"bar", baz: 1})
{ foo: "bar",
  baz: 1
}
js> var taco
js> pp({foo:"bar", baz: [1,"taco",{"blarg": "moo", "mine": "craft"}, null, taco, {}], bleep: {a:null, b:taco, c: []}})
{ foo: "bar",
  baz: 
    [ 1,
      "taco",
      { blarg: "moo",
        mine: "craft"
      },
      null,
      undefined,
      {}
    ],
  bleep: 
    { a: null,
      b: undefined,
      c: []
    }
}

我还将其发布为Gist here,以便将来可能需要进行任何更改。

答案 7 :(得分:2)

jsDump

jsDump.parse([
    window,
    document,
    { a : 5, '1' : 'foo' },
    /^[ab]+$/g,
    new RegExp('x(.*?)z','ig'),
    alert, 
    function fn( x, y, z ){
        return x + y; 
    },
    true,
    undefined,
    null,
    new Date(),
    document.body,
    document.getElementById('links')
])

变为

[
   [Window],
   [Document],
   {
      "1": "foo",
      "a": 5
   },
   /^[ab]+$/g,
   /x(.*?)z/gi,
   function alert( a ){
      [code]
   },
   function fn( a, b, c ){
      [code]
   },
   true,
   undefined,
   null,
   "Fri Feb 19 2010 00:49:45 GMT+0300 (MSK)",
   <body id="body" class="node"></body>,
   <div id="links">
]

QUnit(jQuery使用的单元测试框架)使用jsDump的略微修补版本。


JSON.stringify()在某些情况下不是最佳选择。

JSON.stringify({f:function(){}}) // "{}"
JSON.stringify(document.body)    // TypeError: Converting circular structure to JSON

答案 8 :(得分:1)

以PhiLho的领先优势(非常感谢:)),我最后写了自己的东西,因为我无法让他做我想做的事。它非常粗糙和准备好,但它完成了我需要的工作。谢谢大家的好建议。

这不是出色的代码,我知道,但是对于它的价值,这就是它。有人可能觉得它很有用:

// Usage: dump(object)
function dump(object, pad){
    var indent = '\t'
    if (!pad) pad = ''
    var out = ''
    if (object.constructor == Array){
        out += '[\n'
        for (var i=0; i<object.length; i++){
            out += pad + indent + dump(object[i], pad + indent) + '\n'
        }
        out += pad + ']'
    }else if (object.constructor == Object){
        out += '{\n'
        for (var i in object){
            out += pad + indent + i + ': ' + dump(object[i], pad + indent) + '\n'
        }
        out += pad + '}'
    }else{
        out += object
    }
    return out
}

答案 9 :(得分:1)

这只是对Jason Bunting的“使用Crockford的JSON.stringify”的评论,但我无法在该答案中添加评论。

如评论中所述,JSON.stringify与Prototype(www.prototypejs.org)库不兼容。但是,通过暂时删除原型添加的Array.prototype.toJSON方法,运行Crockford的stringify(),然后像这样把它放回去,很容易让它们很好地结合在一起:

  var temp = Array.prototype.toJSON;
  delete Array.prototype.toJSON;
  $('result').value += JSON.stringify(profile_base, null, 2);
  Array.prototype.toJSON = temp;

答案 10 :(得分:1)

我认为J. Buntings对使用JSON.stringify的反应也很好。另外,如果碰巧使用YUI,可以通过YUIs JSON对象使用JSON.stringify。在我的情况下,我需要转储到HTML,因此更容易调整/剪切/粘贴PhiLho响应。

function dumpObject(obj, indent) 
{
  var CR = "<br />", SPC = "&nbsp;&nbsp;&nbsp;&nbsp;", result = "";
  if (indent == null) indent = "";

  for (var property in obj)
  {
    var value = obj[property];

    if (typeof value == 'string')
    {
      value = "'" + value + "'";
    }
    else if (typeof value == 'object')
    {
      if (value instanceof Array)
      {
        // Just let JS convert the Array to a string!
        value = "[ " + value + " ]";
      }
      else
      {
        var od = dumpObject(value, indent + SPC);
        value = CR + indent + "{" + CR + od + CR + indent + "}";
      }
    }
    result += indent + "'" + property + "' : " + value + "," + CR;
  }
  return result;
}

答案 11 :(得分:1)

很多人在这个帖子中编写代码,有很多关于各种问题的评论。我喜欢这个解决方案,因为它似乎完整,是一个没有依赖关系的单个文件。

browser

nodejs

它“开箱即用”并且具有节点和浏览器版本(可能只是不同的封装器,但我没有挖掘确认)。

该库还支持漂亮的打印XML,SQL和CSS,但我还没有尝试过这些功能。

答案 12 :(得分:1)

对于在 2021 年或 2021 年之后检查此问题的任何人

Check out this Other StackOverflow Answer by hassan

TLDR:

JSON.stringify(data,null,2)

这里的第三个参数是制表符/空格

答案 13 :(得分:0)

将元素打印为字符串的简单方法:

var s = "";
var len = array.length;
var lenMinus1 = len - 1
for (var i = 0; i < len; i++) {
   s += array[i];
   if(i < lenMinus1)  {
      s += ", ";
   }
}
alert(s);

答案 14 :(得分:0)

我的NeatJSON库同时包含Ruby和JavaScript versions。它是在(许可)MIT许可下免费提供的。您可以在以下位置查看在线演示/转换器:
http://phrogz.net/JS/neatjson/neatjson.html

某些功能(全部可选):

  • 包裹到特定宽度;如果一个对象或数组可以放在该行上,它就会保持在一行上。
  • 对齐对象中所有键的冒号。
  • 按字母顺序将键排序到对象。
  • 将浮点数格式化为特定的小数位数。
  • 包装时,请使用&#39;短片&#39;将数组和对象的开/关括号放在与第一个/最后一个值相同的行上的版本。
  • 以粒度方式控制数组和对象的空白(在括号内,冒号和逗号之前/之后)。
  • 在Web浏览器中工作,并作为Node.js模块。

答案 15 :(得分:-5)

flexjson包含一个prettyPrint()函数,可以为您提供所需的内容。