ホームページ > 記事 > ウェブフロントエンド > シンプルで効率的な JSON

シンプルで効率的な JSON

php中世界最好的语言オリジナル: 2018-03-16 17:31:281651ブラウズ

今回はシンプルで効率的な JSON を紹介します。シンプルで効率的な JSON を使用する際の注意事項は何ですか?実際のケースを見てみましょう。

JSON (JavaScript Object Notation) は、テキストベースのデータ交換形式です。アプリケーションがどの開発言語 (Java/EE、Ruby、PHP、C#/.Net など) で記述されているかに関係なく、JSON を使用してネットワーク上でデータをやり取りし、処理できます。ほぼすべての

プログラミング言語には、JSON ベースの API サポートを提供する優れたライブラリまたはサードパーティツールがあるため、お気に入りのプログラミング言語を使用して JSON データを非常に便利に処理できます。一方で、REST および NoSQL テクノロジ、または MongoDB などの標準の普及に伴い、JSON が推奨されるデータ対話形式になりつつあります。

JSON は 2001 年に Douglas Crockford によって作成され、IETF (Internet Engineering Task Force) によって RFC 4627 標準として定義されています。詳細については、http://tools.ietf.org/html/rfc4627 を参照してください。 JSON のメディアタイプは application/json として定義され、ファイルのサフィックスは .json です。

JSONとは

JSONはシンプルなデータ形式であり、次の3つのデータ構造があります:

Key-valueペア——名前/値(キー/値)

オブジェクト——オブジェクト

配列——配列

有効な JSON ドキュメントは、中括弧のペアで囲む必要があります

{ JSON-Data }

一部の開発コミュニティまたはオンラインドキュメントは、上記の JSON ドキュメントを JSON 文字列として直接参照していることに注意してください。意味は同じです。。

JSON を使用する理由

JSON は XML の代替として適していると考えられています。 JSON は非常に読みやすく、XML のような冗長な要素タグが多く含まれていないため、ネットワーク送信と解析に JSON を使用するアプリケーションがより高速かつ効率的に実行されます。

キーと値のペア - 名前/値

キーと値のペアは、JSON の最も基本的なデータ構造です:

{
  “firstName”: “John”
}

上の例では、属性 "firstName" は二重引用符のペアで囲まれた文字列です。もちろん、この例では値 "John" も文字列です。詳細については、

データ型の章を参照してください。市場に出回っている多くの製品やテクノロジーは、JSON データ形式を使用していると主張していますが、属性を定義するときに属性名を二重引用符で囲んでいません。これは実際には、JSON 定義標準に違反しています。

オブジェクト - オブジェクト

JSON オブジェクトは、ソートされていないキーと値のペアのコレクションです。以下の例のアドレスは JSON オブジェクトです:

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

上の例では、アドレスオブジェクトにはで区切られた 5 つの属性が含まれています。

配列 - JSON の Array

[] には配列要素が含まれています。次の例を参照してください。

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

データ型

JSON の値 (キーと値のペアの値) は、次のいずれかになります。

オブジェクト、配列、文字列、数値、ブール値、ull、数値

数値型データは、整数または倍精度浮動小数点データのいずれかです。以下にいくつかの例を示します:

“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

上記の属性 (年齢など) はすべて二重引用符で囲まれた文字列であり、値を二重引用符で囲む必要はありません。値の前に - 記号を追加して負の数値を示すことも、科学表記法を使用することもできます。ただし、値の前に 0 を追加したり、16 進数を使用して値を表すことはできません。

Boolean

JSON のブール値は true または false で表すことができます。

{
    “emailValidated” : true}

ブール値は二重引用符で変更する必要はありません。

null

厳密に言えば、null はデータ型ではありませんが、属性または要素に値がないことを意味します。したがって、「」は空の文字列を表し、null は null 値を表すことに注意してください。

{
    “age” : null}

コードコメント

JSON では、JSON ドキュメントまたは文字列にコメントを含めることはできません。注釈関数は最初は JSON に存在していましたが、開発者は誤って JSON データの解析を支援するためにそれを使用しました。Douglas Crockford 氏はこの不適切な使用方法に気づき、JSON 特性を異なるコンピューティングプラットフォーム間で対話型のデータ形式として使用できるようにするために注釈関数をキャンセルしました。

スタイル

前の例では、すべての属性名にキャメルケースの命名規則が使用されていることに気づいたかもしれません。これは JSON の標準要件ではありませんが、JSON ドキュメントの読みやすさの向上に役立つため、すべての JSON アプリケーションで事実上の標準として使用されています。

構文

Douglas Crockford は、JSON Web サイト http://www.json.org/ ですべての JSON 構文とセマンティクスについて説明しています。例を通じて JSON を学習または参照するために使用できる iOS アプリ JSON Pro FREE もあります。

JSON検証

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

在上面这个例子中，这个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插件可以使用。

浏览器中的JSON

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

REST Client

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

JSONView

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

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库。

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])] }]    endend

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”
}
END
addr2 = 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上最受欢迎的交互数据格式。

相信看了本文案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！

シンプルで効率的な JSON

関連記事