從 API 拿到的 JSON 常常是一整行壓縮過的字串,除錯時完全看不出結構。本文實作一個格式化函式,把 JSON 字串或物件轉成有縮排、有換行的可讀形式,方便直接在網頁上呈現。
var formatJson = function(json, options) {
var reg = null, formatted = '', pad = 0, PADDING = '';
// 可選設定
options = options || {};
// 冒號後、遇到 { 或 [ 時是否要換行
options.newlineAfterColonIfBeforeBraceOrBracket =
(options.newlineAfterColonIfBeforeBraceOrBracket === true) ? true : false;
// 冒號後是否加一個空格
options.spaceAfterColon = (options.spaceAfterColon === false) ? false : true;
// 確保輸入是字串:物件先 stringify,字串則 parse 後再 stringify 以正規化空白
if (typeof json !== 'string') {
json = JSON.stringify(json);
} else {
json = JSON.parse(json);
json = JSON.stringify(json);
}
// 在 { } 前後加換行
reg = /([{}])/g;
json = json.replace(reg, '\r\n$1\r\n');
// 在 [ ] 前後加換行
reg = /([[\]])/g;
json = json.replace(reg, '\r\n$1\r\n');
// 逗號後換行
reg = /(,)/g;
json = json.replace(reg, '$1\r\n');
// 清掉重複換行
reg = /(\r\n\r\n)/g;
json = json.replace(reg, '\r\n');
// 移除逗號前的換行
reg = /\r\n,/g;
json = json.replace(reg, ',');
// 可選:冒號後若非接 { 或 [ 則不換行
if (!options.newlineAfterColonIfBeforeBraceOrBracket) {
reg = /:\r\n{/g;
json = json.replace(reg, ':{');
reg = /:\r\n\[/g;
json = json.replace(reg, ':[');
}
// 可選:冒號後補一個空格
if (options.spaceAfterColon) {
reg = /:/g;
json = json.replace(reg, ': ');
}
// 逐行計算縮排層級
$.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;
};
整個程式的靈魂是最後那個迴圈裡的 pad 變數。它記錄「目前應該縮排幾層」,並依三種情況調整:
{ 或 [ 結尾 → 下一行要加一層(indent = 1)} 或 ] → 這行本身要先減一層再輸出注意第二種情況的順序:先 pad -= 1 才組字串,所以閉合括號會與對應的開括號對齊,這是正確縮排的必要條件。
前面的正則替換則負責「先斷行」:在每個括號與逗號前後插入換行符,把壓縮的一整行切成一行一個 token,後面的縮排迴圈才有東西可處理。
ES5 之後,JSON.stringify 已經內建了這個能力,第三個參數就是縮排的空白數:
var obj = { name: "小明", tags: ["js", "css"], nested: { a: 1 } };
// 美化輸出,用 2 個空格縮排
console.log(JSON.stringify(obj, null, 2));
// 用 tab 縮排
console.log(JSON.stringify(obj, null, '\t'));
// 過濾特定欄位(第四個參數 replacer)
console.log(JSON.stringify(obj, ['name', 'tags'], 2));
輸出會是:
{
"name": "小明",
"tags": [
"js",
"css"
],
"nested": {
"a": 1
}
}
所以上面那個長函式的存在意義,主要在理解原理:為什麼縮排要「遇到開括號加一層、遇到閉括號減一層」,以及正則替換如何把結構符號轉為換行點。這些思路在實作自訂的設定檔格式、或處理非標準 JSON 時都用得上。
如果只是要在網頁上顯示,格式化之後通常還會想上色:
function syntaxHighlight(json) {
json = JSON.stringify(json, null, 2);
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)) {
cls = /:$/.test(match) ? 'key' : 'string';
} else if (/true|false/.test(match)) {
cls = 'boolean';
} else if (/null/.test(match)) {
cls = 'null';
}
return '<span class="' + cls + '">' + match + '</span>';
});
}
比對順序很重要:字串規則放在最前面並用 (\s*:)? 判斷它是鍵還是值,這樣才能正確區分 "key": 與 "value"。