json简介

郑桐

2023-12-01

JSON概览

JSON（JavaScript Object Notation）是一种基于文本的数据交换格式。无论你的应用是用哪种开发语言编写的（Java/EE，Ruby，PHP，C#/.Net等等），你都可以使用JSON来通过网络进行数据交互和处理。几乎所有的编程语言都有很好的库或第三方工具来提供基于JSON的API支持，因此你可以非常方便地使用任何自己喜欢的编程语言来处理JSON数据。而另一方面随着REST、像MongoDB这样的NoSQL技术或标准的广泛使用，JSON也正成为一种被推荐的数据交互格式。

JSON是在2001年，由Douglas Crockford创建的，并且被IETF(Internet Engineering Task Force)定义为RFC 4627标准，详请参考：http://tools.ietf.org/html/rfc4627。JSON的媒体类型被定义为 application/json，而文件的后缀为.json。

JSON是什么

JSON是一种简单数据格式，它有三种数据结构：

键值对 —— Name/Value (Key/Value)
对象 —— Object
数组 —— Arrays

一个有效的JSON文档需要被包含在一对花括号内
{ JSON-Data }

请注意，有些开发社区或线上文档直接将上面的JSON文档称为JSON字符串，这两者的意思是一样的。

为什么使用JSON

JSON被认为是XML的很好替代者。因为JSON的可读性非常好，而且它没有像XML那样包含很多冗余的元素标签，这使得应用在使用JSON进行网络传输以及进行解析处理的速度更快，效率更高。

键值对 —— Name/Value

键值对是JSON中最基本的数据结构：
{ “firstName”: “John”}

在上面的例子中属性"firstName"是用一对双引号括起来的一个字符串。而它的值"John"在这个例子中也是一个字符串，当然它还可以是其他类型，具体可参考后面数据类型的章节。在市面上很多的产品或技术声称他们使用的是JSON数据格式，但他们在定义属性时，并没有用双引号将属性名称括起来，其实这是违反JSON定义标准的。

对象 —— Object

一个JSON对象是包含了一组未排序键值对的集合。下面例子中的address就是一个JSON对象：

{
    “address” : {
        “line1” : “555 Main Street”,
        “city” : “Denver”,
        “stateOrProvince” : “CO”,
        “zipOrPostalCode” : “80202”,
        “country” : “USA”
    }
}

上面的例子中address对象包含了5个属性，它们之间用,进行分割。

数组 —— Array

JSON中[]来包含数组元素，参考下面的例子：

{
    “people” : [
        { “firstName”: “John”, “lastName”: “Smith”, “age”: 35 },
        { “firstName”: “Jane”, “lastName”: “Smith”, “age”: 32 }
    ]
}

数据类型

JSON中的数值（键值对中的值）可以是以下任意一种：
Object
Array
String
Number
Boolean
null

Number

数值类型数据可以是整型也可以是双精度的浮点型数据。下面是一些示例：
“age”: 29“cost”: 299.99“temperature”: -10.5“speed_of_light”: 1.23e11“speed_of_light”: 1.23e+11“speed_of_light”: 1.23E11“speed_of_light”: 1.23E+11

上面的属性（如age等）都是用双引号括起来的字符串，而数值是不需要用双引号括起来的。你可以在数值前加上-号来表示负数，也可以采用科学计数法。但不能在数值前加0或使用16进制来表示一个数值。

Boolean

JSON中的Boolean值可以用true或false来表示。不用加{}
{ “emailValidated” : true}
Boolean值也不需要使用双引号来修饰。

null

严格来说null并不是一个数据类型，但它非常重要，它表示一个属性或元素没有值。因此请注意 ' ' 表示的是空字符串，而null表示的才是空值。
{ “age” : null}

代码注释

JSON不允许在JSON文档或字符串中添加注释。注释功能最早在JSON中是存在的，但开发者们错误地使用了它来辅助JSON数据的解析，当Douglas Crockford意识到这种不好的使用实践后，便取消了注释功能，以保证JSON在不同计算平台间作为交互数据格式的特性。

样式

你可能已经注意到了在之前的例子中，所有的属性名称都使用了驼峰式的命名规则。这并不是JSON的一个标准要求，但这能够帮助提高JSON文档的可读性，因此作为一个事实标准在所有JSON应用中被使用。

语法

Douglas Crockford 在他的JSON网站http://www.json.org/中，给出了所有JSON语法语义的说明。另外还有一个iOS App JSON Pro FREE可以用来通过示例学习或参考JSON。

JSON校验

一个文本文档或字符串必须遵守JSON的语法定义，才能被视作一个有效的JSON文档。JSON文档是否有效非常重要，因为它直接决定了，你的JSON数据能否在不同的应用中被正确地解析和使用。JSONLint提供了一个可交互的Web版JSON校验工具，你只需要将你的JSON文档粘贴进去，并点击校验按钮，它便会自动进行校验，并将问题显示在下方。

Paste_Image.png

在上面这个例子中，这个JSON对象的city属性没有加上双引号，导致校验失败。在返回的提示中，显示了“Expecting 'STRING', got 'undefined'”错误。
JSONLint也提供了一个可以在Chrome中直接使用的插件。

JSON数据模型

在应用中手工编写JSON文档，会很枯燥并容易出错。为了防止这样的恶错误，你可以使用JSONPad或JSON Editor Online这样的工具，它们能够帮助你构建JSON逻辑模型（类似于UML）,然后通过模型生成JSON文档。

JSON Editor Online

[ JSON Editor Online] (http://jsoneditoronline.org/) 是一个在线JSON数据建模工具，他也提供了一个Chrome插件可以使用。

Paste_Image.png

浏览器中的JSON

Firefox和Chrome都提供了一些很好的插件方便开发人员查看或处理JSON数据。

REST Client

Rest Client是Firefox中的一个扩展应用。他能够帮助开发人员在浏览器中调试REST风格的Web Service。它最大的优点是能将返回的JSON数据结果，以很好的格式显示出来。

Paste_Image.png

JSONView

JSONView是一个FireFox和Chrome上的插件，能够很好地将JSON数据打印出来，从而大大提高了JSON数据的可读性。

Paste_Image.png

JSON与AJAX

AJAX可能是使用JSON数据中最常见的场景了。下面的这段代码示例，通过jQuery来调用一个REST风格的Web Service，并处理返回的JSON对象。

$.getJSON(‘http://example/service/addresses/home/1’,
    function(data) {
        var address = JSON.parse(data);
        console.log(“Address Line 1 = “ + address.line1);
    }
);

在上面的这段代码中，$getJSON（这是一种jQuery中$.ajax()标准调用的一种缩写形式）会发起一个HTTP GET 请求，调用Web Service，之后在它的隐式回调函数中，获取返回的data数据，并通过JSON.parse()方法将返回的数据转换为JSON对象。之后便可以像获取普通属性那样（address.line1）获取对象的属性数值了。

JSON与JAVA

Jackson是JAVA中用来处理JSON的一个第三方库。它很有名，并且提供了一组非常好用的JSON API。下面就是它的一个例子：

import java.io.Writer;
import java.io.StringWriter;
import org.codehaus.jackson.map.ObjectMapper;

public class Address {
    private String line1;
    private String city;
    private String stateOrProvince;
    private String zipOrPostalCode;
    private String country;

    public Address() {}

    public String getLine1() {
        return line1;
    }

    public void setLine1(line1) {
        this.line1 = line1;
    }

    // Remaining getters and setters ...
}

Address addrOut = new Address();

// Call setters to populate addrOut …
ObjectMapper mapper = new ObjectMapper(); // Reuse this.
// Marshal Address object to JSON String.
Writer writer = new StringWriter();
mapper.writeValue(writer, addrOut);
System.out.println(writer.toString());

// Unmarshal Address object from JSON String.
String addrJsonStr =
“{“ +
    “\”address\” : {“ +
    “\”line1\” : \”555 Main Street\”,” +
    “\”city\” : \”Denver\”,”
    “\”stateOrProvince\” : \”CO\”,”
    “\”zipOrPostalCode\” : \”80202\”,” +
    “\”country\” : \”USA\”” +
    “}” +
“}”;

Address addrIn = mapper.readValue(addrJsonStr, Address.class);

除了Jackson之外，还有一些其他基于JAVA的第三方JSON API库。
API
Source

Google GSON
http://code.google.com/p/google-json/

SOJO
http://sojo.sourceforge.net/

org.json (by DouglasCrockford)
http://www.json.org/java

json-lib
http://sourceforge.net/projects/json-lib/

json-io
http://code.google.com/p/json-io

jsontools
http://jsontools.berlios.de/

jsonbeans
http://code.google.com/p/jsonbeans/

JSON与RUBY

Ruby中也有很多与JSON相关的第三方库，而JSON gem是Ruby自带的，下面就是它的用法：

require ‘json’
class Address
    attr_accessor :line1, :city, :state_or_province,
                  :zip_or_postal_code, :country

    def initialize(line1=’’, city=’’, state_or_province=’’,
        zip_or_postal_code=’’, country=’’)
        @line1 = line1
        @city = city
        @state_or_province = state_or_province
        @zip_or_postal_code = zip_or_postal_code
        @country = country
    end

    def to_json
        to_hash.to_json
    end

    def from_json!(str)
        JSON.parse(str).each { |var, val| send(“#{var}=”, val) }
    end

    private

    def to_hash
        Hash[instance_variables.map { |var| [var[1..-1].to_sym,
            send(var[1..-1])] }]
    end
end

JSON gem的to_json方法将字符串或哈希转换为JSON。Address对象的to_json方法通过将它的成员转换成哈希再对哈希值调用to_json，最终将一个Address对象转换为JSON格式。

addr1 = Address.new(‘555 Main Street’, ‘Denver’, ‘CO’, ‘80231’,
‘US’)
puts addr1.to_json
# Outputs the following …
{“line1”:”555 Main Street”,”city”:”Denver”,”state_or_
province”:”CO”,”zip_or_postal_code”:”80231”,”country”:”US”}

JSON gem的JSON.pase方法则将JSON字符串转换为哈希。Address对象的from_jason!方法接收一个JSON字符串，然后调用JSON.parse来转换哈希，然后再在对象上分别设置这些哈希的值。
json_addr = <<END{ “line1” : “999 Broadway”, “city” : “Anytown”, “state_or_province” : “CA”, “zip_or_postal_code” : “90210”, “country” : “USA”}ENDaddr2 = Address.newaddr2.from_json!(json_addr)

除了JSON gem之外，还有以下一些Ruby的JSON第三方库
API
Source

ActiveSupport JSON
http://api.rubyonrails.org/classes/ActiveSupport/JSON.html

Yajl
https://github.com/brianmario/yajl-ruby

Oj
https://github.com/ohler55/oj

JSON与RUBY ON RAILS
Ruby on Rails也提供了将Ruby对象转换为JSON的功能。下面的例子中的Controller使用了render方法将一个Ruby对象以JSON数据的格式进行输出。
Rails中的ApplicationController会负责对象与JSON数据之间的互相转换。因此，不需要额外调用to_json方法。

JSON SCHEMA

JSON Schema用来定义JSON文档的结构，它可以被用来验证和校验发送或收到的JSON文档是否有效和规范。JSON Schema本身也是用JSON格式编写的，它的具体定义可以参考http://json-schema.org。
下面是JSON Schema的部分结构定义：
结构
描述

type
对象的数据类型，如Object,array,string,number 等

$schema
提供Schema版本的URI

required
true/false

id
数据元素id

properties
数据元素的校验属性，包括最大值，最小值，枚举等

下面是JSON Schema的一个示例
“type”: “object”,“$schema”: “http://json-schema.org/draft-03/schema”,“id”: “#”,“required”: true,“properties”: { “registrants”: { “type”: “array”, “id”: “registrants”, “required”: true, “items”: { “type”: “object”, “required”: false, “properties”: { “address”: { “type”: “object”, “id”: “address”, “required”: true, “properties”: { “city”: { “type”: “string”, “id”: “city”, “required”: true }, “country”: { “type”: “string”, “id”: “country”, “required”: false }, “line1”: { “type”: “string”, “id”: “line1”, “required”: true }, “line2”: { “type”: “string”, “id”: “line2”, “required”: false }, “postalCode”: { “type”: “string”, “id”: “postalCode”, “required”: true }, “premise”: { “type”: “string”, “id”: “premise”, “required”: true, “enum”: [ “work”, “home”, “other” ] }, “stateOrProvince”: { “type”: “string”, “id”: “stateOrProvince”, “required”: true } } }, “firstName”: { “type”: “string”, “id”: “firstName”, “required”: true }, “lastName”: { “type”: “string”, “id”: “lastName”, “required”: true }, “phoneNumber”: { “type”: “object”, “id”: “phoneNumber”, “required”: true, “properties”: { “channel”: { “type”: “string”, “id”: “channel”, “required”: true, “enum”: [ “cell”, “work”, “home” ] }, “number”: { “type”: “string”, “id”: “number”, “required”: true } } } } } } } }

在上面的Schema中对JSON对象做了以下约束：
registrants必须是一个数组对象
phoneNumber的channel必须是cell, work, fax, home中的一个
address的premise必须是home, work, other中的一个。

一个使用上述JSON Schema的Web Service可以解析和处理下面这个JSON文档：
{ "registrants": [ { "firstName": "Fred", "lastName": "Smith", "phoneNumber": { "channel": "cell", "number": "303-555-1212" }, "address": { "premise": "home", "line1": "555 Broadway NW", "line2": "# 000", "city": "Denver", "stateOrProvince": "CO", "postalCode": "88888", "country": "USA" } } ]}

JSON Schema 生成器
我们可以使用JSON Schema生成器来为一个有效的JSON文档生成对应的Schema。你需要访问(www.jsonschema.net)，然后按照以下步骤操作：
将你的JSON文档粘贴到右侧文本框
选择JSON输入选项
点击Generate Schema按钮

JSON Schema 校验器
我们可以用JSON Schema Validator来保证我们的JSON文档时有效的。下面是针对不同开发语言的一些常见的JSON Schema 校验器。
校验器
编程语言
项目地址

JSV
JavaScript
https://github.com/garycourt/JSV

Ruby JSON Schema Validator
Ruby
https://github.com/hoxworth/jsonschema

json-schemavalidator
Java
https://github.com/fge/json-schema-validator

php-json-schema(by MIT)
PHP
https://github.com/hasbridge/php-json-schema

JSON.Net
.NET
http://james.newtonking.com/projects/json-net.aspx

除了上面这些与编程语言相关的校验器之外，你还可以直接使用在线的JSON Schema校验器（ http://json-schema-validator.herokuapp.com ），将Schema和JSON文档粘贴到左侧的文本框中，然后点击Validate按钮，校验的结果就会显示在屏幕右侧。
总结
以上，我们已经初步了解了JSON的核心定义和用法，但对于JSON本身来说我们还只是了解了其中很小的一部分，还有许多与它相关的工具或技术可以使用。JSON作为一个数据标准，它已经逐步替代XML成为Internet上最受欢迎的交互数据格式

json简介

JSON概览

JSON是什么

为什么使用JSON

键值对 —— Name/Value

对象 —— Object

数组 —— Array

数据类型

Number

Boolean

null

代码注释

样式

语法

JSON校验

JSON数据模型

JSON Editor Online

浏览器中的JSON

REST Client

JSONView

JSON与AJAX

JSON与JAVA

JSON与RUBY

JSON SCHEMA

相关阅读

相关文章

相关问答

相关文档