萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JavaScript JSON 格式化美化輸出工具函式完整實作

功能需求

將 JSON 物件或字串格式化為帶縮排、換行的易讀字串,方便在網頁 <pre> 標籤中顯示除錯。

完整格式化函式

var formatJson = function(json, options) {
  var reg = null, formatted = '', pad = 0, PADDING = '  '; // 兩空格縮排
  options = options || {};
  options.newlineAfterColonIfBeforeBraceOrBracket = (options.newlineAfterColonIfBeforeBraceOrBracket === true);
  options.spaceAfterColon = (options.spaceAfterColon !== false); // 預設 true

  // 統一轉為字串再解析,移除多餘空白
  if (typeof json !== 'string') {
    json = JSON.stringify(json);
  } else {
    json = JSON.parse(json);
    json = JSON.stringify(json);
  }

  // 1. 大括號、中括號前後加換行
  json = json.replace(/([{}])/g, '\r\n$1\r\n');
  json = json.replace(/([\[\]])/g, '\r\n$1\r\n');
  // 2. 逗號後加換行
  json = json.replace(/(,)/g, '$1\r\n');
  // 3. 移除多餘空行
  json = json.replace(/(\r\n\r\n)/g, '\r\n');
  // 4. 移除逗號前的換行
  json = json.replace(/\r\n,/g, ',');

  // 選項處理
  if (!options.newlineAfterColonIfBeforeBraceOrBracket) {
    json = json.replace(/:\r\n{/g, ':{');
    json = json.replace(/:\r\n\[/g, ':[');
  }
  if (options.spaceAfterColon) {
    json = json.replace(/:/g, ': ');
  }

  // 逐行處理縮排
  $.each(json.split('\r\n'), function(index, node) {
    var i = 0, indent = 0, padding = '';
    if (node.match(/^\{$/) || node.match(/^\[$/)) indent = 1;       // 開頭 { 或 [ 增加縮排
    else if (node.match(/\}$/) || node.match(/\]$/)) { if (pad !== 0) pad -= 1; } // 結尾 } 或 ] 減少縮排
    else indent = 0;

    for (i = 0; i < pad; i++) padding += PADDING;
    formatted += padding + node + '\r\n';
    pad += indent;
  });

  return formatted;
};

使用範例

var data = { 
  user: { id: 1, name: "Alice", roles: ["admin", "editor"] },
  meta: { created: "2024-01-01", active: true }
};

console.log(formatJson(data));
// 輸出:
// {
//   "user": {
//     "id": 1,
//     "name": "Alice",
//     "roles": [
//       "admin",
//       "editor"
//     ]
//   },
//   "meta": {
//     "created": "2024-01-01",
//     "active": true
//   }
// }

參數選項

選項型別預設說明
newlineAfterColonIfBeforeBraceOrBracketBooleanfalse冒號後若接 { 或 [ 是否換行
spaceAfterColonBooleantrue冒號後是否加空格

此函式相依 jQuery 的 $.each,若專案無 jQuery 可輕易改為原生 forEach。

copyright © 萬盛學電腦網 all rights reserved