Formatowanie danych JavaScript / ładna drukarka

Próbuję znaleźć sposób na pretty printstrukturę danych JavaScript w postaci czytelnej dla człowieka do debugowania.

Mam dość dużą i skomplikowaną strukturę danych przechowywaną w JS i muszę napisać kod, aby nim manipulować. Aby dowiedzieć się, co robię i co robię źle, naprawdę potrzebuję możliwości zobaczenia całej struktury danych i zaktualizowania jej za każdym razem, gdy wprowadzam zmiany za pośrednictwem interfejsu użytkownika.

Z tym wszystkim mogę sobie poradzić, poza znalezieniem fajnego sposobu na zrzucenie struktury danych JavaScript do ciągu czytelnego dla człowieka. JSON by się nadał, ale naprawdę musi być ładnie sformatowany i z wcięciami. Zwykle używałbym do tego doskonałego narzędzia do dumpingu DOM Firebuga, ale naprawdę muszę być w stanie zobaczyć całą strukturę na raz, co wydaje się nie być możliwe w Firebug.

Wszelkie sugestie są mile widziane.

Z góry dziękuję.

Napisałem funkcję do zrzutu obiektu JS w czytelnej formie, chociaż wynik nie jest wcięty, ale nie powinno być zbyt trudne, aby to dodać: zrobiłem tę funkcję z jednej, którą stworzyłem dla Lua (która jest znacznie bardziej złożona ), który rozwiązał ten problem z wcięciami.

Oto „prosta” wersja:

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;
}

Popatrzę, jak to poprawić.
Uwaga 1: Aby go użyć, zrób od = DumpObject(something)i użyj od.dump. Zagmatwane, ponieważ chciałem, aby wartość len (liczba elementów) też miała inny cel. Sprawienie, by funkcja zwracała tylko ciąg znaków, jest trywialne.
Uwaga 2: nie obsługuje pętli w referencjach.

EDYTOWAĆ

Zrobiłem wersję z wcięciem.

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$/, "");
}

Wybierz wcięcie w wierszu z wywołaniem rekurencyjnym, a styl nawiasów klamrowych, przełączając skomentowaną linię po tym.

... Widzę, że stworzyłeś swoją własną wersję, co jest dobre. Zwiedzający będą mieli wybór.

Użyj JSON.stringify Crockforda w następujący sposób:

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...

Zmienna textwyglądałaby następująco:

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

Nawiasem mówiąc, nie wymaga to niczego więcej niż tego pliku JS - będzie działać z każdą biblioteką itp.

Możesz użyć następujących

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

W Firebug, jeśli tylko console.debug ("%o", my_object)możesz kliknąć na niego w konsoli i wejść do interaktywnego eksploratora obiektów. Pokazuje cały obiekt i pozwala rozwinąć zagnieżdżone obiekty.

W przypadku Node.js użyj:

util.inspect(object, [options]);

Dokumentacja API

Dla tych, którzy szukają niesamowitego sposobu, aby zobaczyć swój obiekt, sprawdź prettyPrint.js

Tworzy tabelę z konfigurowalnymi opcjami widoku do wydrukowania gdzieś w dokumencie. Lepiej patrzeć niż w console.

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

Programuję Rhinoi nie zadowalała mnie żadna z zamieszczonych tutaj odpowiedzi. Napisałem więc własną ładną drukarkę:

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)
}

Wynik wygląda następująco:

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: []
    }
}

Opublikowałem to również jako podsumowanie tutaj wszelkich przyszłych zmian, które mogą być wymagane.

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')
])

staje się

[
   [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 (framework do testów jednostkowych używany przez jQuery) przy użyciu lekko poprawionej wersji jsDump.

JSON.stringify () nie jest najlepszym wyborem w niektórych przypadkach.

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

Idąc za przykładem PhiLho (bardzo dziękuję :)), napisałem własną, ponieważ nie mogłem zmusić go do zrobienia tego, co chciałem. Jest dość szorstki i gotowy, ale spełnia moje wymagania. Dziękuję wszystkim za doskonałe sugestie.

Wiem, że to nie jest genialny kod, ale warto. Ktoś może uznać to za przydatne:

// 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
}

To tak naprawdę tylko komentarz do artykułu Jasona Buntinga „Użyj JSON.stringify Crockforda”, ale nie byłem w stanie dodać komentarza do tej odpowiedzi.

Jak zauważono w komentarzach, JSON.stringify nie współpracuje dobrze z biblioteką Prototype (www.prototypejs.org). Jednak dość łatwo jest sprawić, że będą dobrze ze sobą współpracować, tymczasowo usuwając metodę Array.prototype.toJSON, którą dodaje prototyp, uruchom stringify () Crockforda, a następnie umieść ją z powrotem w następujący sposób:

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

Myślałem, że odpowiedź J. Buntings na temat używania JSON.stringify była również dobra. A na marginesie, jeśli używasz YUI, możesz użyć JSON.stringify za pośrednictwem obiektu YUI JSON. W moim przypadku musiałem zrzucić do HTML, więc łatwiej było po prostu poprawić / wyciąć / wkleić odpowiedź 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;
}

Wiele osób piszących kod w tym wątku, z wieloma komentarzami na temat różnych problemów. Podobało mi się to rozwiązanie, ponieważ wydawało się kompletne i był to pojedynczy plik bez zależności.

przeglądarka

nodejs

Działało „po wyjęciu z pudełka” i ma wersje dla węzłów i przeglądarki (prawdopodobnie tylko różne opakowania, ale nie szukałem potwierdzenia).

Biblioteka obsługuje również ładne drukowanie XML, SQL i CSS, ale nie próbowałem tych funkcji.

Prosty do drukowania elementów jako ciągów:

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);

Moja biblioteka NeatJSON ma wersje Ruby i JavaScript . Jest dostępny bezpłatnie na (liberalnej) licencji MIT. Możesz obejrzeć demo / konwerter online pod adresem :
http://phrogz.net/JS/neatjson/neatjson.html

Niektóre funkcje (wszystkie opcjonalne):

• Zawiń do określonej szerokości; jeśli obiekt lub tablica zmieści się w linii, to jest trzymana w jednej linii.
• Wyrównaj dwukropki dla wszystkich kluczy w obiekcie.
• Posortuj klucze do obiektu alfabetycznie.
• Sformatuj liczby zmiennoprzecinkowe do określonej liczby miejsc po przecinku.
• Podczas zawijania użyj „krótkiej” wersji, która umieszcza nawiasy otwierające / zamykające dla tablic i obiektów w tym samym wierszu, co pierwsza / ostatnia wartość.
• Kontroluj spacje dla tablic i obiektów w sposób szczegółowy (w nawiasach, przed / po dwukropkach i przecinkach).
• Działa w przeglądarce internetowej oraz jako moduł Node.js.

flexjson zawiera funkcję prettyPrint (), która może dać ci to, czego chcesz.