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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.12 by root, Fri Mar 23 18:33:50 2007 UTC vs.
Revision 1.22 by root, Sun Mar 25 02:37:00 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines