JSON
Filename extension | .json |
---|---|
Internet media type | application/json |
Uniform Type Identifier | public.json |
Type of format | Data interchange |
Extended from | JavaScript |
Standard(s) | RFC 4627 |
Website | json.org |
JSON (pron.: /ˈdʒeɪsən/ JAY-sun, pron.: /ˈdʒeɪsɒn/ JAY-sawn), or JavaScript Object Notation, is a text-based open standard designed for human-readable data interchange. It is derived from the JavaScript scripting language for representing simple data structures and associative arrays, called objects. Despite its relationship to JavaScript, it is language-independent, with parsers available for many languages.
The JSON format was originally specified by Douglas Crockford, and is described in RFC 4627. The official Internet media type for JSON is application/json
. The JSON filename extension is .json
.
The JSON format is often used for serializing and transmitting structured data over a network connection. It is used primarily to transmit data between a server and web application, serving as an alternative to XML.
Contents |
[edit] History
Douglas Crockford was the first to specify and popularize the JSON format.[1]
JSON was used at State Software Inc., a company co-founded by Crockford, starting in April of 2001, and funded by Tesla Ventures. When State was founded in early 2001 by 6 former employees of Communities.com, they agreed to build a system that used standard browser capabilities and provided an abstraction layer for Web developers to create stateful Web applications that had a persistent duplex connection to a Web server by holding the 2 http connections open and recycling them before standard browser time outs if no further data was exchanged. The idea for the State Application Framework stemmed from a project at Communities.com for Cartoon Network which used a plug-in with a proprietary messaging format to manipulate dhtml elements (this system is also owned by 3DO); upon discovery of early AJAX capabilities (i.e, digiGroups and Noosh founded by Uri Sarid) and others using frames to pass information into the user browsers visual field without refreshing a Web applications visual context, it was deduced that the basic components to realize real time rich Web applications were available by using only the standard HTTP, HTML and Javascript capabilities of Netscape 4.0.5+ and IE 5+. Douglas Crockford then found that javascript could be used as an object based messaging format for such a system. The system was sold to Sun Microsystems, Amazon.com and EDS. The JSON.org website was launched in 2002. In December 2005, Yahoo! began offering some of its web services in JSON.[2] Google started offering JSON feeds for its GData web protocol in December 2006.[3]
Although JSON was based on a subset of the JavaScript scripting language (specifically, Standard ECMA-262 3rd Edition—December 1999[4]) and is commonly used with that language, it is a language-independent data format. Code for parsing and generating JSON data is readily available for a large variety of programming languages. JSON's website provides a comprehensive listing of existing JSON libraries, organized by language.
[edit] Data types, syntax and example
JSON's basic types are:
- Number (double precision floating-point format in JavaScript, generally depends on implementation)
- String (double-quoted Unicode, with backslash escaping)
- Boolean (
true
orfalse
) - Array (an ordered sequence of values, comma-separated and enclosed in square brackets; the values do not need to be of the same type)
- Object (an unordered collection of key:value pairs with the ':' character separating the key and the value, comma-separated and enclosed in curly braces; the keys must be strings and should be distinct from each other)
null
(empty)
Non-significant white space may be added freely around the "structural characters" (i.e. brackets "{}[]", colons ":" and commas ",").
The following example shows the JSON representation of an object that describes a person. The object has string fields for first name and last name, a number field for age, contains an object representing the person's address, and contains a list (an array) of phone number objects.
{ "firstName": "John", "lastName": "Smith", "age": 25, "address": { "streetAddress": "21 2nd Street", "city": "New York", "state": "NY", "postalCode": 10021 }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "fax", "number": "646 555-4567" } ] }
One potential pitfall of the free-form nature of JSON comes from the ability to write numbers as either numbers or strings. Consider for example a value such as the zip code 10021. 10021 may be written with quotes by one writer but without by another. This could give surprises or even errors, for example, when postal codes are exchanged between systems or even searched for within the same system. Searching for double-quoted "10021" won't necessarily find an unquoted 10021. In addition, postal codes in the USA are numbers but other countries use letters as well. This is a type of problem that the use of a JSON Schema (see below) is intended to reduce.
Since JSON is almost a subset of JavaScript, it is possible, but not recommended, to parse most JSON text into an object by invoking JavaScript's eval()
function. For example, if the above JSON data is contained within a JavaScript string variable contact
, one could use it to create the JavaScript object p
as follows:
var p = eval("(" + contact + ")");
The contact
variable must be wrapped in parentheses to avoid an ambiguity in JavaScript's syntax.[5]
The recommended way, however, is to use a JSON parser. Unless a client absolutely trusts the source of the text, or must parse and accept text that is not strictly JSON-compliant, one should avoid eval()
. A correctly implemented JSON parser will accept only valid JSON, preventing potentially malicious code from being executed inadvertently.
Browsers, such as Firefox 4 and Internet Explorer 8, include special features for parsing JSON. As native browser support is more efficient and secure than eval()
, native JSON support is included in the recently-released Edition 5 of the ECMAScript standard.[6]
Despite the widespread belief that JSON is a JavaScript subset, this is not the case. Specifically, JSON allows the Unicode line terminators U+2028 line separator and U+2029 paragraph separator to appear unescaped in quoted strings, while JavaScript does not.[7] This is a consequence of JSON disallowing only "control characters". This subtlety is important when generating JSONP.
[edit] Unsupported native data types
JavaScript syntax defines several native data types that are not included in the JSON standard:[8] Date, Error, Regular Expression, and Function. These JavaScript data types must be represented as some other data format, with the programs on both ends agreeing on how to convert between the types. As of 2011, there are some de facto standards for e.g. converting between Date and String, but none universally recognized.[9][10] Other languages may have a different set of native types that must be serialized carefully to deal with this type of conversion.
[edit] Schema
JSON Schema[11] is a specification for a JSON-based format for defining the structure of JSON data. JSON Schema provides a contract for what JSON data is required for a given application and how it can be modified, much like the XML Schema provides for XML. JSON Schema is intended to provide validation, documentation, and interaction control of JSON data. JSON Schema is based on the concepts from XML Schema, RelaxNG, and Kwalify, but is intended to be JSON-based, so that JSON data in the form of a schema can be used to validate JSON data, the same serialization/deserialization tools can be used for the schema and data, and it can be self descriptive.
JSON Schema was written up as an IETF draft, which expired in 2011.[12] However, there are several validators currently available for different programming languages,[13] each with varying levels of conformance. Currently the most complete and compliant JSON Schema validator available is JSV.[14]
Example JSON Schema:
{ "name": "Product", "properties": { "id": { "type": "number", "description": "Product identifier", "required": true }, "name": { "type": "string", "description": "Name of the product", "required": true }, "price": { "type": "number", "minimum": 0, "required": true }, "tags": { "type": "array", "items": { "type": "string" } }, "stock": { "type": "object", "properties": { "warehouse": { "type": "number" }, "retail": { "type": "number" } } } } }
The JSON Schema above can be used to test the validity of the JSON code below:
{ "id": 1, "name": "Foo", "price": 123, "tags": [ "Bar", "Eek" ], "stock": { "warehouse": 300, "retail": 20 } }
[edit] MIME type
The official MIME type for JSON text is "application/json
".[15]
[edit] JSON-RPC
JSON-RPC is a RPC protocol built on JSON, as a good replacement for XML-RPC or SOAP.It is a very simple protocol, defining only a handful of data types and commands. JSON-RPC allows for notifications (info sent to the server that does not require a response) and for multiple calls to be sent to the server which may be answered out of order. Example of a JSON-RPC 2.0 request and response using positional parameters.
--> {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": 1} <-- {"jsonrpc": "2.0", "result": 19, "id": 1}
When exposing services that accept and return JSON data, use JSON-RPC to replace SOAP or XML-RPC.
[edit] Use in Ajax
JSON is often used in Ajax techniques. Ajax is a term for the ability of a webpage to request new data after it has loaded into the web browser, usually in response to user actions on the displayed webpage. As part of the Ajax model, the new data is usually incorporated into the user interface display dynamically as it arrives back from the server. An example of this in practice might be that while the user is typing into a search box, client-side code sends what they have typed so far to a server that responds with a list of possible complete search terms from its database. These may be displayed in a drop-down list beneath the search, so that the user may stop typing and select a complete and commonly used search string directly. When it was originally described in the mid-2000s, Ajax commonly used XML as the data interchange format but many developers have also used JSON to pass Ajax updates between the server and the client.[16]
The following JavaScript code is one example of a client using XMLHttpRequest to request data in JSON format from a server. (The server-side programming is omitted; it has to be set up to respond to requests at url
with a JSON-formatted string.)
var my_JSON_object = {}; var http_request = new XMLHttpRequest(); http_request.open("GET", url, true); http_request.onreadystatechange = function () { var done = 4, ok = 200; if (http_request.readyState == done && http_request.status == ok) { my_JSON_object = JSON.parse(http_request.responseText); } }; http_request.send(null);
[edit] Security issues
Although JSON is intended as a data serialization format, its design as a subset of the JavaScript scripting language poses several security concerns. These concerns center on the use of a JavaScript interpreter to execute JSON text dynamically as JavaScript, thus exposing a program to errant or malicious script contained therein—often a chief concern when dealing with data retrieved from the Internet. While not the only way to process JSON, it is an easy and popular technique, stemming from JSON's compatibility with JavaScript's eval() function, and illustrated by the following code examples.
[edit] JavaScript eval()
Because most JSON-formatted text is also syntactically legal JavaScript code, an easy way for a JavaScript program to parse JSON-formatted data is to use the built-in JavaScript eval()
function, which was designed to evaluate JavaScript expressions. Rather than using a JSON-specific parser, the JavaScript interpreter itself is used to execute the JSON data to produce native JavaScript objects. However, there are some Unicode characters that are valid in JSON strings but invalid in JavaScript, so additional escaping would be needed before using a JavaScript interpreter.[17]
Unless precautions are taken to validate the data first, the eval technique is subject to security vulnerabilities if the data and the entire JavaScript environment are not within the control of a single trusted source. For example, if the data is itself not trusted, it may be subject to malicious JavaScript code injection attacks. Also, such breaches of trust may create vulnerabilities for data theft, authentication forgery, and other potential misuse of data and resources. Regular expressions can be used to validate the data prior to invoking eval()
. For example, the RFC that defines JSON (RFC 4627) suggests using the following code to validate JSON before eval'ing it (the variable 'text' is the input JSON):[18]
var my_JSON_object = !(/[^,:{}\[\]0-9.\-+Eaeflnr-u \n\r\t]/.test( text.replace(/"(\\.|[^"\\])*"/g, ''))) && eval('(' + text + ')');
A new function, JSON.parse()
, was developed as a safer alternative to eval
. It is specifically intended to process JSON data and not JavaScript. It was originally planned for inclusion in the Fourth Edition of the ECMAScript standard,[19] but this did not occur. It was first added to the Fifth Edition,[20] and is now supported by the major browsers given below. For older ones, a compatible JavaScript library is available at JSON.org.
[edit] Native encoding and decoding in browsers
Recent Web browsers now either have or are working on native JSON encoding/decoding. Not only does this eliminate the eval()
security problem above, but also increases performance due to the fact that functions no longer have to be parsed. Native JSON is generally faster compared to the JavaScript libraries commonly used before. As of June 2009 the following browsers have or will have native JSON support, via JSON.parse()
and JSON.stringify()
:
- Mozilla Firefox 3.5+[21]
- Microsoft Internet Explorer 8+[22]
- Opera 10.5+[23]
- WebKit-based browsers (e.g. Google Chrome, Apple Safari)[24]
At least 5 popular JavaScript libraries have committed to use native JSON if available:
The default character encoding for JSON is UTF8; it also supports UTF16 and UTF32.
[edit] Object references
The JSON standard does not support object references, but the Dojo Toolkit illustrates how conventions can be adopted to support such references using standard JSON. Specifically, the dojox.json.ref module provides support for several forms of referencing including circular, multiple, inter-message, and lazy referencing.[30][31] Alternatively, non-standard solutions exist such as the use of Mozilla JavaScript Sharp Variables, although this functionality has been removed in Firefox version 12.[32]
[edit] Comparison with other formats
JSON is promoted as a low-overhead alternative to XML as both of these formats have widespread support for creation, reading and decoding in the real-world situations where they are commonly used.[33] Apart from XML, examples could include OGDL, YAML and CSV. Also, Google Protocol Buffers can fill this role, although it is not a data interchange language.
[edit] XML
XML has been used to describe structured data and to serialize objects. Various XML-based protocols exist to represent the same kind of data structures as JSON for the same kind of data interchange purposes. When data is encoded in XML, the result is typically larger than an equivalent encoding in JSON, mainly because of XML's closing tags. Yet, if the data is compressed using an algorithm like gzip there is little difference because compression is good at saving space when a pattern is repeated.
In XML (as with JSON) there are alternative ways to encode the same information because some values can be represented both as child nodes and attributes. This can make automated data exchange complicated unless the used XML format is strictly specified as programs need to deal with many different variations of the data structure.
JSON example:
{ "firstName": "John", "lastName": "Smith", "age": 25, "address": { "streetAddress": "21 2nd Street", "city": "New York", "state": "NY", "postalCode": "10021" }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "fax", "number": "646 555-4567" } ] }
Both of the following XML examples carry the same information as the JSON example above in different ways (Note, however, that the reverse may not be true, as JavaScript implementations allow for implementation dependent iteration order, while XML element children may or may not ordered[34] . A more round-trippable JSON serialization might use arrays rather than objects).
XML examples:
<person> <firstName>John</firstName> <lastName>Smith</lastName> <age>25</age> <address> <streetAddress>21 2nd Street</streetAddress> <city>New York</city> <state>NY</state> <postalCode>10021</postalCode> </address> <phoneNumbers> <phoneNumber type="home">212 555-1234</phoneNumber> <phoneNumber type="fax">646 555-4567</phoneNumber> </phoneNumbers> </person>
<person firstName="John" lastName="Smith" age="25"> <address streetAddress="21 2nd Street" city="New York" state="NY" postalCode="10021" /> <phoneNumbers> <phoneNumber type="home" number="212 555-1234"/> <phoneNumber type="fax" number="646 555-4567"/> </phoneNumbers> </person>
The XML encoding may therefore be comparable in length to the equivalent JSON encoding. A wide range of XML processing technologies exist, from the Document Object Model to XPath and XSLT. XML can also be styled for immediate display using CSS. XHTML is a form of XML so that elements can be passed in this form ready for direct insertion into webpages using client-side scripting.
[edit] References
- ^ Video: Douglas Crockford — The JSON Saga, on Yahoo! Developer Network. In the video Crockford states: "I do not claim to have invented JSON ... What I did was I found it, I named it, I described how it was useful. ... So the idea's been around there for a while. What I did was I gave it a specification, and a little website."
- ^ Yahoo!. "Using JSON with Yahoo! Web services". Archived from the original on October 11, 2007. http://web.archive.org/web/20071011085815/http://developer.yahoo.com/common/json.html. Retrieved July 3, 2009.
- ^ Google. "Using JSON with Google Data APIs". http://code.google.com/apis/gdata/json.html. Retrieved July 3, 2009.
- ^ Crockford, Douglas (May 28, 2009). "Introducing JSON". json.org. http://json.org. Retrieved July 3, 2009.
- ^ Crockford, Douglas (July 9, 2008). "JSON in JavaScript". json.org. http://www.json.org/js.html. Retrieved September 8, 2008.
- ^ Standard ECMA-262
- ^ Magnus Holm (May 15, 2011), "JSON: The JavaScript subset that isn't", The timeless repository, 9212af0a8d2124b92a7e4c6355007e4b4b0ae71d
- ^ RFC 4627
- ^ jquery - How to format a JSON date? - Stack Overflow
- ^ Dates and JSON - Tales from the Evil Empire
- ^ JSON Schema
- ^ JSON Schema draft 3
- ^ JSON Schema implementations
- ^ JSV: JSON Schema Validator
- ^ IANA | Application Media Types
- ^ Garrett, Jesse James (18 February 2005). "Ajax: A New Approach to Web Applications". Adaptive Path. http://www.adaptivepath.com/ideas/ajax-new-approach-web-applications. Retrieved 19 March 2012.
- ^ "JSON: The JavaScript subset that isn't". Magnus Holm. http://timelessrepo.com/json-isnt-a-javascript-subset. Retrieved 16 May 2011.
- ^ Douglas Crockford (July 2006). "IANA Considerations". The application/json Media Type for JavaScript Object Notation (JSON). IETF. sec. 6. RFC 4627. https://tools.ietf.org/html/rfc4627#section-6. Retrieved October 21, 2009.
- ^ Crockford, Douglas (December 6, 2006). "JSON: The Fat-Free Alternative to XML". http://www.json.org/fatfree.html. Retrieved July 3, 2009.
- ^ "ECMAScript Fifth Edition". http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf. Retrieved March 18, 2011.
- ^ "Using Native JSON". June 30, 2009. https://developer.mozilla.org/en/Using_JSON_in_Firefox. Retrieved July 3, 2009.
- ^ Barsan, Corneliu (September 10, 2008). "Native JSON in IE8". http://blogs.msdn.com/ie/archive/2008/09/10/native-json-in-ie8.aspx. Retrieved July 3, 2009.
- ^ "Web specifications supported in Opera Presto 2.5". March 10, 2010. http://www.opera.com/docs/specs/presto25/#ecmascript. Retrieved March 29, 2010.
- ^ Hunt, Oliver (June 22, 2009). "Implement ES 3.1 JSON object". https://bugs.webkit.org/show_bug.cgi?id=20031. Retrieved July 3, 2009.
- ^ "YUI 2: JSON utility". September 1, 2009. http://developer.yahoo.com/yui/json/#native. Retrieved October 22, 2009.
- ^ "Learn JSON". April 7, 2010. http://www.prototypejs.org/learn/json. Retrieved April 7, 2010.
- ^ "Ticket #4429". May 22, 2009. http://dev.jquery.com/ticket/4429. Retrieved July 3, 2009.
- ^ "Ticket #8111". June 15, 2009. http://trac.dojotoolkit.org/ticket/8111. Retrieved July 3, 2009.
- ^ "Ticket 419". October 11, 2008. https://mootools.lighthouseapp.com/projects/2706/tickets/419-use-the-native-json-object-if-available. Retrieved July 3, 2009.
- ^ Zyp, Kris (June 17, 2008). "JSON referencing in Dojo". http://www.sitepen.com/blog/2008/06/17/json-referencing-in-dojo. Retrieved July 3, 2009.
- ^ von Gaza, Tys (Dec 7, 2010). "JSON referencing in jQuery". http://plugins.jquery.com/project/jsonref. Retrieved Dec 7, 2010.[dead link]
- ^ "Sharp variables in JavaScript". https://developer.mozilla.org/en/Sharp_variables_in_JavaScript. Retrieved 21 April 2012.
- ^ "JSON: The Fat-Free Alternative to XML". json.org. http://www.json.org/xml.html. Retrieved 14 March 2011.
- ^ "XML Schema sequence Element". Complete XML Schema Reference. Refsnes Data. http://www.w3schools.com/schema/el_sequence.asp. Retrieved 19 November 2012.
[edit] See also
- S-expression - the comparable LISP format for trees as text.
- JSONP – JSON with Padding, a pattern of usage commonly employed when retrieving JSON across domains
- BSON – binary JSON
- GeoJSON - an open format for encoding a variety of geographic data structures
- JSON-RPC
- SOAPjr – a hybrid of SOAP and JR (JSON-RPC)
- JsonML
- Jayrock - an open source implementation of JSON for the .NET Framework
- Comparison of data serialization formats
[edit] External links
- Format home page
- RFC 4627 - The application/json Media Type for JavaScript Object Notation (JSON)
- JSON-Introduction By Microsoft
- Improvements to JSON
|