JavaScript JSON.stringify()

JavaScript JSON.stringify()

JSON.stringify() 方法用于將 JavaScript 值轉(zhuǎn)換為 JSON 字符串。

語法

JSON.stringify(value[, replacer[, space]])

參數(shù)說明：

• value: 必需， 將要序列化成 一個JSON 字符串的值。
• replacer: 如果該參數(shù)是一個函數(shù)，則在序列化過程中，被序列化的值的每個屬性都會經(jīng)過該函數(shù)的轉(zhuǎn)換和處理；如果該參數(shù)是一個數(shù)組，則只有包含在這個數(shù)組中的屬性名才會被序列化到最終的 JSON 字符串中；如果該參數(shù)為null或者未提供，則對象所有的屬性都會被序列化；關(guān)于該參數(shù)更詳細(xì)的解釋和示例，請參考使用原生的 JSON 對象一文。
• space: 可選，指定縮進(jìn)用的空白字符串，用于美化輸出（pretty-print）；如果參數(shù)是個數(shù)字，它代表有多少的空格；上限為10。該值若小于1，則意味著沒有空格；如果該參數(shù)為字符串(字符串的前十個字母)，該字符串將被作為空格；如果該參數(shù)沒有提供（或者為null）將沒有空格。

返回值：

一個表示給定值的JSON字符串。

實(shí)例

var str = {"name":"W3Cschool", "site":"http://hgci.cn"}
str_pretty1 = JSON.stringify(str)
document.write( "只有一個參數(shù)情況：" );
document.write( "<br>" );
document.write("<pre>" + str_pretty1 + "</pre>" );
 
document.write( "<br>" );
str_pretty2 = JSON.stringify(str, null, 4) //使用四個空格縮進(jìn)
document.write( "使用參數(shù)情況：" );
document.write( "<br>" );
document.write("<pre>" + str_pretty2 + "</pre>" ); // pre 用于格式化輸出

描述

關(guān)于序列化，有下面五點(diǎn)注意事項：

• 非數(shù)組對象的屬性不能保證以特定的順序出現(xiàn)在序列化后的字符串中。
• 布爾值、數(shù)字、字符串的包裝對象在序列化過程中會自動轉(zhuǎn)換成對應(yīng)的原始值。
• undefined、任意的函數(shù)以及 symbol 值，在序列化過程中會被忽略（出現(xiàn)在非數(shù)組對象的屬性值中時）或者被轉(zhuǎn)換成 null（出現(xiàn)在數(shù)組中時）。
• 所有以 symbol 為屬性鍵的屬性都會被完全忽略掉，即便 replacer 參數(shù)中強(qiáng)制指定包含了它們。
• 不可枚舉的屬性會被忽略

JSON.stringify({});                        // '{}'
JSON.stringify(true);                      // 'true'
JSON.stringify("foo");                     // '"foo"'
JSON.stringify([1, "false", false]);       // '[1,"false",false]'
JSON.stringify({ x: 5 });                  // '{"x":5}'

JSON.stringify({x: 5, y: 6});              
// "{"x":5,"y":6}"

JSON.stringify([new Number(1), new String("false"), new Boolean(false)]); 
// '[1,"false",false]'

JSON.stringify({x: undefined, y: Object, z: Symbol("")}); 
// '{}'

JSON.stringify([undefined, Object, Symbol("")]);          
// '[null,null,null]' 

JSON.stringify({[Symbol("foo")]: "foo"});                 
// '{}'

JSON.stringify({[Symbol.for("foo")]: "foo"}, [Symbol.for("foo")]);
// '{}'

JSON.stringify(
    {[Symbol.for("foo")]: "foo"}, 
    function (k, v) {
        if (typeof k === "symbol"){
            return "a symbol";
        }
    }
);


// undefined 

// 不可枚舉的屬性默認(rèn)會被忽略：
JSON.stringify( 
    Object.create(
        null, 
        { 
            x: { value: 'x', enumerable: false }, 
            y: { value: 'y', enumerable: true } 
        }
    )
);

// "{"y":"y"}"

replacer參數(shù)

replacer參數(shù)可以是一個函數(shù)或者一個數(shù)組。作為函數(shù)，它有兩個參數(shù)，鍵(key)值(value)都會被序列化。

• 如果返回一個 Number, 轉(zhuǎn)換成相應(yīng)的字符串被添加入JSON字符串。
• 如果返回一個 String, 該字符串作為屬性值被添加入JSON。
• 如果返回一個 Boolean, "true" 或者 "false"被作為屬性值被添加入JSON字符串。
• 如果返回任何其他對象，該對象遞歸地序列化成JSON字符串，對每個屬性調(diào)用replacer方法。除非該對象是一個函數(shù)，這種情況將不會被序列化成JSON字符串。
• 如果返回undefined，該屬性值不會在JSON字符串中輸出。

注意: 不能用replacer方法，從數(shù)組中移除值(values)，如若返回undefined或者一個函數(shù)，將會被null取代。

例子(function)

function replacer(key, value) {
  if (typeof value === "string") {
    return undefined;
  }
  return value;
}

var foo = {foundation: "Mozilla", model: "box", week: 45, transport: "car", month: 7};
var jsonString = JSON.stringify(foo, replacer);

JSON序列化結(jié)果為 {"week":45,"month":7}.

例子(array)

如果replacer是一個數(shù)組，數(shù)組的值代表將被序列化成JSON字符串的屬性名。

JSON.stringify(foo, ['week', 'month']);  
// '{"week":45,"month":7}', 只保留“week”和“month”屬性值。

space 參數(shù)

space 參數(shù)用來控制結(jié)果字符串里面的間距。如果是一個數(shù)字, 則在字符串化時每一級別會比上一級別縮進(jìn)多這個數(shù)字值的空格（最多10個空格）；如果是一個字符串，則每一級別會比上一級別多縮進(jìn)用該字符串（或該字符串的前十個字符）。

JSON.stringify({ a: 2 }, null, " ");   // '{\n "a": 2\n}'

使用制表符（\t）來縮進(jìn)：

JSON.stringify({ uno: 1, dos : 2 }, null, '\t')
// '{            \
//     "uno": 1, \
//     "dos": 2  \
// }'

toJSON 方法

如果一個被序列化的對象擁有 toJSON 方法，那么該 toJSON 方法就會覆蓋該對象默認(rèn)的序列化行為：不是那個對象被序列化，而是調(diào)用 toJSON 方法后的返回值會被序列化，例如：

var obj = {
  foo: 'foo',
  toJSON: function () {
    return 'bar';
  }
};
JSON.stringify(obj);      // '"bar"'
JSON.stringify({x: obj}); // '{"x":"bar"}'