Skip to content

Latest commit

 

History

History
919 lines (646 loc) · 23.2 KB

json.md

File metadata and controls

919 lines (646 loc) · 23.2 KB
Raw

learn.json.md

资料收集整理自runoob.json, 版权归原作者所有.

JSON教程

JSON: JavaScript Object Notation (JavaScript 对象表示法)

JSON 是存储和交换文本信息的语法. 类似 XML .

JSON 比 XML 更小, 更快, 更易解析.

key必须是字符串, value可以是合法的JSON数据类型(字符串, 数字, 对象,数组, 布尔值或null).

什么是JSON

  • JSON 指的是 JavaScript 对象表示法(JavaScript Object Notation)
  • JSON 是轻量级的文本数据交换格式
  • JSON 独立于语言: JSON 使用 Javascript语法来描述数据对象, 但是 JSON 仍然独立于语言和平台JSON 解析器和 JSON 库支持许多不同的编程语言. 目前非常多的动态(PHP, JSP, .NET)编程语言支持JSON.
  • JSON 具有自我描述性, 更易理解

JSON转换为JavaScript 对象

JSON 文本格式在语法上与创建 JavaScript 对象的代码相同.

由于这种相似性, 无需解析器, JavaScript 程序能够使用内建的 eval()函数, 用 JSON 数据来生成原生的 JavaScript 对象

JSON简介

在线

var JSONObject= {
    "name":"菜鸟教程",
    "url":"www.runoob.com",
    "slogan":"学的不仅是技术, 更是梦想!"
};

与XML相同之处

  • JSON 是纯文本
  • JSON 具有"自我描述性"(人类可读)
  • JSON 具有层级结构(值中存在值)
  • JSON 可通过 JavaScript 进行解析
  • JSON 数据可使用 AJAX 进行传输

与XML不同之处

  • 没有结束标签
  • 更短
  • 读写的速度更快
  • 能够使用内建的 JavaScript eval() 方法进行解析
  • 使用数组
  • 不使用保留字

为什么使用JSON

对于 AJAX 应用程序来说, JSON 比 XML 更快更易使用:

使用 XML

  • 读取 XML 文档
  • 使用 XML DOM 来循环遍历文档
  • 读取值并存储在变量中

使用 JSON

  • 读取 JSON 字符串
  • 用 eval() 处理 JSON 字符串

JSON语法

JSON 语法是 JavaScript 语法的子集.

JSON语法规则

JSON 语法是 JavaScript 对象表示语法的子集.

  • 数据在名称/值对中
  • 数据由逗号分隔
  • 大括号保存对象
  • 中括号保存数组

JSON名称/值对

JSON 数据的书写格式是: 名称/值对.

名称/值对包括字段名称(在双引号中), 后面写一个冒号, 然后是值:

"name" : "菜鸟教程"

这很容易理解, 等价于这条 JavaScript 语句:

name = "菜鸟教程"

JSON值

JSON 值可以是:

  • 数字(整数或浮点数)
  • 字符串(在双引号中)
  • 逻辑值( true 或 false )
  • 数组(在中括号中)
  • 对象(在大括号中)
  • null

JSON数字

JSON 数字可以是整型或者浮点型: { "age":30 }

JSON-对象

对象在大括号({})中书写:

JSON对象可以包含多个名称/值对

{ "name":"菜鸟教程" , "url":"www.runoob.com" }

这一点也容易理解, 与这条 JavaScript 语句等价:

name = "菜鸟教程"
url = "www.runoob.com"

JSON数组

JSON 数组在中括号中书写:

数组可包含多个对象:

{
"sites": [
{ "name":"菜鸟教程" , "url":"www.runoob.com" },
{ "name":"google" , "url":"www.google.com" },
{ "name":"微博" , "url":"www.weibo.com" }
]
}

在上面的例子中, 对象 "sites" 是包含三个对象的数组. 每个对象代表一条关于某个网站( name , url )的记录.

JSON布尔值

JSjsonON 布尔值可以是 true 或者 false:

{ "flag":true }

JSON-null

JSON 可以设置 null 值:

{ "runoob":null }

JSON使用JavaScript语法

因为 JSON 使用 JavaScript 语法, 所以无需额外的软件就能处理 JavaScript 中的 JSON.

通过 JavaScript, 您可以创建一个对象数组, 并像这样进行赋值:

var sites = [
    { "name":"runoob" , "url":"www.runoob.com" },
    { "name":"google" , "url":"www.google.com" },
    { "name":"微博" , "url":"www.weibo.com" }
];

可以像这样访问 JavaScript 对象数组中的第一项(索引从 0 开始):

sites[0].name;

返回的内容是:

runoob

可以像这样修改数据:

sites[0].name="菜鸟教程";

JSON-文件

  • JSON 文件的文件类型是 ".json"
  • JSON 文本的 MIME 类型是 "application/json"

JSON-对象-2

对象语法

{ "name":"runoob", "alexa":10000, "site":null }

JSON对象在大括号({})中书写. 对象可以包含多个key/value(键/值)对. key必须是字符串, value可以是合法的JSON数据类型(字符串, 数字, 对象,数组, 布尔值或null).

key和value使用冒号(:)分割.

每个key/value对, 使用逗号(,)分割.

访问对象值

你可以使用点号(.)来访问对象的值:

var myObj, x;
myObj = { "name":"runoob", "alexa":10000, "site":null };
x = myObj.name;

你也可以使用中括号([])来访问对象的值:

var myObj, x;
myObj = { "name":"runoob", "alexa":10000, "site":null };
x = myObj["name"];

循环对象的属性

你可以使用 for-in 来循环对象的属性:

var myObj = { "name":"runoob", "alexa":10000, "site":null };
for (x in myObj) {
    document.getElementById("demo").innerHTML += x + "<br>";
}

在for-in循环对象的属性时, 使用中括号([])来访问属性的值:

var myObj = { "name":"runoob", "alexa":10000, "site":null };
for (x in myObj) {
    document.getElementById("demo").innerHTML += myObj[x] + "<br>";
}

嵌套 JSON 对象

JSON对象中可以包含另外一个JSON对象:

myObj = {
    "name":"runoob",
    "alexa":10000,
    "sites": {
        "site1":"www.runoob.com",
        "site2":"m.runoob.com",
        "site3":"c.runoob.com"
    }
}

你可以使用点号(.)或者中括号([])来访问嵌套的JSON对象.

x = myObj.sites.site1;
// 或者
x = myObj.sites["site1"];

修改值

你可以使用点号(.)来修改JSON对象的值:

myObj.sites.site1 = "www.google.com";

当然也可以使用中括号([])来修改 JSON 对象的值:

myObj.sites["site1"] = "www.google.com";

删除对象属性

我们可以使用delete关键字来删除JSON对象的属性:

delete myObj.sites.site1;

你可以使用中括号([])来删除 JSON 对象的属性:

delete myObj.sites["site1"]

JSON数组-2

数组作为 JSON 对象

[ "Google", "Runoob", "Taobao" ]

JSON 数组在中括号中书写. JSON 中数组值必须是合法的 JSON 数据类型(字符串, 数字, 对象, 数组, 布尔值或 null ).

JavaScript 中, 数组值可以是以上的 JSON 数据类型, 也可以是 JavaScript 的表达式, 包括函数, 日期, 及 undefined.

JSON对象中的数组

对象属性的值可以是一个数组:

{
"name":"网站",
"num":3,
"sites":[ "Google", "Runoob", "Taobao" ]
}

我们可以使用索引值来访问数组:

x = myObj.sites[0];

循环数组元素

你可以使用 for-in 来访问数组:

for (i in myObj.sites) {
    x += myObj.sites[i] + "<br>";
}

你也可以使用 for 循环:

for (i = 0; i < myObj.sites.length; i++) {
    x += myObj.sites[i] + "<br>";
}

嵌套JSON对象中的数组

JSON 对象中数组可以包含另外一个数组, 或者另外一个 JSON 对象:

myObj = {
    "name":"网站",
    "num":3,
    "sites": [
        { "name":"Google", "info":[ "Android", "Google 搜索", "Google 翻译" ] },
        { "name":"Runoob", "info":[ "菜鸟教程", "菜鸟工具", "菜鸟微信" ] },
        { "name":"Taobao", "info":[ "淘宝", "网购" ] }
    ]
}

我们可以使用 for-in 来循环访问每个数组:

for (i in myObj.sites) {
    x += "<h1>" + myObj.sites[i].name + "</h1>";
    for (j in myObj.sites[i].info) {
        x += myObj.sites[i].info[j] + "<br>";
    }
}

修改数组值

你可以使用索引值来修改数组值:

myObj.sites[1] = "Github";

删除数组元素

我们可以使用 delete 关键字来删除数组元素:

delete myObj.sites[1];

JSON.parse()

JSON 通常用于与服务端交换数据. 在接收服务器数据时一般是字符串. 我们可以使用 JSON.parse() 方法将数据转换为 JavaScript 对象.

.parse()语法

JSON.parse(text[, reviver])

参数说明:

  • text:必需, 一个有效的 JSON 字符串.
  • reviver: 可选, 一个转换结果的函数, 将为对象的每个成员调用此函数.

JSON 解析实例

例如我们从服务器接收了以下数据:

{ "name":"runoob", "alexa":10000, "site":"www.runoob.com" }

我们使用JSON.parse()方法处理以上数据, 将其转换为JavaScript对象:

var obj = JSON.parse('{ "name":"runoob", "alexa":10000, "site":"www.runoob.com" }');

解析前要确保你的数据是标准的 JSON 格式, 否则会解析出错. 你可以使用我们的在线工具检测 .

解析完成后, 我们就可以在网页上使用 JSON 数据了:

<p id="demo"></p>

<script>
var obj = JSON.parse('{ "name":"runoob", "alexa":10000, "site":"www.runoob.com" }');
document.getElementById("demo").innerHTML = obj.name + ": " + obj.site;
</script>

从服务端接收JSON数据

我们可以使用AJAX从服务器请求JSON数据, 并解析为JavaScript对象.

var xmlhttp = new XMLHttpRequest();
xmlhttp.onreadystatechange = function() {
    if (this.readyState == 4 && this.status == 200) {
        myObj = JSON.parse(this.responseText);
        document.getElementById("demo").innerHTML = myObj.name;
    }
};
xmlhttp.open("GET", "/try/ajax/json_demo.txt", true);
xmlhttp.send();

查看服务端数据: json_demo.txt

从服务端接收数组的JSON数据

如果从服务端接收的是数组的 JSON 数据, 则 JSON.parse 会将其转换为 JavaScript 数组:

var xmlhttp = new XMLHttpRequest();
xmlhttp.onreadystatechange = function() {
    if (this.readyState == 4 && this.status == 200) {
        myArr = JSON.parse(this.responseText);
        document.getElementById("demo").innerHTML = myArr[1];
    }
};
xmlhttp.open("GET", "/try/ajax/json_demo_array.txt", true);
xmlhttp.send();

查看服务端数据: json_demo_array.txt

异常

解析数据

JSON 不能存储 Date 对象. 如果你需要存储 Date 对象, 需要将其转换为字符串. 之后再将字符串转换为 Date 对象.

var text = '{ "name":"Runoob", "initDate":"2013-12-14", "site":"www.runoob.com"}';
var obj = JSON.parse(text);
obj.initDate = new Date(obj.initDate);

document.getElementById("demo").innerHTML = obj.name + "创建日期: " + obj.initDate;

我们可以启用 JSON.parse 的第二个参数 reviver , 一个转换结果的函数, 对象的每个成员调用此函数.

var text = '{ "name":"Runoob", "initDate":"2013-12-14", "site":"www.runoob.com"}';
var obj = JSON.parse
(
    text, function (key, value)
{
    if (key == "initDate")
    {
        return new Date(value);
    }
    else
    {
        return value;
    }
}
);

document.getElementById("demo").innerHTML = obj.name + "创建日期: " + obj.initDate;

解析函数

JSON 不允许包含函数, 但你可以将函数作为字符串存储, 之后再将字符串转换为函数.

var text = '{ "name":"Runoob", "alexa":"function () {return 10000;}", "site":"www.runoob.com"}';
var obj = JSON.parse(text);
obj.alexa = eval("(" + obj.alexa + ")");

document.getElementById("demo").innerHTML = obj.name + " Alexa 排名: " + obj.alexa();

不建议在 JSON 中使用函数.

浏览器支持

主流浏览器都支持 JSON.parse() 函数:

  • Firefox 3.5
  • Internet Explorer 8
  • Chrome
  • Opera 10
  • Safari 4

JSON.stringify()

JSON 通常用于与服务端交换数据. 在向服务器发送数据时一般是字符串. 我们可以使用 JSON.stringify() 方法将 JavaScript 对象转换为字符串.

也参见 MDN web docs

语法

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

or, be specific

JSON.stringify(<json>,[function],[space])

参数说明:

  • value: 必需 将要序列化成 一个 JSON 字符串的值.
  • replacer: 可选 如果该参数是一个函数, 则在序列化过程中, 被序列化的值的每个属性都会经过该函数的转换和处理; 如果该参数是一个数组, 则只有包含在这个数组中的属性名才会被序列化到最终的 JSON 字符串中; 如果该参数为 null 或者未提供, 则对象所有的属性都会被序列化; 关于该参数更详细的解释和示例, 请参考使用原生的 JSON 对象一文.
  • space: 可选 指定缩进用的空白字符串, 用于美化输出(pretty-print); 如果参数是个数字, 它代表有多少的空格; 上限为10. 该值若小于1, 则意味着没有空格; 如果该参数为字符串(当字符串长度超过10个字母, 取其前10个字母), 该字符串将被作为空格; 如果该参数没有提供(或者为 null), 将没有空格.

replacer 参数

replacer 参数可以是一个函数或者一个数组. 作为函数, 它有两个参数, 键(key)和值(value), 它们都会被序列化.

在开始时, replacer 函数会被传入一个空字符串作为 key 值, 代表着要被 stringify 的这个对象. 随后每个对象或数组上的属性会被依次传入.

函数应当返回JSON字符串中的value, 如下所示:

  • 如果返回一个 Number, 转换成相应的字符串作为属性值被添加入 JSON 字符串.
  • 如果返回一个 String, 该字符串作为属性值被添加入 JSON 字符串.
  • 如果返回一个 Boolean, "true" 或者 "false" 作为属性值被添加入 JSON 字符串.
  • 如果返回任何其他对象, 该对象递归地序列化成 JSON 字符串, 对每个属性调用 replacer 方法. 除非该对象是一个函数, 这种情况将不会被序列化成 JSON 字符串.
  • 如果返回 undefined , 该属性值不会在 JSON 字符串中输出.

注意: 不能用 replacer 方法, 从数组中移除值(values), 如若返回 undefined 或者一个函数, 将会被 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 序列化结果为 {"week":45,"month":7}.

例子(array)

如果 replacer 是一个数组, 数组的值代表将被序列化成 JSON 字符串的属性名.

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

space 参数

space 参数用来控制结果字符串里面的间距. 如果是一个数字, 则在字符串化时每一级别会比上一级别缩进多这个数字值的空格(最多10个空格); 如果是一个字符串, 则每一级别会比上一级别多缩进该字符串(或该字符串的前10个字符).

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

使用制表符(\t)来缩进:

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

JavaScript对象转换

例如我们向服务器发送以下数据:

var obj = { "name":"runoob", "alexa":10000, "site":"www.runoob.com"};

我们使用 JSON.stringify() 方法处理以上数据, 将其转换为字符串:

var myJSON = JSON.stringify(obj);

myJSON为字符串.

我们可以将myJSON发送到服务器:

var obj = { "name":"runoob", "alexa":10000, "site":"www.runoob.com"};
var myJSON = JSON.stringify(obj);
document.getElementById("demo").innerHTML = myJSON;

JavaScript数组转换

我们也可以将JavaScript数组转换为JSON字符串:

var arr = [ "Google", "Runoob", "Taobao", "Facebook" ];
var myJSON = JSON.stringify(arr);

myJSON 为字符串. 我们可以将 myJSON 发送到服务器:

var arr = [ "Google", "Runoob", "Taobao", "Facebook" ];
var myJSON = JSON.stringify(arr);
document.getElementById("demo").innerHTML = myJSON;

异常-stringify

解析数据-stringify

JSON 不能存储 Date 对象.

JSON.stringify() 会将所有日期转换为字符串.

var obj = { "name":"Runoob", "initDate":new Date(), "site":"www.runoob.com"};
var myJSON = JSON.stringify(obj);
document.getElementById("demo").innerHTML = myJSON;

之后你可以再将字符串转换为 Date 对象.

解析函数-stringify

JSON 不允许包含函数, JSON.stringify() 会删除 JavaScript 对象的函数, 包括 key 和 value. 

var obj = { "name":"Runoob", "alexa":function () {return 10000;}, "site":"www.runoob.com"};
var myJSON = JSON.stringify(obj);

document.getElementById("demo").innerHTML = myJSON;

我们可以在执行 JSON.stringify() 函数前将函数转换为字符串来避免以上问题的发生:

var obj = { "name":"Runoob", "alexa":function () {return 10000;}, "site":"www.runoob.com"};
obj.alexa = obj.alexa.toString();
var myJSON = JSON.stringify(obj);

document.getElementById("demo").innerHTML = myJSON;

不建议在 JSON 中使用函数.

主流浏览器都支持 JSON.stringify() 函数:

  • Firefox 3.5
  • Internet Explorer 8
  • Chrome
  • Opera 10
  • Safari 4

JSON使用

把JSON文本转换为JavaScript对象

JSON 最常见的用法之一, 是从 web 服务器上读取 JSON 数据(作为文件或作为 HttpRequest ), 将 JSON 数据转换为 JavaScript 对象, 然后在网页中使用该数据.

为了更简单地为您讲解, 我们使用字符串作为输入进行演示(而不是文件).

JSON实例-来自字符串的对象

创建包含JSON语法的JavaScript字符串:

var txt = '{ "sites" : [' +
'{ "name":"菜鸟教程" , "url":"www.runoob.com" },' +
'{ "name":"google" , "url":"www.google.com" },' +
'{ "name":"微博" , "url":"www.weibo.com" } ]}';

由于 JSON 语法是 JavaScript 语法的子集, JavaScript 函数 eval() 可用于将 JSON 文本转换为 JavaScript 对象.

eval() 函数使用的是 JavaScript 编译器, 可解析 JSON 文本, 然后生成 JavaScript 对象. 必须把文本包围在括号中, 这样才能避免语法错误:

var obj = eval ("(" + txt + ")");

在网页中使用 JavaScript 对象:

var txt = '{ "sites" : [' +
'{ "name":"菜鸟教程" , "url":"www.runoob.com" },' +
'{ "name":"google" , "url":"www.google.com" },' +
'{ "name":"微博" , "url":"www.weibo.com" } ]}';

var obj = eval ("(" + txt + ")");

document.getElementById("name").innerHTML=obj.sites[0].name
document.getElementById("url").innerHTML=obj.sites[0].url

JSON解析器

eval() 函数可编译并执行任何 JavaScript 代码. 这隐藏了一个潜在的安全问题.

使用 JSON 解析器将 JSON 转换为 JavaScript 对象是更安全的做法. JSON 解析器只能识别 JSON 文本, 而不会编译脚本.

在浏览器中, 这提供了原生的 JSON 支持, 而且 JSON 解析器的速度更快.

较新的浏览器和最新的 ECMAScript (JavaScript) 标准中均包含了原生的对 JSON 的支持.

Web 浏览器支持 Web 软件支持
Firefox (Mozilla) 3.5 jQuery
Internet Explorer 8 Yahoo UI
Chrome Prototype
Opera 10 Dojo
Safari 4 ECMAScript 1.5

aha, a rather old table though.

对于较老的浏览器, 可使用 JavaScript 库

JSON 格式最初是 originally specified by Douglas Crockford

JSONP教程

本章节我们将向大家介绍 JSONP 的知识.

Jsonp(JSON with Padding) 是 json 的一种"使用模式", 可以让网页从别的域名(网站)那获取资料, 即跨域读取数据.

为什么我们从不同的域(网站)访问数据需要一个特殊的技术( JSONP )呢？这是因为同源策略.

同源策略, 它是由 Netscape 提出的一个著名的安全策略, 现在所有支持 JavaScript 的浏览器都会使用这个策略.

JSONP应用

服务端 JSONP 格式数据

如客户想访问 : runoob.try

假设客户期望返回数据: ["customername1","customername2"].

真正返回到客户端的数据显示为: callbackFunction(["customername1","customername2"]).

服务端文件 jsonp.php 代码为:

<?php
header('Content-type: application/json');
//获取回调函数名
$jsoncallback = htmlspecialchars($_REQUEST ['jsoncallback']);
//json数据
$json_data = '["customername1","customername2"]';
//输出jsonp格式的数据
echo $jsoncallback . "(" . $json_data . ")";
?>

客户端实现 callbackFunction 函数

<script type="text/javascript">
function callbackFunction(result, methodName)
{
    var html = '<ul>';
    for(var i = 0; i < result.length; i++)
    {
        html += '<li>' + result[i] + '</li>';
    }
    html += '</ul>';
    document.getElementById('divCustomers').innerHTML = html;
}
</script>

页面展示

<div id="divCustomers"></div>

客户端页面完整代码

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>JSONP 实例</title>
</head>
<body>
<div id="divCustomers"></div>
<script type="text/javascript">
function callbackFunction(result, methodName)
{
    var html = '<ul>';
    for(var i = 0; i < result.length; i++)
    {
        html += '<li>' + result[i] + '</li>';
    }
    html += '</ul>';
    document.getElementById('divCustomers').innerHTML = html;
}
</script>
<script type="text/javascript" src="https://www.runoob.com/try/ajax/jsonp.php?jsoncallback=callbackFunction"></script>
</body>
</html>

jQuery 使用 JSONP

以上代码可以使用 jQuery 代码实例:

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>JSONP 实例</title>
    <script src="https://cdn.static.runoob.com/libs/jquery/1.8.3/jquery.js"></script>
</head>
<body>
<div id="divCustomers"></div>
<script>
$.getJSON("https://www.runoob.com/try/ajax/jsonp.php?jsoncallback=?", function(data) {

    var html = '<ul>';
    for(var i = 0; i < data.length; i++)
    {
        html += '<li>' + data[i] + '</li>';
    }
    html += '</ul>';

    $('#divCustomers').html(html);
});
</script>
</body>
</html>

PHP JSON

JSON格式化工具