【快速入门系列】深入浅出JSON

2024年2月17日 204次阅读 来源: Miyang

前言

JSON（JavaScript Object Notation，JavaScript对象表示法）是JavaScript的一个严格的子集，利用了JavaScript中的一些模式来表示结构化数据。
JSON是一种数据格式，不是一种编程语言，虽然具有相同的语法格式，但JSON并不从属于JavaScript，也并不只有JavaScript才使用JSON，很多编程语言都有针对JSON的解析器和序列化器。

一、JSON

JSON的语法可以表示三种类型的值：简单值、对象和数组。

简单值

最简单的JSON数据形式就是简单值，如：
JSON表示数值7的方式：

7

JSON表示字符串的方式：

"Hello Miyang!"

JavaScript字符串与JSON字符串最大的区别在于，JSON字符串必须使用双引号。
布尔值和null也是有效的JSON形式。

对象

我们来对比一下JSON中的对象和JavaScript字面量：
JavaScript字面量：

var person = {
    name: "Miyang",
    age: 21
};

或

var person = {
    "name": "Miyang",
    "age": 21
};

在JSON中的对象要求必须给属性加引号：

{
    "name": "Miyang",
    "age": 21
}

相比两者，JSON没有声明变量，其次，末尾也没有分号，最重要的一点，对象的属性必须加双引号。
在实际使用中，我们经常会遇到这样的JSON数据：

{
    "name": "Miyang",
    "age": 21,
    "location": {
        "name": "Ping guo yuan",
        "city": "Beijing"
    }
}

虽然该JSON中存在两个name属性，但由于它们分别属于不同的对象，因此没有问题。同一个对象中绝对不应该出现两个同名属性。

数组

在JSON中，可以采用与JavaScript相同的语法表示一个数组：

["Miyang", 21, true]

同样的，JSON数组也没有变量和分号，数组和对象结合起来，可以构成较为复杂的数据集合。

[
    {
        "name": "Miyang",
        "age": 21,
        "hobby": ["HTML", "CSS", "Javascript"]        
    },
    {
        "name": "Miyang",
        "age": 21,
        "hobby": ["HTML", "CSS", "Javascript"]        
    },
    {
        "name": "Miyang",
        "age": 21,
        "hobby": ["HTML", "CSS", "Javascript"]        
    }
]

二、解析与序列化

JSON的流行，更重要的原因是可以把JSON数据结构解析为有用的JavaScript对象，相对于XML数据结构来说优势极为明显。如我们可以通过以下方法来获取某个属性：

person[0].name

JSON对象

早期JSON解析器基本通过JavaScript的eval()函数，但是存在风险，因为可能会执行一些恶意代码。从ECMAScript5开始，定义了全局对象JSON，可以更方便的对JSON进行解析与序列化。

JSON.stringify()

该方法可以将JavaScript对象序列化为一个JSON字符串，默认情况下，输出的字符串不包含任何空格字符或缩进，如：

var json = {
  "name": "Miyang",
  "age": 21
};

console.log(JSON.stringify(json));
// 输出结果
{"name":"Miyang","age":21}

在序列化JavaScript对象时，所有函数即原型成员都会被有意忽略，不体现在结果中，值为undefined的任何属性也会被跳过，如：

var json = {
  "name": "Miyang",
  "age": 21,
  "test": undefined
};

console.log(JSON.stringify(json));
// 输出结果
{"name":"Miyang","age":21}

JSON.parse()

该方法可以将JSON字符串转换为JSON对象，如：

var jsonTest = '{"name": "Miyang","age": 21,"test": "undefined"}';
console.log(JSON.parse(jsonTest));
// 输出结果
{ name: 'Miyang', age: 21, test: 'undefined' }

如果传给JSON.parse()的字符串不是有效的JSON，该方法会抛出错误。

序列化选项

JSON.stringfiy() 还可以接受两个参数，用于指定以不同方式序列化JavaScript对象。
第一个参数是过滤器，可以是一个数组，也可以是一个函数。
第二个参数是一个选项，表示是否在JSON字符串中保留缩进。

过滤结果

如果过滤器参数是数组，那么返回的结果就只包含数组中列出的属性，如：

var json = {
  "name": "Miyang",
  "age": 21
};
console.log(JSON.stringify(json, ["name"]));
// 输出结果
{"name":"Miyang"}

如果过滤器参数是函数，则该函数可以接收两个参数，属性名和属性值，随后根据函数对结果进行过滤，如：

var json = {
  "name": "Miyang",
  "age": 21,
  "hobby": ["HTML", "CSS"]
};
console.log(JSON.stringify(json, function(key, value) {
  switch(key) {
    case "name":
      return value + "!!!";
    case "age":
      return 18;
    case "hobby":
      return undefined;
    default:
      return value;
  }
}));
// 输出结果
{"name":"Miyang!!!","age":18}

这里注意，如果函数返回了undefined，那么相应的属性会被忽略。

字符串缩进

JSON.stringify()的第三个方法用于控制结果中的缩进和空白符，如果该参数是一个数值，则表示每个缩进的空格数，最大缩进为10，大于10的值会自动转换为10。当传入了有效缩进参数值，结果字符串就会包含换行符。

var json = {
  "name": "Miyang",
  "age": 21,
  "hobby": ["HTML", "CSS"]
};
console.log(JSON.stringify(json, null, 2));
// 输出结果
{
  "name": "Miyang",
  "age": 21,
  "hobby": [
    "HTML",
    "CSS"
  ]
}

如果缩进参数是一个字符串，则这个字符串将在JSON字符串在作为缩进字符，同样的，长度不能超过10个字符长，否则只显示前10个字符。

var json = {
  "name": "Miyang",
  "age": 21,
  "hobby": ["HTML", "CSS"]
};
console.log(JSON.stringify(json, null, '-'));
// 输出结果
{
-"name": "Miyang",
-"age": 21,
-"hobby": [
--"HTML",
--"CSS"
-]
}

toJSON()方法

当JSON.stringify()不能满足需求时，可以给对象定义toJSON()方法，返回其自身的JSON数据格式。

var json = {
  "name": "Miyang",
  "age": 21,
  "address": {
    "city": "Beijing"
  },
  toJSON: function() {
    return this.name;
  }
};
console.log(JSON.stringify(json));
// 输出结果
"Miyang"

可以让这个方法返回undefined，如果此时包含它的对象嵌入在另一个对象中，会导致它的值变成null，如果是顶级对象，则返回undefined。

var json = {
  "name": "Miyang",
  "age": 21,
  "address": {
    "city": "Beijing"
  },
  toJSON: function() {
    return undefined;
  }
};
console.log(JSON.stringify(json));
// 输出结果
undefined
var json = {
  "name": "Miyang",
  "age": 21,
  "address": {
    "city": "Beijing",
    toJSON: function() {
      return undefined;
    }
  }
};
console.log(JSON.stringify(json));
// 输出结果
{"name":"Miyang","age":21}

序列化内部工作顺序

我们需要了解一下序列化内部工作顺序，假设把一个对象传入JSON.stringify()，序列化该对象的顺序如下：

  1. 如果存在toJSON()方法而且能取得有效值，则调用该方法，否则返回对象本身。
  2. 如果提供了第二个参数，应用这个函数过滤器，传入的值是第1步返回的值。
  3. 对第2步返回的每个值进行相应的序列化。
  4. 如果提供了第三个参数，执行相应的格式化。

解析选项

JSON.parse()也可以接收另一个参数，该参数是一个函数，对每个键值对进行调用，被称之为还原函数。同样的，它接收两个参数，一个键和一个值，且需要返回一个值。
如果返回undefined，则表示要从结果中删除相应的键，如果返回其他值，则将该值插入到结果中，在将日期字符串转换为Date对象时，经常用到还原函数。

var json = {
  "name": "Miyang",
  "age": 21,
  "address": {
    "city": "Beijing"
  },
  "date": new Date(2011, 11, 1)
};
var jsonText = JSON.stringify(json);

var jsonCopy = JSON.parse(jsonText, function(key, value) {
  if(key === "date") {
    return new Date(value);
  }else {
    return value;
  }
});
console.log(jsonCopy.date.getTime());
// 输出结果
1322668800000

结束语

JSON是一个轻量级的数据格式，可以简化表示复杂数据结构的工作量，了解其结构、掌握JavaScript对其的操作方法，可以更便捷的进行前后台交互或数据处理。

参考资料：JavaScript高级程序设计（第三版）第20章

    原文作者：Miyang
    原文地址: https://segmentfault.com/a/1190000014834511
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞