… | |
… | |
3 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
3 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use JSON::XS; |
7 | use JSON::XS; |
|
|
8 | |
|
|
9 | # exported functions, croak on error |
|
|
10 | |
|
|
11 | $utf8_encoded_json_text = to_json $perl_hash_or_arrayref; |
|
|
12 | $perl_hash_or_arrayref = from_json $utf8_encoded_json_text; |
|
|
13 | |
|
|
14 | # oo-interface |
|
|
15 | |
|
|
16 | $coder = JSON::XS->new->ascii->pretty->allow_nonref; |
|
|
17 | $pretty_printed_unencoded = $coder->encode ($perl_scalar); |
|
|
18 | $perl_scalar = $coder->decode ($unicode_json_text); |
8 | |
19 | |
9 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
10 | |
21 | |
11 | This module converts Perl data structures to JSON and vice versa. Its |
22 | This module converts Perl data structures to JSON and vice versa. Its |
12 | primary goal is to be I<correct> and its secondary goal is to be |
23 | primary goal is to be I<correct> and its secondary goal is to be |
… | |
… | |
38 | by JSON, the deserialised data structure is identical on the Perl level. |
49 | by JSON, the deserialised data structure is identical on the Perl level. |
39 | (e.g. the string "2.0" doesn't suddenly become "2"). |
50 | (e.g. the string "2.0" doesn't suddenly become "2"). |
40 | |
51 | |
41 | =item * strict checking of JSON correctness |
52 | =item * strict checking of JSON correctness |
42 | |
53 | |
43 | There is no guessing, no generating of illegal JSON strings by default, |
54 | There is no guessing, no generating of illegal JSON texts by default, |
44 | and only JSON is accepted as input by default (the latter is a security |
55 | and only JSON is accepted as input by default (the latter is a security |
45 | feature). |
56 | feature). |
46 | |
57 | |
47 | =item * fast |
58 | =item * fast |
48 | |
59 | |
… | |
… | |
66 | |
77 | |
67 | =cut |
78 | =cut |
68 | |
79 | |
69 | package JSON::XS; |
80 | package JSON::XS; |
70 | |
81 | |
|
|
82 | use strict; |
|
|
83 | |
71 | BEGIN { |
84 | BEGIN { |
72 | $VERSION = '0.3'; |
85 | our $VERSION = '0.7'; |
73 | @ISA = qw(Exporter); |
86 | our @ISA = qw(Exporter); |
74 | |
87 | |
75 | @EXPORT = qw(to_json from_json); |
88 | our @EXPORT = qw(to_json from_json); |
76 | require Exporter; |
89 | require Exporter; |
77 | |
90 | |
78 | require XSLoader; |
91 | require XSLoader; |
79 | XSLoader::load JSON::XS::, $VERSION; |
92 | XSLoader::load JSON::XS::, $VERSION; |
80 | } |
93 | } |
… | |
… | |
84 | The following convinience methods are provided by this module. They are |
97 | The following convinience methods are provided by this module. They are |
85 | exported by default: |
98 | exported by default: |
86 | |
99 | |
87 | =over 4 |
100 | =over 4 |
88 | |
101 | |
89 | =item $json_string = to_json $perl_scalar |
102 | =item $json_text = to_json $perl_scalar |
90 | |
103 | |
91 | Converts the given Perl data structure (a simple scalar or a reference to |
104 | Converts the given Perl data structure (a simple scalar or a reference to |
92 | a hash or array) to a UTF-8 encoded, binary string (that is, the string contains |
105 | a hash or array) to a UTF-8 encoded, binary string (that is, the string contains |
93 | octets only). Croaks on error. |
106 | octets only). Croaks on error. |
94 | |
107 | |
95 | This function call is functionally identical to C<< JSON::XS->new->utf8->encode ($perl_scalar) >>. |
108 | This function call is functionally identical to: |
96 | |
109 | |
|
|
110 | $json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
|
|
111 | |
|
|
112 | except being faster. |
|
|
113 | |
97 | =item $perl_scalar = from_json $json_string |
114 | =item $perl_scalar = from_json $json_text |
98 | |
115 | |
99 | The opposite of C<to_json>: expects an UTF-8 (binary) string and tries to |
116 | The opposite of C<to_json>: expects an UTF-8 (binary) string and tries to |
100 | parse that as an UTF-8 encoded JSON string, returning the resulting simple |
117 | parse that as an UTF-8 encoded JSON text, returning the resulting simple |
101 | scalar or reference. Croaks on error. |
118 | scalar or reference. Croaks on error. |
102 | |
119 | |
103 | This function call is functionally identical to C<< JSON::XS->new->utf8->decode ($json_string) >>. |
120 | This function call is functionally identical to: |
|
|
121 | |
|
|
122 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
|
|
123 | |
|
|
124 | except being faster. |
104 | |
125 | |
105 | =back |
126 | =back |
106 | |
127 | |
107 | =head1 OBJECT-ORIENTED INTERFACE |
128 | =head1 OBJECT-ORIENTED INTERFACE |
108 | |
129 | |
… | |
… | |
117 | strings. All boolean flags described below are by default I<disabled>. |
138 | strings. All boolean flags described below are by default I<disabled>. |
118 | |
139 | |
119 | The mutators for flags all return the JSON object again and thus calls can |
140 | The mutators for flags all return the JSON object again and thus calls can |
120 | be chained: |
141 | be chained: |
121 | |
142 | |
122 | my $json = JSON::XS->new->utf8(1)->space_after(1)->encode ({a => [1,2]}) |
143 | my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]}) |
123 | => {"a": [1, 2]} |
144 | => {"a": [1, 2]} |
124 | |
145 | |
125 | =item $json = $json->ascii ([$enable]) |
146 | =item $json = $json->ascii ([$enable]) |
126 | |
147 | |
127 | If C<$enable> is true (or missing), then the C<encode> method will |
148 | If C<$enable> is true (or missing), then the C<encode> method will not |
128 | not generate characters outside the code range C<0..127>. Any unicode |
149 | generate characters outside the code range C<0..127> (which is ASCII). Any |
129 | characters outside that range will be escaped using either a single |
150 | unicode characters outside that range will be escaped using either a |
130 | \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence, as per |
151 | single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence, |
131 | RFC4627. |
152 | as per RFC4627. |
132 | |
153 | |
133 | If C<$enable> is false, then the C<encode> method will not escape Unicode |
154 | If C<$enable> is false, then the C<encode> method will not escape Unicode |
134 | characters unless necessary. |
155 | characters unless required by the JSON syntax. This results in a faster |
|
|
156 | and more compact format. |
135 | |
157 | |
136 | JSON::XS->new->ascii (1)->encode (chr 0x10401) |
158 | JSON::XS->new->ascii (1)->encode ([chr 0x10401]) |
137 | => \ud801\udc01 |
159 | => ["\ud801\udc01"] |
138 | |
160 | |
139 | =item $json = $json->utf8 ([$enable]) |
161 | =item $json = $json->utf8 ([$enable]) |
140 | |
162 | |
141 | If C<$enable> is true (or missing), then the C<encode> method will encode |
163 | If C<$enable> is true (or missing), then the C<encode> method will encode |
142 | the JSON string into UTF-8, as required by many protocols, while the |
164 | the JSON result into UTF-8, as required by many protocols, while the |
143 | C<decode> method expects to be handled an UTF-8-encoded string. Please |
165 | C<decode> method expects to be handled an UTF-8-encoded string. Please |
144 | note that UTF-8-encoded strings do not contain any characters outside the |
166 | note that UTF-8-encoded strings do not contain any characters outside the |
145 | range C<0..255>, they are thus useful for bytewise/binary I/O. |
167 | range C<0..255>, they are thus useful for bytewise/binary I/O. In future |
|
|
168 | versions, enabling this option might enable autodetection of the UTF-16 |
|
|
169 | and UTF-32 encoding families, as described in RFC4627. |
146 | |
170 | |
147 | If C<$enable> is false, then the C<encode> method will return the JSON |
171 | If C<$enable> is false, then the C<encode> method will return the JSON |
148 | string as a (non-encoded) unicode string, while C<decode> expects thus a |
172 | string as a (non-encoded) unicode string, while C<decode> expects thus a |
149 | unicode string. Any decoding or encoding (e.g. to UTF-8 or UTF-16) needs |
173 | unicode string. Any decoding or encoding (e.g. to UTF-8 or UTF-16) needs |
150 | to be done yourself, e.g. using the Encode module. |
174 | to be done yourself, e.g. using the Encode module. |
151 | |
175 | |
|
|
176 | Example, output UTF-16BE-encoded JSON: |
|
|
177 | |
|
|
178 | use Encode; |
|
|
179 | $jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object); |
|
|
180 | |
|
|
181 | Example, decode UTF-32LE-encoded JSON: |
|
|
182 | |
|
|
183 | use Encode; |
|
|
184 | $object = JSON::XS->new->decode (decode "UTF-32LE", $jsontext); |
|
|
185 | |
152 | =item $json = $json->pretty ([$enable]) |
186 | =item $json = $json->pretty ([$enable]) |
153 | |
187 | |
154 | This enables (or disables) all of the C<indent>, C<space_before> and |
188 | This enables (or disables) all of the C<indent>, C<space_before> and |
155 | C<space_after> (and in the future possibly more) flags in one call to |
189 | C<space_after> (and in the future possibly more) flags in one call to |
156 | generate the most readable (or most compact) form possible. |
190 | generate the most readable (or most compact) form possible. |
|
|
191 | |
|
|
192 | Example, pretty-print some simple structure: |
157 | |
193 | |
158 | my $json = JSON::XS->new->pretty(1)->encode ({a => [1,2]}) |
194 | my $json = JSON::XS->new->pretty(1)->encode ({a => [1,2]}) |
159 | => |
195 | => |
160 | { |
196 | { |
161 | "a" : [ |
197 | "a" : [ |
… | |
… | |
169 | If C<$enable> is true (or missing), then the C<encode> method will use a multiline |
205 | If C<$enable> is true (or missing), then the C<encode> method will use a multiline |
170 | format as output, putting every array member or object/hash key-value pair |
206 | format as output, putting every array member or object/hash key-value pair |
171 | into its own line, identing them properly. |
207 | into its own line, identing them properly. |
172 | |
208 | |
173 | If C<$enable> is false, no newlines or indenting will be produced, and the |
209 | If C<$enable> is false, no newlines or indenting will be produced, and the |
174 | resulting JSON strings is guarenteed not to contain any C<newlines>. |
210 | resulting JSON text is guarenteed not to contain any C<newlines>. |
175 | |
211 | |
176 | This setting has no effect when decoding JSON strings. |
212 | This setting has no effect when decoding JSON texts. |
177 | |
213 | |
178 | =item $json = $json->space_before ([$enable]) |
214 | =item $json = $json->space_before ([$enable]) |
179 | |
215 | |
180 | If C<$enable> is true (or missing), then the C<encode> method will add an extra |
216 | If C<$enable> is true (or missing), then the C<encode> method will add an extra |
181 | optional space before the C<:> separating keys from values in JSON objects. |
217 | optional space before the C<:> separating keys from values in JSON objects. |
182 | |
218 | |
183 | If C<$enable> is false, then the C<encode> method will not add any extra |
219 | If C<$enable> is false, then the C<encode> method will not add any extra |
184 | space at those places. |
220 | space at those places. |
185 | |
221 | |
186 | This setting has no effect when decoding JSON strings. You will also most |
222 | This setting has no effect when decoding JSON texts. You will also |
187 | likely combine this setting with C<space_after>. |
223 | most likely combine this setting with C<space_after>. |
|
|
224 | |
|
|
225 | Example, space_before enabled, space_after and indent disabled: |
|
|
226 | |
|
|
227 | {"key" :"value"} |
188 | |
228 | |
189 | =item $json = $json->space_after ([$enable]) |
229 | =item $json = $json->space_after ([$enable]) |
190 | |
230 | |
191 | If C<$enable> is true (or missing), then the C<encode> method will add an extra |
231 | If C<$enable> is true (or missing), then the C<encode> method will add an extra |
192 | optional space after the C<:> separating keys from values in JSON objects |
232 | optional space after the C<:> separating keys from values in JSON objects |
… | |
… | |
194 | members. |
234 | members. |
195 | |
235 | |
196 | If C<$enable> is false, then the C<encode> method will not add any extra |
236 | If C<$enable> is false, then the C<encode> method will not add any extra |
197 | space at those places. |
237 | space at those places. |
198 | |
238 | |
199 | This setting has no effect when decoding JSON strings. |
239 | This setting has no effect when decoding JSON texts. |
|
|
240 | |
|
|
241 | Example, space_before and indent disabled, space_after enabled: |
|
|
242 | |
|
|
243 | {"key": "value"} |
200 | |
244 | |
201 | =item $json = $json->canonical ([$enable]) |
245 | =item $json = $json->canonical ([$enable]) |
202 | |
246 | |
203 | If C<$enable> is true (or missing), then the C<encode> method will output JSON objects |
247 | If C<$enable> is true (or missing), then the C<encode> method will output JSON objects |
204 | by sorting their keys. This is adding a comparatively high overhead. |
248 | by sorting their keys. This is adding a comparatively high overhead. |
… | |
… | |
206 | If C<$enable> is false, then the C<encode> method will output key-value |
250 | If C<$enable> is false, then the C<encode> method will output key-value |
207 | pairs in the order Perl stores them (which will likely change between runs |
251 | pairs in the order Perl stores them (which will likely change between runs |
208 | of the same script). |
252 | of the same script). |
209 | |
253 | |
210 | This option is useful if you want the same data structure to be encoded as |
254 | This option is useful if you want the same data structure to be encoded as |
211 | the same JSON string (given the same overall settings). If it is disabled, |
255 | the same JSON text (given the same overall settings). If it is disabled, |
212 | the same hash migh be encoded differently even if contains the same data, |
256 | the same hash migh be encoded differently even if contains the same data, |
213 | as key-value pairs have no inherent ordering in Perl. |
257 | as key-value pairs have no inherent ordering in Perl. |
214 | |
258 | |
215 | This setting has no effect when decoding JSON strings. |
259 | This setting has no effect when decoding JSON texts. |
216 | |
260 | |
217 | =item $json = $json->allow_nonref ([$enable]) |
261 | =item $json = $json->allow_nonref ([$enable]) |
218 | |
262 | |
219 | If C<$enable> is true (or missing), then the C<encode> method can convert a |
263 | If C<$enable> is true (or missing), then the C<encode> method can convert a |
220 | non-reference into its corresponding string, number or null JSON value, |
264 | non-reference into its corresponding string, number or null JSON value, |
221 | which is an extension to RFC4627. Likewise, C<decode> will accept those JSON |
265 | which is an extension to RFC4627. Likewise, C<decode> will accept those JSON |
222 | values instead of croaking. |
266 | values instead of croaking. |
223 | |
267 | |
224 | If C<$enable> is false, then the C<encode> method will croak if it isn't |
268 | If C<$enable> is false, then the C<encode> method will croak if it isn't |
225 | passed an arrayref or hashref, as JSON strings must either be an object |
269 | passed an arrayref or hashref, as JSON texts must either be an object |
226 | or array. Likewise, C<decode> will croak if given something that is not a |
270 | or array. Likewise, C<decode> will croak if given something that is not a |
227 | JSON object or array. |
271 | JSON object or array. |
|
|
272 | |
|
|
273 | Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>, |
|
|
274 | resulting in an invalid JSON text: |
|
|
275 | |
|
|
276 | JSON::XS->new->allow_nonref->encode ("Hello, World!") |
|
|
277 | => "Hello, World!" |
228 | |
278 | |
229 | =item $json = $json->shrink ([$enable]) |
279 | =item $json = $json->shrink ([$enable]) |
230 | |
280 | |
231 | Perl usually over-allocates memory a bit when allocating space for |
281 | Perl usually over-allocates memory a bit when allocating space for |
232 | strings. This flag optionally resizes strings generated by either |
282 | strings. This flag optionally resizes strings generated by either |
233 | C<encode> or C<decode> to their minimum size possible. This can save |
283 | C<encode> or C<decode> to their minimum size possible. This can save |
234 | memory when your JSON strings are either very very long or you have many |
284 | memory when your JSON texts are either very very long or you have many |
235 | short strings. It will also try to downgrade any strings to octet-form |
285 | short strings. It will also try to downgrade any strings to octet-form |
236 | if possible: perl stores strings internally either in an encoding called |
286 | if possible: perl stores strings internally either in an encoding called |
237 | UTF-X or in octet-form. The latter cannot store everything but uses less |
287 | UTF-X or in octet-form. The latter cannot store everything but uses less |
238 | space in general. |
288 | space in general. |
239 | |
289 | |
… | |
… | |
245 | |
295 | |
246 | In the future, this setting might control other things, such as converting |
296 | In the future, this setting might control other things, such as converting |
247 | strings that look like integers or floats into integers or floats |
297 | strings that look like integers or floats into integers or floats |
248 | internally (there is no difference on the Perl level), saving space. |
298 | internally (there is no difference on the Perl level), saving space. |
249 | |
299 | |
250 | =item $json_string = $json->encode ($perl_scalar) |
300 | =item $json_text = $json->encode ($perl_scalar) |
251 | |
301 | |
252 | Converts the given Perl data structure (a simple scalar or a reference |
302 | Converts the given Perl data structure (a simple scalar or a reference |
253 | to a hash or array) to its JSON representation. Simple scalars will be |
303 | to a hash or array) to its JSON representation. Simple scalars will be |
254 | converted into JSON string or number sequences, while references to arrays |
304 | converted into JSON string or number sequences, while references to arrays |
255 | become JSON arrays and references to hashes become JSON objects. Undefined |
305 | become JSON arrays and references to hashes become JSON objects. Undefined |
256 | Perl values (e.g. C<undef>) become JSON C<null> values. Neither C<true> |
306 | Perl values (e.g. C<undef>) become JSON C<null> values. Neither C<true> |
257 | nor C<false> values will be generated. |
307 | nor C<false> values will be generated. |
258 | |
308 | |
259 | =item $perl_scalar = $json->decode ($json_string) |
309 | =item $perl_scalar = $json->decode ($json_text) |
260 | |
310 | |
261 | The opposite of C<encode>: expects a JSON string and tries to parse it, |
311 | The opposite of C<encode>: expects a JSON text and tries to parse it, |
262 | returning the resulting simple scalar or reference. Croaks on error. |
312 | returning the resulting simple scalar or reference. Croaks on error. |
263 | |
313 | |
264 | JSON numbers and strings become simple Perl scalars. JSON arrays become |
314 | JSON numbers and strings become simple Perl scalars. JSON arrays become |
265 | Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes |
315 | Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes |
266 | C<1>, C<false> becomes C<0> and C<null> becomes C<undef>. |
316 | C<1>, C<false> becomes C<0> and C<null> becomes C<undef>. |
… | |
… | |
283 | =over 4 |
333 | =over 4 |
284 | |
334 | |
285 | =item object |
335 | =item object |
286 | |
336 | |
287 | A JSON object becomes a reference to a hash in Perl. No ordering of object |
337 | A JSON object becomes a reference to a hash in Perl. No ordering of object |
288 | keys is preserved. |
338 | keys is preserved (JSON does not preserver object key ordering itself). |
289 | |
339 | |
290 | =item array |
340 | =item array |
291 | |
341 | |
292 | A JSON array becomes a reference to an array in Perl. |
342 | A JSON array becomes a reference to an array in Perl. |
293 | |
343 | |
… | |
… | |
329 | =item hash references |
379 | =item hash references |
330 | |
380 | |
331 | Perl hash references become JSON objects. As there is no inherent ordering |
381 | Perl hash references become JSON objects. As there is no inherent ordering |
332 | in hash keys, they will usually be encoded in a pseudo-random order that |
382 | in hash keys, they will usually be encoded in a pseudo-random order that |
333 | can change between runs of the same program but stays generally the same |
383 | can change between runs of the same program but stays generally the same |
334 | within the single run of a program. JSON::XS can optionally sort the hash |
384 | within a single run of a program. JSON::XS can optionally sort the hash |
335 | keys (determined by the I<canonical> flag), so the same datastructure |
385 | keys (determined by the I<canonical> flag), so the same datastructure |
336 | will serialise to the same JSON text (given same settings and version of |
386 | will serialise to the same JSON text (given same settings and version of |
337 | JSON::XS), but this incurs a runtime overhead. |
387 | JSON::XS), but this incurs a runtime overhead. |
338 | |
388 | |
339 | =item array references |
389 | =item array references |
… | |
… | |
419 | |
469 | |
420 | Has problems handling many Perl values (e.g. regex results and other magic |
470 | Has problems handling many Perl values (e.g. regex results and other magic |
421 | values will make it croak). |
471 | values will make it croak). |
422 | |
472 | |
423 | Does not even generate valid JSON (C<{1,2}> gets converted to C<{1:2}> |
473 | Does not even generate valid JSON (C<{1,2}> gets converted to C<{1:2}> |
424 | which is not a valid JSON string. |
474 | which is not a valid JSON text. |
425 | |
475 | |
426 | Unmaintained (maintainer unresponsive for many months, bugs are not |
476 | Unmaintained (maintainer unresponsive for many months, bugs are not |
427 | getting fixed). |
477 | getting fixed). |
428 | |
478 | |
429 | =item JSON::Syck 0.21 |
479 | =item JSON::Syck 0.21 |
… | |
… | |
431 | Very buggy (often crashes). |
481 | Very buggy (often crashes). |
432 | |
482 | |
433 | Very inflexible (no human-readable format supported, format pretty much |
483 | Very inflexible (no human-readable format supported, format pretty much |
434 | undocumented. I need at least a format for easy reading by humans and a |
484 | undocumented. I need at least a format for easy reading by humans and a |
435 | single-line compact format for use in a protocol, and preferably a way to |
485 | single-line compact format for use in a protocol, and preferably a way to |
436 | generate ASCII-only JSON strings). |
486 | generate ASCII-only JSON texts). |
437 | |
487 | |
438 | Completely broken (and confusingly documented) Unicode handling (unicode |
488 | Completely broken (and confusingly documented) Unicode handling (unicode |
439 | escapes are not working properly, you need to set ImplicitUnicode to |
489 | escapes are not working properly, you need to set ImplicitUnicode to |
440 | I<different> values on en- and decoding to get symmetric behaviour). |
490 | I<different> values on en- and decoding to get symmetric behaviour). |
441 | |
491 | |
… | |
… | |
464 | |
514 | |
465 | Very inflexible. |
515 | Very inflexible. |
466 | |
516 | |
467 | No roundtripping. |
517 | No roundtripping. |
468 | |
518 | |
469 | Does not generate valid JSON (key strings are often unquoted, empty keys |
519 | Does not generate valid JSON texts (key strings are often unquoted, empty keys |
470 | result in nothing being output) |
520 | result in nothing being output) |
471 | |
521 | |
472 | Does not check input for validity. |
522 | Does not check input for validity. |
473 | |
523 | |
474 | =back |
524 | =back |
… | |
… | |
478 | It seems that JSON::XS is surprisingly fast, as shown in the following |
528 | It seems that JSON::XS is surprisingly fast, as shown in the following |
479 | tables. They have been generated with the help of the C<eg/bench> program |
529 | tables. They have been generated with the help of the C<eg/bench> program |
480 | in the JSON::XS distribution, to make it easy to compare on your own |
530 | in the JSON::XS distribution, to make it easy to compare on your own |
481 | system. |
531 | system. |
482 | |
532 | |
483 | First is a comparison between various modules using a very simple JSON |
533 | First comes a comparison between various modules using a very short JSON |
|
|
534 | string: |
|
|
535 | |
|
|
536 | {"method": "handleMessage", "params": ["user1", "we were just talking"], "id": null} |
|
|
537 | |
484 | string, showing the number of encodes/decodes per second (JSON::XS is |
538 | It shows the number of encodes/decodes per second (JSON::XS uses the |
485 | the functional interface, while JSON::XS/2 is the OO interface with |
539 | functional interface, while JSON::XS/2 uses the OO interface with |
486 | pretty-printing and hashkey sorting enabled). |
540 | pretty-printing and hashkey sorting enabled). Higher is better: |
487 | |
541 | |
488 | module | encode | decode | |
542 | module | encode | decode | |
489 | -----------|------------|------------| |
543 | -----------|------------|------------| |
490 | JSON | 14006 | 6820 | |
544 | JSON | 11488.516 | 7823.035 | |
491 | JSON::DWIW | 200937 | 120386 | |
545 | JSON::DWIW | 94708.054 | 129094.260 | |
492 | JSON::PC | 85065 | 129366 | |
546 | JSON::PC | 63884.157 | 128528.212 | |
493 | JSON::Syck | 59898 | 44232 | |
547 | JSON::Syck | 34898.677 | 42096.911 | |
494 | JSON::XS | 1171478 | 342435 | |
548 | JSON::XS | 654027.064 | 396423.669 | |
495 | JSON::XS/2 | 730760 | 328714 | |
549 | JSON::XS/2 | 371564.190 | 371725.613 | |
496 | -----------+------------+------------+ |
550 | -----------+------------+------------+ |
497 | |
551 | |
498 | That is, JSON::XS is 6 times faster than than JSON::DWIW and about 80 |
552 | That is, JSON::XS is more than six times faster than JSON::DWIW on |
|
|
553 | encoding, more than three times faster on decoding, and about thirty times |
499 | times faster than JSON, even with pretty-printing and key sorting. |
554 | faster than JSON, even with pretty-printing and key sorting. |
500 | |
555 | |
501 | Using a longer test string (roughly 8KB, generated from Yahoo! Locals |
556 | Using a longer test string (roughly 18KB, generated from Yahoo! Locals |
502 | search API (http://nanoref.com/yahooapis/mgPdGg): |
557 | search API (http://nanoref.com/yahooapis/mgPdGg): |
503 | |
558 | |
504 | module | encode | decode | |
559 | module | encode | decode | |
505 | -----------|------------|------------| |
560 | -----------|------------|------------| |
506 | JSON | 673 | 38 | |
561 | JSON | 273.023 | 44.674 | |
507 | JSON::DWIW | 5271 | 770 | |
562 | JSON::DWIW | 1089.383 | 1145.704 | |
508 | JSON::PC | 9901 | 2491 | |
563 | JSON::PC | 3097.419 | 2393.921 | |
509 | JSON::Syck | 2360 | 786 | |
564 | JSON::Syck | 514.060 | 843.053 | |
510 | JSON::XS | 37398 | 3202 | |
565 | JSON::XS | 6479.668 | 3636.364 | |
511 | JSON::XS/2 | 13765 | 3153 | |
566 | JSON::XS/2 | 3774.221 | 3599.124 | |
512 | -----------+------------+------------+ |
567 | -----------+------------+------------+ |
513 | |
568 | |
514 | Again, JSON::XS leads by far in the encoding case, while still beating |
569 | Again, JSON::XS leads by far. |
515 | every other module in the decoding case. |
|
|
516 | |
570 | |
517 | Last example is an almost 8MB large hash with many large binary values |
571 | On large strings containing lots of high unicode characters, some modules |
518 | (PNG files), resulting in a lot of escaping: |
572 | (such as JSON::PC) seem to decode faster than JSON::XS, but the result |
|
|
573 | will be broken due to missing (or wrong) unicode handling. Others refuse |
|
|
574 | to decode or encode properly, so it was impossible to prepare a fair |
|
|
575 | comparison table for that case. |
519 | |
576 | |
520 | =head1 RESOURCE LIMITS |
577 | =head1 RESOURCE LIMITS |
521 | |
578 | |
522 | JSON::XS does not impose any limits on the size of JSON texts or Perl |
579 | JSON::XS does not impose any limits on the size of JSON texts or Perl |
523 | values they represent - if your machine cna handle it, JSON::XS will |
580 | values they represent - if your machine can handle it, JSON::XS will |
524 | encode or decode it. Future versions might optionally impose structure |
581 | encode or decode it. Future versions might optionally impose structure |
525 | depth and memory use resource limits. |
582 | depth and memory use resource limits. |
526 | |
583 | |
527 | =head1 BUGS |
584 | =head1 BUGS |
528 | |
585 | |