ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/JSON-XS/README
(Generate patch)

Comparing JSON-XS/README (file contents):
Revision 1.17 by root, Mon Aug 27 02:03:23 2007 UTC vs.
Revision 1.37 by root, Thu May 23 09:32:02 2013 UTC

1NAME 1NAME
2 JSON::XS - JSON serialising/deserialising, done correctly and fast 2 JSON::XS - JSON serialising/deserialising, done correctly and fast
3 3
4 JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ
5 (http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html)
6
4SYNOPSIS 7SYNOPSIS
5 use JSON::XS; 8 use JSON::XS;
6 9
7 # exported functions, they croak on error 10 # exported functions, they croak on error
8 # and expect/generate UTF-8 11 # and expect/generate UTF-8
9 12
10 $utf8_encoded_json_text = to_json $perl_hash_or_arrayref; 13 $utf8_encoded_json_text = encode_json $perl_hash_or_arrayref;
11 $perl_hash_or_arrayref = from_json $utf8_encoded_json_text; 14 $perl_hash_or_arrayref = decode_json $utf8_encoded_json_text;
12 15
13 # OO-interface 16 # OO-interface
14 17
15 $coder = JSON::XS->new->ascii->pretty->allow_nonref; 18 $coder = JSON::XS->new->ascii->pretty->allow_nonref;
16 $pretty_printed_unencoded = $coder->encode ($perl_scalar); 19 $pretty_printed_unencoded = $coder->encode ($perl_scalar);
17 $perl_scalar = $coder->decode ($unicode_json_text); 20 $perl_scalar = $coder->decode ($unicode_json_text);
21
22 # Note that JSON version 2.0 and above will automatically use JSON::XS
23 # if available, at virtually no speed overhead either, so you should
24 # be able to just:
25
26 use JSON;
27
28 # and do the same things, except that you have a pure-perl fallback now.
18 29
19DESCRIPTION 30DESCRIPTION
20 This module converts Perl data structures to JSON and vice versa. Its 31 This module converts Perl data structures to JSON and vice versa. Its
21 primary goal is to be *correct* and its secondary goal is to be *fast*. 32 primary goal is to be *correct* and its secondary goal is to be *fast*.
22 To reach the latter goal it was written in C. 33 To reach the latter goal it was written in C.
34
35 Beginning with version 2.0 of the JSON module, when both JSON and
36 JSON::XS are installed, then JSON will fall back on JSON::XS (this can
37 be overridden) with no overhead due to emulation (by inheriting
38 constructor and methods). If JSON::XS is not available, it will fall
39 back to the compatible JSON::PP module as backend, so using JSON instead
40 of JSON::XS gives you a portable JSON API that can be fast when you need
41 and doesn't require a C compiler when that is a problem.
23 42
24 As this is the n-th-something JSON module on CPAN, what was the reason 43 As this is the n-th-something JSON module on CPAN, what was the reason
25 to write yet another JSON module? While it seems there are many JSON 44 to write yet another JSON module? While it seems there are many JSON
26 modules, none of them correctly handle all corner cases, and in most 45 modules, none of them correctly handle all corner cases, and in most
27 cases their maintainers are unresponsive, gone missing, or not listening 46 cases their maintainers are unresponsive, gone missing, or not listening
28 to bug reports for other reasons. 47 to bug reports for other reasons.
29 48
30 See COMPARISON, below, for a comparison to some other JSON modules.
31
32 See MAPPING, below, on how JSON::XS maps perl values to JSON values and 49 See MAPPING, below, on how JSON::XS maps perl values to JSON values and
33 vice versa. 50 vice versa.
34 51
35 FEATURES 52 FEATURES
36 * correct unicode handling 53 * correct Unicode handling
54
37 This module knows how to handle Unicode, and even documents how and 55 This module knows how to handle Unicode, documents how and when it
38 when it does so. 56 does so, and even documents what "correct" means.
39 57
40 * round-trip integrity 58 * round-trip integrity
59
41 When you serialise a perl data structure using only datatypes 60 When you serialise a perl data structure using only data types
42 supported by JSON, the deserialised data structure is identical on 61 supported by JSON and Perl, the deserialised data structure is
43 the Perl level. (e.g. the string "2.0" doesn't suddenly become "2" 62 identical on the Perl level. (e.g. the string "2.0" doesn't suddenly
44 just because it looks like a number). 63 become "2" just because it looks like a number). There *are* minor
64 exceptions to this, read the MAPPING section below to learn about
65 those.
45 66
46 * strict checking of JSON correctness 67 * strict checking of JSON correctness
68
47 There is no guessing, no generating of illegal JSON texts by 69 There is no guessing, no generating of illegal JSON texts by
48 default, and only JSON is accepted as input by default (the latter 70 default, and only JSON is accepted as input by default (the latter
49 is a security feature). 71 is a security feature).
50 72
51 * fast 73 * fast
52 Compared to other JSON modules, this module compares favourably in
53 terms of speed, too.
54 74
75 Compared to other JSON modules and other serialisers such as
76 Storable, this module usually compares favourably in terms of speed,
77 too.
78
55 * simple to use 79 * simple to use
80
56 This module has both a simple functional interface as well as an OO 81 This module has both a simple functional interface as well as an
57 interface. 82 object oriented interface interface.
58 83
59 * reasonably versatile output formats 84 * reasonably versatile output formats
85
60 You can choose between the most compact guarenteed single-line 86 You can choose between the most compact guaranteed-single-line
61 format possible (nice for simple line-based protocols), a pure-ascii 87 format possible (nice for simple line-based protocols), a pure-ASCII
62 format (for when your transport is not 8-bit clean, still supports 88 format (for when your transport is not 8-bit clean, still supports
63 the whole unicode range), or a pretty-printed format (for when you 89 the whole Unicode range), or a pretty-printed format (for when you
64 want to read that stuff). Or you can combine those features in 90 want to read that stuff). Or you can combine those features in
65 whatever way you like. 91 whatever way you like.
66 92
67FUNCTIONAL INTERFACE 93FUNCTIONAL INTERFACE
68 The following convinience methods are provided by this module. They are 94 The following convenience methods are provided by this module. They are
69 exported by default: 95 exported by default:
70 96
71 $json_text = to_json $perl_scalar 97 $json_text = encode_json $perl_scalar
72 Converts the given Perl data structure (a simple scalar or a 98 Converts the given Perl data structure to a UTF-8 encoded, binary
73 reference to a hash or array) to a UTF-8 encoded, binary string
74 (that is, the string contains octets only). Croaks on error. 99 string (that is, the string contains octets only). Croaks on error.
75 100
76 This function call is functionally identical to: 101 This function call is functionally identical to:
77 102
78 $json_text = JSON::XS->new->utf8->encode ($perl_scalar) 103 $json_text = JSON::XS->new->utf8->encode ($perl_scalar)
79 104
80 except being faster. 105 Except being faster.
81 106
82 $perl_scalar = from_json $json_text 107 $perl_scalar = decode_json $json_text
83 The opposite of "to_json": expects an UTF-8 (binary) string and 108 The opposite of "encode_json": expects an UTF-8 (binary) string and
84 tries to parse that as an UTF-8 encoded JSON text, returning the 109 tries to parse that as an UTF-8 encoded JSON text, returning the
85 resulting simple scalar or reference. Croaks on error. 110 resulting reference. Croaks on error.
86 111
87 This function call is functionally identical to: 112 This function call is functionally identical to:
88 113
89 $perl_scalar = JSON::XS->new->utf8->decode ($json_text) 114 $perl_scalar = JSON::XS->new->utf8->decode ($json_text)
90 115
91 except being faster. 116 Except being faster.
92 117
93 $is_boolean = JSON::XS::is_bool $scalar 118 $is_boolean = JSON::XS::is_bool $scalar
94 Returns true if the passed scalar represents either JSON::XS::true 119 Returns true if the passed scalar represents either JSON::XS::true
95 or JSON::XS::false, two constants that act like 1 and 0, 120 or JSON::XS::false, two constants that act like 1 and 0,
96 respectively and are used to represent JSON "true" and "false" 121 respectively and are used to represent JSON "true" and "false"
97 values in Perl. 122 values in Perl.
98 123
99 See MAPPING, below, for more information on how JSON values are 124 See MAPPING, below, for more information on how JSON values are
100 mapped to Perl. 125 mapped to Perl.
101 126
127A FEW NOTES ON UNICODE AND PERL
128 Since this often leads to confusion, here are a few very clear words on
129 how Unicode works in Perl, modulo bugs.
130
131 1. Perl strings can store characters with ordinal values > 255.
132 This enables you to store Unicode characters as single characters in
133 a Perl string - very natural.
134
135 2. Perl does *not* associate an encoding with your strings.
136 ... until you force it to, e.g. when matching it against a regex, or
137 printing the scalar to a file, in which case Perl either interprets
138 your string as locale-encoded text, octets/binary, or as Unicode,
139 depending on various settings. In no case is an encoding stored
140 together with your data, it is *use* that decides encoding, not any
141 magical meta data.
142
143 3. The internal utf-8 flag has no meaning with regards to the encoding
144 of your string.
145 Just ignore that flag unless you debug a Perl bug, a module written
146 in XS or want to dive into the internals of perl. Otherwise it will
147 only confuse you, as, despite the name, it says nothing about how
148 your string is encoded. You can have Unicode strings with that flag
149 set, with that flag clear, and you can have binary data with that
150 flag set and that flag clear. Other possibilities exist, too.
151
152 If you didn't know about that flag, just the better, pretend it
153 doesn't exist.
154
155 4. A "Unicode String" is simply a string where each character can be
156 validly interpreted as a Unicode code point.
157 If you have UTF-8 encoded data, it is no longer a Unicode string,
158 but a Unicode string encoded in UTF-8, giving you a binary string.
159
160 5. A string containing "high" (> 255) character values is *not* a UTF-8
161 string.
162 It's a fact. Learn to live with it.
163
164 I hope this helps :)
165
102OBJECT-ORIENTED INTERFACE 166OBJECT-ORIENTED INTERFACE
103 The object oriented interface lets you configure your own encoding or 167 The object oriented interface lets you configure your own encoding or
104 decoding style, within the limits of supported formats. 168 decoding style, within the limits of supported formats.
105 169
106 $json = new JSON::XS 170 $json = new JSON::XS
… …
113 177
114 my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]}) 178 my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})
115 => {"a": [1, 2]} 179 => {"a": [1, 2]}
116 180
117 $json = $json->ascii ([$enable]) 181 $json = $json->ascii ([$enable])
182 $enabled = $json->get_ascii
118 If $enable is true (or missing), then the "encode" method will not 183 If $enable is true (or missing), then the "encode" method will not
119 generate characters outside the code range 0..127 (which is ASCII). 184 generate characters outside the code range 0..127 (which is ASCII).
120 Any unicode characters outside that range will be escaped using 185 Any Unicode characters outside that range will be escaped using
121 either a single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL 186 either a single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL
122 escape sequence, as per RFC4627. The resulting encoded JSON text can 187 escape sequence, as per RFC4627. The resulting encoded JSON text can
123 be treated as a native unicode string, an ascii-encoded, 188 be treated as a native Unicode string, an ascii-encoded,
124 latin1-encoded or UTF-8 encoded string, or any other superset of 189 latin1-encoded or UTF-8 encoded string, or any other superset of
125 ASCII. 190 ASCII.
126 191
127 If $enable is false, then the "encode" method will not escape 192 If $enable is false, then the "encode" method will not escape
128 Unicode characters unless required by the JSON syntax or other 193 Unicode characters unless required by the JSON syntax or other
129 flags. This results in a faster and more compact format. 194 flags. This results in a faster and more compact format.
130 195
196 See also the section *ENCODING/CODESET FLAG NOTES* later in this
197 document.
198
131 The main use for this flag is to produce JSON texts that can be 199 The main use for this flag is to produce JSON texts that can be
132 transmitted over a 7-bit channel, as the encoded JSON texts will not 200 transmitted over a 7-bit channel, as the encoded JSON texts will not
133 contain any 8 bit characters. 201 contain any 8 bit characters.
134 202
135 JSON::XS->new->ascii (1)->encode ([chr 0x10401]) 203 JSON::XS->new->ascii (1)->encode ([chr 0x10401])
136 => ["\ud801\udc01"] 204 => ["\ud801\udc01"]
137 205
138 $json = $json->latin1 ([$enable]) 206 $json = $json->latin1 ([$enable])
207 $enabled = $json->get_latin1
139 If $enable is true (or missing), then the "encode" method will 208 If $enable is true (or missing), then the "encode" method will
140 encode the resulting JSON text as latin1 (or iso-8859-1), escaping 209 encode the resulting JSON text as latin1 (or iso-8859-1), escaping
141 any characters outside the code range 0..255. The resulting string 210 any characters outside the code range 0..255. The resulting string
142 can be treated as a latin1-encoded JSON text or a native unicode 211 can be treated as a latin1-encoded JSON text or a native Unicode
143 string. The "decode" method will not be affected in any way by this 212 string. The "decode" method will not be affected in any way by this
144 flag, as "decode" by default expects unicode, which is a strict 213 flag, as "decode" by default expects Unicode, which is a strict
145 superset of latin1. 214 superset of latin1.
146 215
147 If $enable is false, then the "encode" method will not escape 216 If $enable is false, then the "encode" method will not escape
148 Unicode characters unless required by the JSON syntax or other 217 Unicode characters unless required by the JSON syntax or other
149 flags. 218 flags.
219
220 See also the section *ENCODING/CODESET FLAG NOTES* later in this
221 document.
150 222
151 The main use for this flag is efficiently encoding binary data as 223 The main use for this flag is efficiently encoding binary data as
152 JSON text, as most octets will not be escaped, resulting in a 224 JSON text, as most octets will not be escaped, resulting in a
153 smaller encoded size. The disadvantage is that the resulting JSON 225 smaller encoded size. The disadvantage is that the resulting JSON
154 text is encoded in latin1 (and must correctly be treated as such 226 text is encoded in latin1 (and must correctly be treated as such
155 when storing and transfering), a rare encoding for JSON. It is 227 when storing and transferring), a rare encoding for JSON. It is
156 therefore most useful when you want to store data structures known 228 therefore most useful when you want to store data structures known
157 to contain binary data efficiently in files or databases, not when 229 to contain binary data efficiently in files or databases, not when
158 talking to other JSON encoders/decoders. 230 talking to other JSON encoders/decoders.
159 231
160 JSON::XS->new->latin1->encode (["\x{89}\x{abc}"] 232 JSON::XS->new->latin1->encode (["\x{89}\x{abc}"]
161 => ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not) 233 => ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not)
162 234
163 $json = $json->utf8 ([$enable]) 235 $json = $json->utf8 ([$enable])
236 $enabled = $json->get_utf8
164 If $enable is true (or missing), then the "encode" method will 237 If $enable is true (or missing), then the "encode" method will
165 encode the JSON result into UTF-8, as required by many protocols, 238 encode the JSON result into UTF-8, as required by many protocols,
166 while the "decode" method expects to be handled an UTF-8-encoded 239 while the "decode" method expects to be handled an UTF-8-encoded
167 string. Please note that UTF-8-encoded strings do not contain any 240 string. Please note that UTF-8-encoded strings do not contain any
168 characters outside the range 0..255, they are thus useful for 241 characters outside the range 0..255, they are thus useful for
169 bytewise/binary I/O. In future versions, enabling this option might 242 bytewise/binary I/O. In future versions, enabling this option might
170 enable autodetection of the UTF-16 and UTF-32 encoding families, as 243 enable autodetection of the UTF-16 and UTF-32 encoding families, as
171 described in RFC4627. 244 described in RFC4627.
172 245
173 If $enable is false, then the "encode" method will return the JSON 246 If $enable is false, then the "encode" method will return the JSON
174 string as a (non-encoded) unicode string, while "decode" expects 247 string as a (non-encoded) Unicode string, while "decode" expects
175 thus a unicode string. Any decoding or encoding (e.g. to UTF-8 or 248 thus a Unicode string. Any decoding or encoding (e.g. to UTF-8 or
176 UTF-16) needs to be done yourself, e.g. using the Encode module. 249 UTF-16) needs to be done yourself, e.g. using the Encode module.
250
251 See also the section *ENCODING/CODESET FLAG NOTES* later in this
252 document.
177 253
178 Example, output UTF-16BE-encoded JSON: 254 Example, output UTF-16BE-encoded JSON:
179 255
180 use Encode; 256 use Encode;
181 $jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object); 257 $jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object);
… …
200 2 276 2
201 ] 277 ]
202 } 278 }
203 279
204 $json = $json->indent ([$enable]) 280 $json = $json->indent ([$enable])
281 $enabled = $json->get_indent
205 If $enable is true (or missing), then the "encode" method will use a 282 If $enable is true (or missing), then the "encode" method will use a
206 multiline format as output, putting every array member or 283 multiline format as output, putting every array member or
207 object/hash key-value pair into its own line, identing them 284 object/hash key-value pair into its own line, indenting them
208 properly. 285 properly.
209 286
210 If $enable is false, no newlines or indenting will be produced, and 287 If $enable is false, no newlines or indenting will be produced, and
211 the resulting JSON text is guarenteed not to contain any "newlines". 288 the resulting JSON text is guaranteed not to contain any "newlines".
212 289
213 This setting has no effect when decoding JSON texts. 290 This setting has no effect when decoding JSON texts.
214 291
215 $json = $json->space_before ([$enable]) 292 $json = $json->space_before ([$enable])
293 $enabled = $json->get_space_before
216 If $enable is true (or missing), then the "encode" method will add 294 If $enable is true (or missing), then the "encode" method will add
217 an extra optional space before the ":" separating keys from values 295 an extra optional space before the ":" separating keys from values
218 in JSON objects. 296 in JSON objects.
219 297
220 If $enable is false, then the "encode" method will not add any extra 298 If $enable is false, then the "encode" method will not add any extra
… …
226 Example, space_before enabled, space_after and indent disabled: 304 Example, space_before enabled, space_after and indent disabled:
227 305
228 {"key" :"value"} 306 {"key" :"value"}
229 307
230 $json = $json->space_after ([$enable]) 308 $json = $json->space_after ([$enable])
309 $enabled = $json->get_space_after
231 If $enable is true (or missing), then the "encode" method will add 310 If $enable is true (or missing), then the "encode" method will add
232 an extra optional space after the ":" separating keys from values in 311 an extra optional space after the ":" separating keys from values in
233 JSON objects and extra whitespace after the "," separating key-value 312 JSON objects and extra whitespace after the "," separating key-value
234 pairs and array members. 313 pairs and array members.
235 314
… …
241 Example, space_before and indent disabled, space_after enabled: 320 Example, space_before and indent disabled, space_after enabled:
242 321
243 {"key": "value"} 322 {"key": "value"}
244 323
245 $json = $json->relaxed ([$enable]) 324 $json = $json->relaxed ([$enable])
325 $enabled = $json->get_relaxed
246 If $enable is true (or missing), then "decode" will accept some 326 If $enable is true (or missing), then "decode" will accept some
247 extensions to normal JSON syntax (see below). "encode" will not be 327 extensions to normal JSON syntax (see below). "encode" will not be
248 affected in anyway. *Be aware that this option makes you accept 328 affected in anyway. *Be aware that this option makes you accept
249 invalid JSON texts as if they were valid!*. I suggest only to use 329 invalid JSON texts as if they were valid!*. I suggest only to use
250 this option to parse application-specific files written by humans 330 this option to parse application-specific files written by humans
… …
253 If $enable is false (the default), then "decode" will only accept 333 If $enable is false (the default), then "decode" will only accept
254 valid JSON texts. 334 valid JSON texts.
255 335
256 Currently accepted extensions are: 336 Currently accepted extensions are:
257 337
258 * list items can have an end-comma 338 * list items can have an end-comma
339
259 JSON *separates* array elements and key-value pairs with commas. 340 JSON *separates* array elements and key-value pairs with commas.
260 This can be annoying if you write JSON texts manually and want 341 This can be annoying if you write JSON texts manually and want
261 to be able to quickly append elements, so this extension accepts 342 to be able to quickly append elements, so this extension accepts
262 comma at the end of such items not just between them: 343 comma at the end of such items not just between them:
263 344
… …
268 { 349 {
269 "k1": "v1", 350 "k1": "v1",
270 "k2": "v2", <- this comma not normally allowed 351 "k2": "v2", <- this comma not normally allowed
271 } 352 }
272 353
354 * shell-style '#'-comments
355
356 Whenever JSON allows whitespace, shell-style comments are
357 additionally allowed. They are terminated by the first
358 carriage-return or line-feed character, after which more
359 white-space and comments are allowed.
360
361 [
362 1, # this comment not allowed in JSON
363 # neither this one...
364 ]
365
273 $json = $json->canonical ([$enable]) 366 $json = $json->canonical ([$enable])
367 $enabled = $json->get_canonical
274 If $enable is true (or missing), then the "encode" method will 368 If $enable is true (or missing), then the "encode" method will
275 output JSON objects by sorting their keys. This is adding a 369 output JSON objects by sorting their keys. This is adding a
276 comparatively high overhead. 370 comparatively high overhead.
277 371
278 If $enable is false, then the "encode" method will output key-value 372 If $enable is false, then the "encode" method will output key-value
279 pairs in the order Perl stores them (which will likely change 373 pairs in the order Perl stores them (which will likely change
280 between runs of the same script). 374 between runs of the same script, and can change even within the same
375 run from 5.18 onwards).
281 376
282 This option is useful if you want the same data structure to be 377 This option is useful if you want the same data structure to be
283 encoded as the same JSON text (given the same overall settings). If 378 encoded as the same JSON text (given the same overall settings). If
284 it is disabled, the same hash migh be encoded differently even if 379 it is disabled, the same hash might be encoded differently even if
285 contains the same data, as key-value pairs have no inherent ordering 380 contains the same data, as key-value pairs have no inherent ordering
286 in Perl. 381 in Perl.
287 382
288 This setting has no effect when decoding JSON texts. 383 This setting has no effect when decoding JSON texts.
289 384
385 This setting has currently no effect on tied hashes.
386
290 $json = $json->allow_nonref ([$enable]) 387 $json = $json->allow_nonref ([$enable])
388 $enabled = $json->get_allow_nonref
291 If $enable is true (or missing), then the "encode" method can 389 If $enable is true (or missing), then the "encode" method can
292 convert a non-reference into its corresponding string, number or 390 convert a non-reference into its corresponding string, number or
293 null JSON value, which is an extension to RFC4627. Likewise, 391 null JSON value, which is an extension to RFC4627. Likewise,
294 "decode" will accept those JSON values instead of croaking. 392 "decode" will accept those JSON values instead of croaking.
295 393
… …
302 "allow_nonref", resulting in an invalid JSON text: 400 "allow_nonref", resulting in an invalid JSON text:
303 401
304 JSON::XS->new->allow_nonref->encode ("Hello, World!") 402 JSON::XS->new->allow_nonref->encode ("Hello, World!")
305 => "Hello, World!" 403 => "Hello, World!"
306 404
405 $json = $json->allow_unknown ([$enable])
406 $enabled = $json->get_allow_unknown
407 If $enable is true (or missing), then "encode" will *not* throw an
408 exception when it encounters values it cannot represent in JSON (for
409 example, filehandles) but instead will encode a JSON "null" value.
410 Note that blessed objects are not included here and are handled
411 separately by c<allow_nonref>.
412
413 If $enable is false (the default), then "encode" will throw an
414 exception when it encounters anything it cannot encode as JSON.
415
416 This option does not affect "decode" in any way, and it is
417 recommended to leave it off unless you know your communications
418 partner.
419
307 $json = $json->allow_blessed ([$enable]) 420 $json = $json->allow_blessed ([$enable])
421 $enabled = $json->get_allow_blessed
308 If $enable is true (or missing), then the "encode" method will not 422 If $enable is true (or missing), then the "encode" method will not
309 barf when it encounters a blessed reference. Instead, the value of 423 barf when it encounters a blessed reference. Instead, the value of
310 the convert_blessed option will decide wether "null" 424 the convert_blessed option will decide whether "null"
311 ("convert_blessed" disabled or no "to_json" method found) or a 425 ("convert_blessed" disabled or no "TO_JSON" method found) or a
312 representation of the object ("convert_blessed" enabled and 426 representation of the object ("convert_blessed" enabled and
313 "to_json" method found) is being encoded. Has no effect on "decode". 427 "TO_JSON" method found) is being encoded. Has no effect on "decode".
314 428
315 If $enable is false (the default), then "encode" will throw an 429 If $enable is false (the default), then "encode" will throw an
316 exception when it encounters a blessed object. 430 exception when it encounters a blessed object.
317 431
318 $json = $json->convert_blessed ([$enable]) 432 $json = $json->convert_blessed ([$enable])
433 $enabled = $json->get_convert_blessed
319 If $enable is true (or missing), then "encode", upon encountering a 434 If $enable is true (or missing), then "encode", upon encountering a
320 blessed object, will check for the availability of the "TO_JSON" 435 blessed object, will check for the availability of the "TO_JSON"
321 method on the object's class. If found, it will be called in scalar 436 method on the object's class. If found, it will be called in scalar
322 context and the resulting scalar will be encoded instead of the 437 context and the resulting scalar will be encoded instead of the
323 object. If no "TO_JSON" method is found, the value of 438 object. If no "TO_JSON" method is found, the value of
… …
327 returns other blessed objects, those will be handled in the same 442 returns other blessed objects, those will be handled in the same
328 way. "TO_JSON" must take care of not causing an endless recursion 443 way. "TO_JSON" must take care of not causing an endless recursion
329 cycle (== crash) in this case. The name of "TO_JSON" was chosen 444 cycle (== crash) in this case. The name of "TO_JSON" was chosen
330 because other methods called by the Perl core (== not by the user of 445 because other methods called by the Perl core (== not by the user of
331 the object) are usually in upper case letters and to avoid 446 the object) are usually in upper case letters and to avoid
332 collisions with the "to_json" function. 447 collisions with any "to_json" function or method.
333 448
334 This setting does not yet influence "decode" in any way, but in the 449 This setting does not yet influence "decode" in any way, but in the
335 future, global hooks might get installed that influence "decode" and 450 future, global hooks might get installed that influence "decode" and
336 are enabled by this setting. 451 are enabled by this setting.
337 452
… …
378 493
379 As this callback gets called less often then the 494 As this callback gets called less often then the
380 "filter_json_object" one, decoding speed will not usually suffer as 495 "filter_json_object" one, decoding speed will not usually suffer as
381 much. Therefore, single-key objects make excellent targets to 496 much. Therefore, single-key objects make excellent targets to
382 serialise Perl objects into, especially as single-key JSON objects 497 serialise Perl objects into, especially as single-key JSON objects
383 are as close to the type-tagged value concept as JSON gets (its 498 are as close to the type-tagged value concept as JSON gets (it's
384 basically an ID/VALUE tuple). Of course, JSON does not support this 499 basically an ID/VALUE tuple). Of course, JSON does not support this
385 in any way, so you need to make sure your data never looks like a 500 in any way, so you need to make sure your data never looks like a
386 serialised Perl hash. 501 serialised Perl hash.
387 502
388 Typical names for the single object key are "__class_whatever__", or 503 Typical names for the single object key are "__class_whatever__", or
… …
413 528
414 { __widget__ => $self->{id} } 529 { __widget__ => $self->{id} }
415 } 530 }
416 531
417 $json = $json->shrink ([$enable]) 532 $json = $json->shrink ([$enable])
533 $enabled = $json->get_shrink
418 Perl usually over-allocates memory a bit when allocating space for 534 Perl usually over-allocates memory a bit when allocating space for
419 strings. This flag optionally resizes strings generated by either 535 strings. This flag optionally resizes strings generated by either
420 "encode" or "decode" to their minimum size possible. This can save 536 "encode" or "decode" to their minimum size possible. This can save
421 memory when your JSON texts are either very very long or you have 537 memory when your JSON texts are either very very long or you have
422 many short strings. It will also try to downgrade any strings to 538 many short strings. It will also try to downgrade any strings to
… …
440 converting strings that look like integers or floats into integers 556 converting strings that look like integers or floats into integers
441 or floats internally (there is no difference on the Perl level), 557 or floats internally (there is no difference on the Perl level),
442 saving space. 558 saving space.
443 559
444 $json = $json->max_depth ([$maximum_nesting_depth]) 560 $json = $json->max_depth ([$maximum_nesting_depth])
561 $max_depth = $json->get_max_depth
445 Sets the maximum nesting level (default 512) accepted while encoding 562 Sets the maximum nesting level (default 512) accepted while encoding
446 or decoding. If the JSON text or Perl data structure has an equal or 563 or decoding. If a higher nesting level is detected in JSON text or a
447 higher nesting level then this limit, then the encoder and decoder 564 Perl data structure, then the encoder and decoder will stop and
448 will stop and croak at that point. 565 croak at that point.
449 566
450 Nesting level is defined by number of hash- or arrayrefs that the 567 Nesting level is defined by number of hash- or arrayrefs that the
451 encoder needs to traverse to reach a given point or the number of 568 encoder needs to traverse to reach a given point or the number of
452 "{" or "[" characters without their matching closing parenthesis 569 "{" or "[" characters without their matching closing parenthesis
453 crossed to reach a given character in a string. 570 crossed to reach a given character in a string.
454 571
455 Setting the maximum depth to one disallows any nesting, so that 572 Setting the maximum depth to one disallows any nesting, so that
456 ensures that the object is only a single hash/object or array. 573 ensures that the object is only a single hash/object or array.
457 574
458 The argument to "max_depth" will be rounded up to the next highest
459 power of two. If no argument is given, the highest possible setting 575 If no argument is given, the highest possible setting will be used,
460 will be used, which is rarely useful. 576 which is rarely useful.
577
578 Note that nesting is implemented by recursion in C. The default
579 value has been chosen to be as large as typical operating systems
580 allow without crashing.
461 581
462 See SECURITY CONSIDERATIONS, below, for more info on why this is 582 See SECURITY CONSIDERATIONS, below, for more info on why this is
463 useful. 583 useful.
464 584
465 $json = $json->max_size ([$maximum_string_size]) 585 $json = $json->max_size ([$maximum_string_size])
586 $max_size = $json->get_max_size
466 Set the maximum length a JSON text may have (in bytes) where 587 Set the maximum length a JSON text may have (in bytes) where
467 decoding is being attempted. The default is 0, meaning no limit. 588 decoding is being attempted. The default is 0, meaning no limit.
468 When "decode" is called on a string longer then this number of 589 When "decode" is called on a string that is longer then this many
469 characters it will not attempt to decode the string but throw an 590 bytes, it will not attempt to decode the string but throw an
470 exception. This setting has no effect on "encode" (yet). 591 exception. This setting has no effect on "encode" (yet).
471 592
472 The argument to "max_size" will be rounded up to the next highest
473 power of two (so may be more than requested). If no argument is
474 given, the limit check will be deactivated (same as when 0 is 593 If no argument is given, the limit check will be deactivated (same
475 specified). 594 as when 0 is specified).
476 595
477 See SECURITY CONSIDERATIONS, below, for more info on why this is 596 See SECURITY CONSIDERATIONS, below, for more info on why this is
478 useful. 597 useful.
479 598
480 $json_text = $json->encode ($perl_scalar) 599 $json_text = $json->encode ($perl_scalar)
… …
505 and you need to know where the JSON text ends. 624 and you need to know where the JSON text ends.
506 625
507 JSON::XS->new->decode_prefix ("[1] the tail") 626 JSON::XS->new->decode_prefix ("[1] the tail")
508 => ([], 3) 627 => ([], 3)
509 628
629INCREMENTAL PARSING
630 In some cases, there is the need for incremental parsing of JSON texts.
631 While this module always has to keep both JSON text and resulting Perl
632 data structure in memory at one time, it does allow you to parse a JSON
633 stream incrementally. It does so by accumulating text until it has a
634 full JSON object, which it then can decode. This process is similar to
635 using "decode_prefix" to see if a full JSON object is available, but is
636 much more efficient (and can be implemented with a minimum of method
637 calls).
638
639 JSON::XS will only attempt to parse the JSON text once it is sure it has
640 enough text to get a decisive result, using a very simple but truly
641 incremental parser. This means that it sometimes won't stop as early as
642 the full parser, for example, it doesn't detect mismatched parentheses.
643 The only thing it guarantees is that it starts decoding as soon as a
644 syntactically valid JSON text has been seen. This means you need to set
645 resource limits (e.g. "max_size") to ensure the parser will stop parsing
646 in the presence if syntax errors.
647
648 The following methods implement this incremental parser.
649
650 [void, scalar or list context] = $json->incr_parse ([$string])
651 This is the central parsing function. It can both append new text
652 and extract objects from the stream accumulated so far (both of
653 these functions are optional).
654
655 If $string is given, then this string is appended to the already
656 existing JSON fragment stored in the $json object.
657
658 After that, if the function is called in void context, it will
659 simply return without doing anything further. This can be used to
660 add more text in as many chunks as you want.
661
662 If the method is called in scalar context, then it will try to
663 extract exactly *one* JSON object. If that is successful, it will
664 return this object, otherwise it will return "undef". If there is a
665 parse error, this method will croak just as "decode" would do (one
666 can then use "incr_skip" to skip the errornous part). This is the
667 most common way of using the method.
668
669 And finally, in list context, it will try to extract as many objects
670 from the stream as it can find and return them, or the empty list
671 otherwise. For this to work, there must be no separators between the
672 JSON objects or arrays, instead they must be concatenated
673 back-to-back. If an error occurs, an exception will be raised as in
674 the scalar context case. Note that in this case, any
675 previously-parsed JSON texts will be lost.
676
677 Example: Parse some JSON arrays/objects in a given string and return
678 them.
679
680 my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]");
681
682 $lvalue_string = $json->incr_text
683 This method returns the currently stored JSON fragment as an lvalue,
684 that is, you can manipulate it. This *only* works when a preceding
685 call to "incr_parse" in *scalar context* successfully returned an
686 object. Under all other circumstances you must not call this
687 function (I mean it. although in simple tests it might actually
688 work, it *will* fail under real world conditions). As a special
689 exception, you can also call this method before having parsed
690 anything.
691
692 This function is useful in two cases: a) finding the trailing text
693 after a JSON object or b) parsing multiple JSON objects separated by
694 non-JSON text (such as commas).
695
696 $json->incr_skip
697 This will reset the state of the incremental parser and will remove
698 the parsed text from the input buffer so far. This is useful after
699 "incr_parse" died, in which case the input buffer and incremental
700 parser state is left unchanged, to skip the text parsed so far and
701 to reset the parse state.
702
703 The difference to "incr_reset" is that only text until the parse
704 error occured is removed.
705
706 $json->incr_reset
707 This completely resets the incremental parser, that is, after this
708 call, it will be as if the parser had never parsed anything.
709
710 This is useful if you want to repeatedly parse JSON objects and want
711 to ignore any trailing data, which means you have to reset the
712 parser after each successful decode.
713
714 LIMITATIONS
715 All options that affect decoding are supported, except "allow_nonref".
716 The reason for this is that it cannot be made to work sensibly: JSON
717 objects and arrays are self-delimited, i.e. you can concatenate them
718 back to back and still decode them perfectly. This does not hold true
719 for JSON numbers, however.
720
721 For example, is the string 1 a single JSON number, or is it simply the
722 start of 12? Or is 12 a single JSON number, or the concatenation of 1
723 and 2? In neither case you can tell, and this is why JSON::XS takes the
724 conservative route and disallows this case.
725
726 EXAMPLES
727 Some examples will make all this clearer. First, a simple example that
728 works similarly to "decode_prefix": We want to decode the JSON object at
729 the start of a string and identify the portion after the JSON object:
730
731 my $text = "[1,2,3] hello";
732
733 my $json = new JSON::XS;
734
735 my $obj = $json->incr_parse ($text)
736 or die "expected JSON object or array at beginning of string";
737
738 my $tail = $json->incr_text;
739 # $tail now contains " hello"
740
741 Easy, isn't it?
742
743 Now for a more complicated example: Imagine a hypothetical protocol
744 where you read some requests from a TCP stream, and each request is a
745 JSON array, without any separation between them (in fact, it is often
746 useful to use newlines as "separators", as these get interpreted as
747 whitespace at the start of the JSON text, which makes it possible to
748 test said protocol with "telnet"...).
749
750 Here is how you'd do it (it is trivial to write this in an event-based
751 manner):
752
753 my $json = new JSON::XS;
754
755 # read some data from the socket
756 while (sysread $socket, my $buf, 4096) {
757
758 # split and decode as many requests as possible
759 for my $request ($json->incr_parse ($buf)) {
760 # act on the $request
761 }
762 }
763
764 Another complicated example: Assume you have a string with JSON objects
765 or arrays, all separated by (optional) comma characters (e.g. "[1],[2],
766 [3]"). To parse them, we have to skip the commas between the JSON texts,
767 and here is where the lvalue-ness of "incr_text" comes in useful:
768
769 my $text = "[1],[2], [3]";
770 my $json = new JSON::XS;
771
772 # void context, so no parsing done
773 $json->incr_parse ($text);
774
775 # now extract as many objects as possible. note the
776 # use of scalar context so incr_text can be called.
777 while (my $obj = $json->incr_parse) {
778 # do something with $obj
779
780 # now skip the optional comma
781 $json->incr_text =~ s/^ \s* , //x;
782 }
783
784 Now lets go for a very complex example: Assume that you have a gigantic
785 JSON array-of-objects, many gigabytes in size, and you want to parse it,
786 but you cannot load it into memory fully (this has actually happened in
787 the real world :).
788
789 Well, you lost, you have to implement your own JSON parser. But JSON::XS
790 can still help you: You implement a (very simple) array parser and let
791 JSON decode the array elements, which are all full JSON objects on their
792 own (this wouldn't work if the array elements could be JSON numbers, for
793 example):
794
795 my $json = new JSON::XS;
796
797 # open the monster
798 open my $fh, "<bigfile.json"
799 or die "bigfile: $!";
800
801 # first parse the initial "["
802 for (;;) {
803 sysread $fh, my $buf, 65536
804 or die "read error: $!";
805 $json->incr_parse ($buf); # void context, so no parsing
806
807 # Exit the loop once we found and removed(!) the initial "[".
808 # In essence, we are (ab-)using the $json object as a simple scalar
809 # we append data to.
810 last if $json->incr_text =~ s/^ \s* \[ //x;
811 }
812
813 # now we have the skipped the initial "[", so continue
814 # parsing all the elements.
815 for (;;) {
816 # in this loop we read data until we got a single JSON object
817 for (;;) {
818 if (my $obj = $json->incr_parse) {
819 # do something with $obj
820 last;
821 }
822
823 # add more data
824 sysread $fh, my $buf, 65536
825 or die "read error: $!";
826 $json->incr_parse ($buf); # void context, so no parsing
827 }
828
829 # in this loop we read data until we either found and parsed the
830 # separating "," between elements, or the final "]"
831 for (;;) {
832 # first skip whitespace
833 $json->incr_text =~ s/^\s*//;
834
835 # if we find "]", we are done
836 if ($json->incr_text =~ s/^\]//) {
837 print "finished.\n";
838 exit;
839 }
840
841 # if we find ",", we can continue with the next element
842 if ($json->incr_text =~ s/^,//) {
843 last;
844 }
845
846 # if we find anything else, we have a parse error!
847 if (length $json->incr_text) {
848 die "parse error near ", $json->incr_text;
849 }
850
851 # else add more data
852 sysread $fh, my $buf, 65536
853 or die "read error: $!";
854 $json->incr_parse ($buf); # void context, so no parsing
855 }
856
857 This is a complex example, but most of the complexity comes from the
858 fact that we are trying to be correct (bear with me if I am wrong, I
859 never ran the above example :).
860
510MAPPING 861MAPPING
511 This section describes how JSON::XS maps Perl values to JSON values and 862 This section describes how JSON::XS maps Perl values to JSON values and
512 vice versa. These mappings are designed to "do the right thing" in most 863 vice versa. These mappings are designed to "do the right thing" in most
513 circumstances automatically, preserving round-tripping characteristics 864 circumstances automatically, preserving round-tripping characteristics
514 (what you put in comes out as something equivalent). 865 (what you put in comes out as something equivalent).
515 866
516 For the more enlightened: note that in the following descriptions, 867 For the more enlightened: note that in the following descriptions,
517 lowercase *perl* refers to the Perl interpreter, while uppcercase *Perl* 868 lowercase *perl* refers to the Perl interpreter, while uppercase *Perl*
518 refers to the abstract Perl language itself. 869 refers to the abstract Perl language itself.
519 870
520 JSON -> PERL 871 JSON -> PERL
521 object 872 object
522 A JSON object becomes a reference to a hash in Perl. No ordering of 873 A JSON object becomes a reference to a hash in Perl. No ordering of
523 object keys is preserved (JSON does not preserver object key 874 object keys is preserved (JSON does not preserve object key ordering
524 ordering itself). 875 itself).
525 876
526 array 877 array
527 A JSON array becomes a reference to an array in Perl. 878 A JSON array becomes a reference to an array in Perl.
528 879
529 string 880 string
… …
535 A JSON number becomes either an integer, numeric (floating point) or 886 A JSON number becomes either an integer, numeric (floating point) or
536 string scalar in perl, depending on its range and any fractional 887 string scalar in perl, depending on its range and any fractional
537 parts. On the Perl level, there is no difference between those as 888 parts. On the Perl level, there is no difference between those as
538 Perl handles all the conversion details, but an integer may take 889 Perl handles all the conversion details, but an integer may take
539 slightly less memory and might represent more values exactly than 890 slightly less memory and might represent more values exactly than
540 (floating point) numbers. 891 floating point numbers.
541 892
542 If the number consists of digits only, JSON::XS will try to 893 If the number consists of digits only, JSON::XS will try to
543 represent it as an integer value. If that fails, it will try to 894 represent it as an integer value. If that fails, it will try to
544 represent it as a numeric (floating point) value if that is possible 895 represent it as a numeric (floating point) value if that is possible
545 without loss of precision. Otherwise it will preserve the number as 896 without loss of precision. Otherwise it will preserve the number as
546 a string value. 897 a string value (in which case you lose roundtripping ability, as the
898 JSON number will be re-encoded toa JSON string).
547 899
548 Numbers containing a fractional or exponential part will always be 900 Numbers containing a fractional or exponential part will always be
549 represented as numeric (floating point) values, possibly at a loss 901 represented as numeric (floating point) values, possibly at a loss
550 of precision. 902 of precision (in which case you might lose perfect roundtripping
903 ability, but the JSON number will still be re-encoded as a JSON
904 number).
551 905
552 This might create round-tripping problems as numbers might become 906 Note that precision is not accuracy - binary floating point values
553 strings, but as Perl is typeless there is no other way to do it. 907 cannot represent most decimal fractions exactly, and when converting
908 from and to floating point, JSON::XS only guarantees precision up to
909 but not including the leats significant bit.
554 910
555 true, false 911 true, false
556 These JSON atoms become "JSON::XS::true" and "JSON::XS::false", 912 These JSON atoms become "JSON::XS::true" and "JSON::XS::false",
557 respectively. They are overloaded to act almost exactly like the 913 respectively. They are overloaded to act almost exactly like the
558 numbers 1 and 0. You can check wether a scalar is a JSON boolean by 914 numbers 1 and 0. You can check whether a scalar is a JSON boolean by
559 using the "JSON::XS::is_bool" function. 915 using the "JSON::XS::is_bool" function.
560 916
561 null 917 null
562 A JSON null atom becomes "undef" in Perl. 918 A JSON null atom becomes "undef" in Perl.
563 919
… …
586 an exception to be thrown, except for references to the integers 0 942 an exception to be thrown, except for references to the integers 0
587 and 1, which get turned into "false" and "true" atoms in JSON. You 943 and 1, which get turned into "false" and "true" atoms in JSON. You
588 can also use "JSON::XS::false" and "JSON::XS::true" to improve 944 can also use "JSON::XS::false" and "JSON::XS::true" to improve
589 readability. 945 readability.
590 946
591 to_json [\0,JSON::XS::true] # yields [false,true] 947 encode_json [\0, JSON::XS::true] # yields [false,true]
592 948
593 JSON::XS::true, JSON::XS::false 949 JSON::XS::true, JSON::XS::false
594 These special values become JSON true and JSON false values, 950 These special values become JSON true and JSON false values,
595 respectively. You cna alos use "\1" and "\0" directly if you want. 951 respectively. You can also use "\1" and "\0" directly if you want.
596 952
597 blessed objects 953 blessed objects
598 Blessed objects are not allowed. JSON::XS currently tries to encode 954 Blessed objects are not directly representable in JSON. See the
599 their underlying representation (hash- or arrayref), but this 955 "allow_blessed" and "convert_blessed" methods on various options on
600 behaviour might change in future versions. 956 how to deal with this: basically, you can choose between throwing an
957 exception, encoding the reference as if it weren't blessed, or
958 provide your own serialiser method.
601 959
602 simple scalars 960 simple scalars
603 Simple Perl scalars (any scalar that is not a reference) are the 961 Simple Perl scalars (any scalar that is not a reference) are the
604 most difficult objects to encode: JSON::XS will encode undefined 962 most difficult objects to encode: JSON::XS will encode undefined
605 scalars as JSON null value, scalars that have last been used in a 963 scalars as JSON "null" values, scalars that have last been used in a
606 string context before encoding as JSON strings and anything else as 964 string context before encoding as JSON strings, and anything else as
607 number value: 965 number value:
608 966
609 # dump as number 967 # dump as number
610 to_json [2] # yields [2] 968 encode_json [2] # yields [2]
611 to_json [-3.0e17] # yields [-3e+17] 969 encode_json [-3.0e17] # yields [-3e+17]
612 my $value = 5; to_json [$value] # yields [5] 970 my $value = 5; encode_json [$value] # yields [5]
613 971
614 # used as string, so dump as string 972 # used as string, so dump as string
615 print $value; 973 print $value;
616 to_json [$value] # yields ["5"] 974 encode_json [$value] # yields ["5"]
617 975
618 # undef becomes null 976 # undef becomes null
619 to_json [undef] # yields [null] 977 encode_json [undef] # yields [null]
620 978
621 You can force the type to be a string by stringifying it: 979 You can force the type to be a JSON string by stringifying it:
622 980
623 my $x = 3.1; # some variable containing a number 981 my $x = 3.1; # some variable containing a number
624 "$x"; # stringified 982 "$x"; # stringified
625 $x .= ""; # another, more awkward way to stringify 983 $x .= ""; # another, more awkward way to stringify
626 print $x; # perl does it for you, too, quite often 984 print $x; # perl does it for you, too, quite often
627 985
628 You can force the type to be a number by numifying it: 986 You can force the type to be a JSON number by numifying it:
629 987
630 my $x = "3"; # some variable containing a string 988 my $x = "3"; # some variable containing a string
631 $x += 0; # numify it, ensuring it will be dumped as a number 989 $x += 0; # numify it, ensuring it will be dumped as a number
632 $x *= 1; # same thing, the choise is yours. 990 $x *= 1; # same thing, the choice is yours.
633 991
634 You can not currently output JSON booleans or force the type in 992 You can not currently force the type in other, less obscure, ways.
635 other, less obscure, ways. Tell me if you need this capability. 993 Tell me if you need this capability (but don't forget to explain why
994 it's needed :).
636 995
637COMPARISON 996 Note that numerical precision has the same meaning as under Perl (so
638 As already mentioned, this module was created because none of the 997 binary to decimal conversion follows the same rules as in Perl,
639 existing JSON modules could be made to work correctly. First I will 998 which can differ to other languages). Also, your perl interpreter
640 describe the problems (or pleasures) I encountered with various existing 999 might expose extensions to the floating point numbers of your
641 JSON modules, followed by some benchmark values. JSON::XS was designed 1000 platform, such as infinities or NaN's - these cannot be represented
642 not to suffer from any of these problems or limitations. 1001 in JSON, and it is an error to pass those in.
643 1002
644 JSON 1.07 1003ENCODING/CODESET FLAG NOTES
645 Slow (but very portable, as it is written in pure Perl). 1004 The interested reader might have seen a number of flags that signify
1005 encodings or codesets - "utf8", "latin1" and "ascii". There seems to be
1006 some confusion on what these do, so here is a short comparison:
646 1007
647 Undocumented/buggy Unicode handling (how JSON handles unicode values 1008 "utf8" controls whether the JSON text created by "encode" (and expected
648 is undocumented. One can get far by feeding it unicode strings and 1009 by "decode") is UTF-8 encoded or not, while "latin1" and "ascii" only
649 doing en-/decoding oneself, but unicode escapes are not working 1010 control whether "encode" escapes character values outside their
1011 respective codeset range. Neither of these flags conflict with each
1012 other, although some combinations make less sense than others.
1013
1014 Care has been taken to make all flags symmetrical with respect to
1015 "encode" and "decode", that is, texts encoded with any combination of
1016 these flag values will be correctly decoded when the same flags are used
1017 - in general, if you use different flag settings while encoding vs. when
1018 decoding you likely have a bug somewhere.
1019
1020 Below comes a verbose discussion of these flags. Note that a "codeset"
1021 is simply an abstract set of character-codepoint pairs, while an
1022 encoding takes those codepoint numbers and *encodes* them, in our case
1023 into octets. Unicode is (among other things) a codeset, UTF-8 is an
1024 encoding, and ISO-8859-1 (= latin 1) and ASCII are both codesets *and*
1025 encodings at the same time, which can be confusing.
1026
1027 "utf8" flag disabled
1028 When "utf8" is disabled (the default), then "encode"/"decode"
1029 generate and expect Unicode strings, that is, characters with high
1030 ordinal Unicode values (> 255) will be encoded as such characters,
1031 and likewise such characters are decoded as-is, no canges to them
1032 will be done, except "(re-)interpreting" them as Unicode codepoints
1033 or Unicode characters, respectively (to Perl, these are the same
1034 thing in strings unless you do funny/weird/dumb stuff).
1035
1036 This is useful when you want to do the encoding yourself (e.g. when
1037 you want to have UTF-16 encoded JSON texts) or when some other layer
1038 does the encoding for you (for example, when printing to a terminal
1039 using a filehandle that transparently encodes to UTF-8 you certainly
1040 do NOT want to UTF-8 encode your data first and have Perl encode it
1041 another time).
1042
1043 "utf8" flag enabled
1044 If the "utf8"-flag is enabled, "encode"/"decode" will encode all
1045 characters using the corresponding UTF-8 multi-byte sequence, and
1046 will expect your input strings to be encoded as UTF-8, that is, no
1047 "character" of the input string must have any value > 255, as UTF-8
1048 does not allow that.
1049
1050 The "utf8" flag therefore switches between two modes: disabled means
1051 you will get a Unicode string in Perl, enabled means you get an
1052 UTF-8 encoded octet/binary string in Perl.
1053
1054 "latin1" or "ascii" flags enabled
1055 With "latin1" (or "ascii") enabled, "encode" will escape characters
1056 with ordinal values > 255 (> 127 with "ascii") and encode the
1057 remaining characters as specified by the "utf8" flag.
1058
1059 If "utf8" is disabled, then the result is also correctly encoded in
1060 those character sets (as both are proper subsets of Unicode, meaning
1061 that a Unicode string with all character values < 256 is the same
1062 thing as a ISO-8859-1 string, and a Unicode string with all
1063 character values < 128 is the same thing as an ASCII string in
650 properly). 1064 Perl).
651 1065
652 No roundtripping (strings get clobbered if they look like numbers, 1066 If "utf8" is enabled, you still get a correct UTF-8-encoded string,
653 e.g. the string 2.0 will encode to 2.0 instead of "2.0", and that 1067 regardless of these flags, just some more characters will be escaped
654 will decode into the number 2. 1068 using "\uXXXX" then before.
655 1069
656 JSON::PC 0.01 1070 Note that ISO-8859-1-*encoded* strings are not compatible with UTF-8
657 Very fast. 1071 encoding, while ASCII-encoded strings are. That is because the
1072 ISO-8859-1 encoding is NOT a subset of UTF-8 (despite the ISO-8859-1
1073 *codeset* being a subset of Unicode), while ASCII is.
658 1074
659 Undocumented/buggy Unicode handling. 1075 Surprisingly, "decode" will ignore these flags and so treat all
1076 input values as governed by the "utf8" flag. If it is disabled, this
1077 allows you to decode ISO-8859-1- and ASCII-encoded strings, as both
1078 strict subsets of Unicode. If it is enabled, you can correctly
1079 decode UTF-8 encoded strings.
660 1080
661 No roundtripping. 1081 So neither "latin1" nor "ascii" are incompatible with the "utf8"
1082 flag - they only govern when the JSON output engine escapes a
1083 character or not.
662 1084
663 Has problems handling many Perl values (e.g. regex results and other 1085 The main use for "latin1" is to relatively efficiently store binary
664 magic values will make it croak). 1086 data as JSON, at the expense of breaking compatibility with most
1087 JSON decoders.
665 1088
666 Does not even generate valid JSON ("{1,2}" gets converted to "{1:2}" 1089 The main use for "ascii" is to force the output to not contain
667 which is not a valid JSON text. 1090 characters with values > 127, which means you can interpret the
1091 resulting string as UTF-8, ISO-8859-1, ASCII, KOI8-R or most about
1092 any character set and 8-bit-encoding, and still get the same data
1093 structure back. This is useful when your channel for JSON transfer
1094 is not 8-bit clean or the encoding might be mangled in between (e.g.
1095 in mail), and works because ASCII is a proper subset of most 8-bit
1096 and multibyte encodings in use in the world.
668 1097
669 Unmaintained (maintainer unresponsive for many months, bugs are not 1098 JSON and ECMAscript
670 getting fixed). 1099 JSON syntax is based on how literals are represented in javascript (the
1100 not-standardised predecessor of ECMAscript) which is presumably why it
1101 is called "JavaScript Object Notation".
671 1102
672 JSON::Syck 0.21 1103 However, JSON is not a subset (and also not a superset of course) of
673 Very buggy (often crashes). 1104 ECMAscript (the standard) or javascript (whatever browsers actually
1105 implement).
674 1106
675 Very inflexible (no human-readable format supported, format pretty 1107 If you want to use javascript's "eval" function to "parse" JSON, you
676 much undocumented. I need at least a format for easy reading by 1108 might run into parse errors for valid JSON texts, or the resulting data
677 humans and a single-line compact format for use in a protocol, and 1109 structure might not be queryable:
678 preferably a way to generate ASCII-only JSON texts).
679 1110
680 Completely broken (and confusingly documented) Unicode handling 1111 One of the problems is that U+2028 and U+2029 are valid characters
681 (unicode escapes are not working properly, you need to set 1112 inside JSON strings, but are not allowed in ECMAscript string literals,
682 ImplicitUnicode to *different* values on en- and decoding to get 1113 so the following Perl fragment will not output something that can be
683 symmetric behaviour). 1114 guaranteed to be parsable by javascript's "eval":
684 1115
685 No roundtripping (simple cases work, but this depends on wether the 1116 use JSON::XS;
686 scalar value was used in a numeric context or not).
687 1117
688 Dumping hashes may skip hash values depending on iterator state. 1118 print encode_json [chr 0x2028];
689 1119
690 Unmaintained (maintainer unresponsive for many months, bugs are not 1120 The right fix for this is to use a proper JSON parser in your javascript
691 getting fixed). 1121 programs, and not rely on "eval" (see for example Douglas Crockford's
1122 json2.js parser).
692 1123
693 Does not check input for validity (i.e. will accept non-JSON input 1124 If this is not an option, you can, as a stop-gap measure, simply encode
694 and return "something" instead of raising an exception. This is a 1125 to ASCII-only JSON:
695 security issue: imagine two banks transfering money between each
696 other using JSON. One bank might parse a given non-JSON request and
697 deduct money, while the other might reject the transaction with a
698 syntax error. While a good protocol will at least recover, that is
699 extra unnecessary work and the transaction will still not succeed).
700 1126
701 JSON::DWIW 0.04 1127 use JSON::XS;
702 Very fast. Very natural. Very nice.
703 1128
704 Undocumented unicode handling (but the best of the pack. Unicode 1129 print JSON::XS->new->ascii->encode ([chr 0x2028]);
705 escapes still don't get parsed properly).
706 1130
707 Very inflexible. 1131 Note that this will enlarge the resulting JSON text quite a bit if you
1132 have many non-ASCII characters. You might be tempted to run some regexes
1133 to only escape U+2028 and U+2029, e.g.:
708 1134
709 No roundtripping. 1135 # DO NOT USE THIS!
1136 my $json = JSON::XS->new->utf8->encode ([chr 0x2028]);
1137 $json =~ s/\xe2\x80\xa8/\\u2028/g; # escape U+2028
1138 $json =~ s/\xe2\x80\xa9/\\u2029/g; # escape U+2029
1139 print $json;
710 1140
711 Does not generate valid JSON texts (key strings are often unquoted, 1141 Note that *this is a bad idea*: the above only works for U+2028 and
712 empty keys result in nothing being output) 1142 U+2029 and thus only for fully ECMAscript-compliant parsers. Many
1143 existing javascript implementations, however, have issues with other
1144 characters as well - using "eval" naively simply *will* cause problems.
713 1145
714 Does not check input for validity. 1146 Another problem is that some javascript implementations reserve some
1147 property names for their own purposes (which probably makes them
1148 non-ECMAscript-compliant). For example, Iceweasel reserves the
1149 "__proto__" property name for its own purposes.
1150
1151 If that is a problem, you could parse try to filter the resulting JSON
1152 output for these property strings, e.g.:
1153
1154 $json =~ s/"__proto__"\s*:/"__proto__renamed":/g;
1155
1156 This works because "__proto__" is not valid outside of strings, so every
1157 occurence of ""__proto__"\s*:" must be a string used as property name.
1158
1159 If you know of other incompatibilities, please let me know.
715 1160
716 JSON and YAML 1161 JSON and YAML
717 You often hear that JSON is a subset (or a close subset) of YAML. This 1162 You often hear that JSON is a subset of YAML. This is, however, a mass
718 is, however, a mass hysteria and very far from the truth. In general, 1163 hysteria(*) and very far from the truth (as of the time of this
719 there is no way to configure JSON::XS to output a data structure as 1164 writing), so let me state it clearly: *in general, there is no way to
720 valid YAML. 1165 configure JSON::XS to output a data structure as valid YAML* that works
1166 in all cases.
721 1167
722 If you really must use JSON::XS to generate YAML, you should use this 1168 If you really must use JSON::XS to generate YAML, you should use this
723 algorithm (subject to change in future versions): 1169 algorithm (subject to change in future versions):
724 1170
725 my $to_yaml = JSON::XS->new->utf8->space_after (1); 1171 my $to_yaml = JSON::XS->new->utf8->space_after (1);
726 my $yaml = $to_yaml->encode ($ref) . "\n"; 1172 my $yaml = $to_yaml->encode ($ref) . "\n";
727 1173
728 This will usually generate JSON texts that also parse as valid YAML. 1174 This will *usually* generate JSON texts that also parse as valid YAML.
729 Please note that YAML has hardcoded limits on (simple) object key 1175 Please note that YAML has hardcoded limits on (simple) object key
730 lengths that JSON doesn't have, so you should make sure that your hash 1176 lengths that JSON doesn't have and also has different and incompatible
1177 unicode character escape syntax, so you should make sure that your hash
731 keys are noticably shorter than the 1024 characters YAML allows. 1178 keys are noticeably shorter than the 1024 "stream characters" YAML
1179 allows and that you do not have characters with codepoint values outside
1180 the Unicode BMP (basic multilingual page). YAML also does not allow "\/"
1181 sequences in strings (which JSON::XS does not *currently* generate, but
1182 other JSON generators might).
732 1183
733 There might be other incompatibilities that I am not aware of. In 1184 There might be other incompatibilities that I am not aware of (or the
1185 YAML specification has been changed yet again - it does so quite often).
734 general you should not try to generate YAML with a JSON generator or 1186 In general you should not try to generate YAML with a JSON generator or
735 vice versa, or try to parse JSON with a YAML parser or vice versa: 1187 vice versa, or try to parse JSON with a YAML parser or vice versa:
736 chances are high that you will run into severe interoperability 1188 chances are high that you will run into severe interoperability problems
737 problems. 1189 when you least expect it.
1190
1191 (*) I have been pressured multiple times by Brian Ingerson (one of the
1192 authors of the YAML specification) to remove this paragraph, despite
1193 him acknowledging that the actual incompatibilities exist. As I was
1194 personally bitten by this "JSON is YAML" lie, I refused and said I
1195 will continue to educate people about these issues, so others do not
1196 run into the same problem again and again. After this, Brian called
1197 me a (quote)*complete and worthless idiot*(unquote).
1198
1199 In my opinion, instead of pressuring and insulting people who
1200 actually clarify issues with YAML and the wrong statements of some
1201 of its proponents, I would kindly suggest reading the JSON spec
1202 (which is not that difficult or long) and finally make YAML
1203 compatible to it, and educating users about the changes, instead of
1204 spreading lies about the real compatibility for many *years* and
1205 trying to silence people who point out that it isn't true.
1206
1207 Addendum/2009: the YAML 1.2 spec is still incompatible with JSON,
1208 even though the incompatibilities have been documented (and are
1209 known to Brian) for many years and the spec makes explicit claims
1210 that YAML is a superset of JSON. It would be so easy to fix, but
1211 apparently, bullying people and corrupting userdata is so much
1212 easier.
738 1213
739 SPEED 1214 SPEED
740 It seems that JSON::XS is surprisingly fast, as shown in the following 1215 It seems that JSON::XS is surprisingly fast, as shown in the following
741 tables. They have been generated with the help of the "eg/bench" program 1216 tables. They have been generated with the help of the "eg/bench" program
742 in the JSON::XS distribution, to make it easy to compare on your own 1217 in the JSON::XS distribution, to make it easy to compare on your own
743 system. 1218 system.
744 1219
745 First comes a comparison between various modules using a very short 1220 First comes a comparison between various modules using a very short
746 single-line JSON string: 1221 single-line JSON string (also available at
1222 <http://dist.schmorp.de/misc/json/short.json>).
747 1223
748 {"method": "handleMessage", "params": ["user1", "we were just talking"], \ 1224 {"method": "handleMessage", "params": ["user1",
749 "id": null, "array":[1,11,234,-5,1e5,1e7, true, false]} 1225 "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,
1226 1, 0]}
750 1227
751 It shows the number of encodes/decodes per second (JSON::XS uses the 1228 It shows the number of encodes/decodes per second (JSON::XS uses the
752 functional interface, while JSON::XS/2 uses the OO interface with 1229 functional interface, while JSON::XS/2 uses the OO interface with
753 pretty-printing and hashkey sorting enabled, JSON::XS/3 enables shrink). 1230 pretty-printing and hashkey sorting enabled, JSON::XS/3 enables shrink.
754 Higher is better: 1231 JSON::DWIW/DS uses the deserialise function, while JSON::DWIW::FJ uses
1232 the from_json method). Higher is better:
755 1233
756 Storable | 15779.925 | 14169.946 |
757 -----------+------------+------------+
758 module | encode | decode | 1234 module | encode | decode |
759 -----------|------------|------------| 1235 --------------|------------|------------|
760 JSON | 4990.842 | 4088.813 | 1236 JSON::DWIW/DS | 86302.551 | 102300.098 |
761 JSON::DWIW | 51653.990 | 71575.154 | 1237 JSON::DWIW/FJ | 86302.551 | 75983.768 |
762 JSON::PC | 65948.176 | 74631.744 | 1238 JSON::PP | 15827.562 | 6638.658 |
763 JSON::PP | 8931.652 | 3817.168 | 1239 JSON::Syck | 63358.066 | 47662.545 |
764 JSON::Syck | 24877.248 | 27776.848 | 1240 JSON::XS | 511500.488 | 511500.488 |
765 JSON::XS | 388361.481 | 227951.304 | 1241 JSON::XS/2 | 291271.111 | 388361.481 |
766 JSON::XS/2 | 227951.304 | 218453.333 | 1242 JSON::XS/3 | 361577.931 | 361577.931 |
767 JSON::XS/3 | 338250.323 | 218453.333 | 1243 Storable | 66788.280 | 265462.278 |
768 Storable | 16500.016 | 135300.129 |
769 -----------+------------+------------+ 1244 --------------+------------+------------+
770 1245
771 That is, JSON::XS is about five times faster than JSON::DWIW on 1246 That is, JSON::XS is almost six times faster than JSON::DWIW on
772 encoding, about three times faster on decoding, and over fourty times 1247 encoding, about five times faster on decoding, and over thirty to
773 faster than JSON, even with pretty-printing and key sorting. It also 1248 seventy times faster than JSON's pure perl implementation. It also
774 compares favourably to Storable for small amounts of data. 1249 compares favourably to Storable for small amounts of data.
775 1250
776 Using a longer test string (roughly 18KB, generated from Yahoo! Locals 1251 Using a longer test string (roughly 18KB, generated from Yahoo! Locals
777 search API (http://nanoref.com/yahooapis/mgPdGg): 1252 search API (<http://dist.schmorp.de/misc/json/long.json>).
778 1253
779 module | encode | decode | 1254 module | encode | decode |
780 -----------|------------|------------| 1255 --------------|------------|------------|
781 JSON | 55.260 | 34.971 | 1256 JSON::DWIW/DS | 1647.927 | 2673.916 |
782 JSON::DWIW | 825.228 | 1082.513 | 1257 JSON::DWIW/FJ | 1630.249 | 2596.128 |
783 JSON::PC | 3571.444 | 2394.829 |
784 JSON::PP | 210.987 | 32.574 | 1258 JSON::PP | 400.640 | 62.311 |
785 JSON::Syck | 552.551 | 787.544 | 1259 JSON::Syck | 1481.040 | 1524.869 |
786 JSON::XS | 5780.463 | 4854.519 | 1260 JSON::XS | 20661.596 | 9541.183 |
787 JSON::XS/2 | 3869.998 | 4798.975 | 1261 JSON::XS/2 | 10683.403 | 9416.938 |
788 JSON::XS/3 | 5862.880 | 4798.975 | 1262 JSON::XS/3 | 20661.596 | 9400.054 |
789 Storable | 4445.002 | 5235.027 | 1263 Storable | 19765.806 | 10000.725 |
790 -----------+------------+------------+ 1264 --------------+------------+------------+
791 1265
792 Again, JSON::XS leads by far (except for Storable which non-surprisingly 1266 Again, JSON::XS leads by far (except for Storable which non-surprisingly
793 decodes faster). 1267 decodes a bit faster).
794 1268
795 On large strings containing lots of high unicode characters, some 1269 On large strings containing lots of high Unicode characters, some
796 modules (such as JSON::PC) seem to decode faster than JSON::XS, but the 1270 modules (such as JSON::PC) seem to decode faster than JSON::XS, but the
797 result will be broken due to missing (or wrong) unicode handling. Others 1271 result will be broken due to missing (or wrong) Unicode handling. Others
798 refuse to decode or encode properly, so it was impossible to prepare a 1272 refuse to decode or encode properly, so it was impossible to prepare a
799 fair comparison table for that case. 1273 fair comparison table for that case.
800 1274
801SECURITY CONSIDERATIONS 1275SECURITY CONSIDERATIONS
802 When you are using JSON in a protocol, talking to untrusted potentially 1276 When you are using JSON in a protocol, talking to untrusted potentially
… …
806 have any buffer overflows. Obviously, this module should ensure that and 1280 have any buffer overflows. Obviously, this module should ensure that and
807 I am trying hard on making that true, but you never know. 1281 I am trying hard on making that true, but you never know.
808 1282
809 Second, you need to avoid resource-starving attacks. That means you 1283 Second, you need to avoid resource-starving attacks. That means you
810 should limit the size of JSON texts you accept, or make sure then when 1284 should limit the size of JSON texts you accept, or make sure then when
811 your resources run out, thats just fine (e.g. by using a separate 1285 your resources run out, that's just fine (e.g. by using a separate
812 process that can crash safely). The size of a JSON text in octets or 1286 process that can crash safely). The size of a JSON text in octets or
813 characters is usually a good indication of the size of the resources 1287 characters is usually a good indication of the size of the resources
814 required to decode it into a Perl structure. While JSON::XS can check 1288 required to decode it into a Perl structure. While JSON::XS can check
815 the size of the JSON text, it might be too late when you already have it 1289 the size of the JSON text, it might be too late when you already have it
816 in memory, so you might want to check the size before you accept the 1290 in memory, so you might want to check the size before you accept the
… …
819 Third, JSON::XS recurses using the C stack when decoding objects and 1293 Third, JSON::XS recurses using the C stack when decoding objects and
820 arrays. The C stack is a limited resource: for instance, on my amd64 1294 arrays. The C stack is a limited resource: for instance, on my amd64
821 machine with 8MB of stack size I can decode around 180k nested arrays 1295 machine with 8MB of stack size I can decode around 180k nested arrays
822 but only 14k nested JSON objects (due to perl itself recursing deeply on 1296 but only 14k nested JSON objects (due to perl itself recursing deeply on
823 croak to free the temporary). If that is exceeded, the program crashes. 1297 croak to free the temporary). If that is exceeded, the program crashes.
824 to be conservative, the default nesting limit is set to 512. If your 1298 To be conservative, the default nesting limit is set to 512. If your
825 process has a smaller stack, you should adjust this setting accordingly 1299 process has a smaller stack, you should adjust this setting accordingly
826 with the "max_depth" method. 1300 with the "max_depth" method.
827 1301
828 And last but least, something else could bomb you that I forgot to think 1302 Something else could bomb you, too, that I forgot to think of. In that
829 of. In that case, you get to keep the pieces. I am always open for 1303 case, you get to keep the pieces. I am always open for hints, though...
830 hints, though...
831 1304
1305 Also keep in mind that JSON::XS might leak contents of your Perl data
1306 structures in its error messages, so when you serialise sensitive
1307 information you might want to make sure that exceptions thrown by
1308 JSON::XS will not end up in front of untrusted eyes.
1309
832 If you are using JSON::XS to return packets to consumption by javascript 1310 If you are using JSON::XS to return packets to consumption by JavaScript
833 scripts in a browser you should have a look at 1311 scripts in a browser you should have a look at
834 <http://jpsykes.com/47/practical-csrf-and-json-security> to see wether 1312 <http://blog.archive.jpsykes.com/47/practical-csrf-and-json-security/>
835 you are vulnerable to some common attack vectors (which really are 1313 to see whether you are vulnerable to some common attack vectors (which
836 browser design bugs, but it is still you who will have to deal with it, 1314 really are browser design bugs, but it is still you who will have to
837 as major browser developers care only for features, not about doing 1315 deal with it, as major browser developers care only for features, not
838 security right). 1316 about getting security right).
1317
1318THREADS
1319 This module is *not* guaranteed to be thread safe and there are no plans
1320 to change this until Perl gets thread support (as opposed to the
1321 horribly slow so-called "threads" which are simply slow and bloated
1322 process simulations - use fork, it's *much* faster, cheaper, better).
1323
1324 (It might actually work, but you have been warned).
1325
1326THE PERILS OF SETLOCALE
1327 Sometimes people avoid the Perl locale support and directly call the
1328 system's setlocale function with "LC_ALL".
1329
1330 This breaks both perl and modules such as JSON::XS, as stringification
1331 of numbers no longer works correcly (e.g. "$x = 0.1; print "$x"+1" might
1332 print 1, and JSON::XS might output illegal JSON as JSON::XS relies on
1333 perl to stringify numbers).
1334
1335 The solution is simple: don't call "setlocale", or use it for only those
1336 categories you need, such as "LC_MESSAGES" or "LC_CTYPE".
1337
1338 If you need "LC_NUMERIC", you should enable it only around the code that
1339 actually needs it (avoiding stringification of numbers), and restore it
1340 afterwards.
839 1341
840BUGS 1342BUGS
841 While the goal of this module is to be correct, that unfortunately does 1343 While the goal of this module is to be correct, that unfortunately does
842 not mean its bug-free, only that I think its design is bug-free. It is 1344 not mean it's bug-free, only that I think its design is bug-free. If you
843 still relatively early in its development. If you keep reporting bugs
844 they will be fixed swiftly, though. 1345 keep reporting bugs they will be fixed swiftly, though.
1346
1347 Please refrain from using rt.cpan.org or any other bug reporting
1348 service. I put the contact address into my modules for a reason.
1349
1350SEE ALSO
1351 The json_xs command line utility for quick experiments.
845 1352
846AUTHOR 1353AUTHOR
847 Marc Lehmann <schmorp@schmorp.de> 1354 Marc Lehmann <schmorp@schmorp.de>
848 http://home.schmorp.de/ 1355 http://home.schmorp.de/
849 1356

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines