… | |
… | |
86 | package JSON::XS; |
86 | package JSON::XS; |
87 | |
87 | |
88 | use strict; |
88 | use strict; |
89 | |
89 | |
90 | BEGIN { |
90 | BEGIN { |
91 | our $VERSION = '0.8'; |
91 | our $VERSION = '1.24'; |
92 | our @ISA = qw(Exporter); |
92 | our @ISA = qw(Exporter); |
93 | |
93 | |
94 | our @EXPORT = qw(to_json from_json objToJson jsonToObj); |
94 | our @EXPORT = qw(to_json from_json objToJson jsonToObj); |
95 | require Exporter; |
95 | require Exporter; |
96 | |
96 | |
… | |
… | |
154 | |
154 | |
155 | If C<$enable> is true (or missing), then the C<encode> method will not |
155 | If C<$enable> is true (or missing), then the C<encode> method will not |
156 | generate characters outside the code range C<0..127> (which is ASCII). Any |
156 | generate characters outside the code range C<0..127> (which is ASCII). Any |
157 | unicode characters outside that range will be escaped using either a |
157 | unicode characters outside that range will be escaped using either a |
158 | single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence, |
158 | single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence, |
159 | as per RFC4627. |
159 | as per RFC4627. The resulting encoded JSON text can be treated as a native |
|
|
160 | unicode string, an ascii-encoded, latin1-encoded or UTF-8 encoded string, |
|
|
161 | or any other superset of ASCII. |
160 | |
162 | |
161 | If C<$enable> is false, then the C<encode> method will not escape Unicode |
163 | If C<$enable> is false, then the C<encode> method will not escape Unicode |
162 | characters unless required by the JSON syntax. This results in a faster |
164 | characters unless required by the JSON syntax or other flags. This results |
163 | and more compact format. |
165 | in a faster and more compact format. |
|
|
166 | |
|
|
167 | The main use for this flag is to produce JSON texts that can be |
|
|
168 | transmitted over a 7-bit channel, as the encoded JSON texts will not |
|
|
169 | contain any 8 bit characters. |
164 | |
170 | |
165 | JSON::XS->new->ascii (1)->encode ([chr 0x10401]) |
171 | JSON::XS->new->ascii (1)->encode ([chr 0x10401]) |
166 | => ["\ud801\udc01"] |
172 | => ["\ud801\udc01"] |
|
|
173 | |
|
|
174 | =item $json = $json->latin1 ([$enable]) |
|
|
175 | |
|
|
176 | If C<$enable> is true (or missing), then the C<encode> method will encode |
|
|
177 | the resulting JSON text as latin1 (or iso-8859-1), escaping any characters |
|
|
178 | outside the code range C<0..255>. The resulting string can be treated as a |
|
|
179 | latin1-encoded JSON text or a native unicode string. The C<decode> method |
|
|
180 | will not be affected in any way by this flag, as C<decode> by default |
|
|
181 | expects unicode, which is a strict superset of latin1. |
|
|
182 | |
|
|
183 | If C<$enable> is false, then the C<encode> method will not escape Unicode |
|
|
184 | characters unless required by the JSON syntax or other flags. |
|
|
185 | |
|
|
186 | The main use for this flag is efficiently encoding binary data as JSON |
|
|
187 | text, as most octets will not be escaped, resulting in a smaller encoded |
|
|
188 | size. The disadvantage is that the resulting JSON text is encoded |
|
|
189 | in latin1 (and must correctly be treated as such when storing and |
|
|
190 | transfering), a rare encoding for JSON. It is therefore most useful when |
|
|
191 | you want to store data structures known to contain binary data efficiently |
|
|
192 | in files or databases, not when talking to other JSON encoders/decoders. |
|
|
193 | |
|
|
194 | JSON::XS->new->latin1->encode (["\x{89}\x{abc}"] |
|
|
195 | => ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not) |
167 | |
196 | |
168 | =item $json = $json->utf8 ([$enable]) |
197 | =item $json = $json->utf8 ([$enable]) |
169 | |
198 | |
170 | If C<$enable> is true (or missing), then the C<encode> method will encode |
199 | If C<$enable> is true (or missing), then the C<encode> method will encode |
171 | the JSON result into UTF-8, as required by many protocols, while the |
200 | the JSON result into UTF-8, as required by many protocols, while the |
… | |
… | |
309 | strings that look like integers or floats into integers or floats |
338 | strings that look like integers or floats into integers or floats |
310 | internally (there is no difference on the Perl level), saving space. |
339 | internally (there is no difference on the Perl level), saving space. |
311 | |
340 | |
312 | =item $json = $json->max_depth ([$maximum_nesting_depth]) |
341 | =item $json = $json->max_depth ([$maximum_nesting_depth]) |
313 | |
342 | |
314 | Sets the maximum nesting level (default C<8192>) accepted while encoding |
343 | Sets the maximum nesting level (default C<512>) accepted while encoding |
315 | or decoding. If the JSON text or Perl data structure has an equal or |
344 | or decoding. If the JSON text or Perl data structure has an equal or |
316 | higher nesting level then this limit, then the encoder and decoder will |
345 | higher nesting level then this limit, then the encoder and decoder will |
317 | stop and croak at that point. |
346 | stop and croak at that point. |
318 | |
347 | |
319 | Nesting level is defined by number of hash- or arrayrefs that the encoder |
348 | Nesting level is defined by number of hash- or arrayrefs that the encoder |
… | |
… | |
345 | |
374 | |
346 | JSON numbers and strings become simple Perl scalars. JSON arrays become |
375 | JSON numbers and strings become simple Perl scalars. JSON arrays become |
347 | Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes |
376 | Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes |
348 | C<1>, C<false> becomes C<0> and C<null> becomes C<undef>. |
377 | C<1>, C<false> becomes C<0> and C<null> becomes C<undef>. |
349 | |
378 | |
|
|
379 | =item ($perl_scalar, $characters) = $json->decode_prefix ($json_text) |
|
|
380 | |
|
|
381 | This works like the C<decode> method, but instead of raising an exception |
|
|
382 | when there is trailing garbage after the first JSON object, it will |
|
|
383 | silently stop parsing there and return the number of characters consumed |
|
|
384 | so far. |
|
|
385 | |
|
|
386 | This is useful if your JSON texts are not delimited by an outer protocol |
|
|
387 | (which is not the brightest thing to do in the first place) and you need |
|
|
388 | to know where the JSON text ends. |
|
|
389 | |
|
|
390 | JSON::XS->new->decode_prefix ("[1] the tail") |
|
|
391 | => ([], 3) |
|
|
392 | |
350 | =back |
393 | =back |
351 | |
394 | |
352 | |
395 | |
353 | =head1 MAPPING |
396 | =head1 MAPPING |
354 | |
397 | |
… | |
… | |
358 | (what you put in comes out as something equivalent). |
401 | (what you put in comes out as something equivalent). |
359 | |
402 | |
360 | For the more enlightened: note that in the following descriptions, |
403 | For the more enlightened: note that in the following descriptions, |
361 | lowercase I<perl> refers to the Perl interpreter, while uppcercase I<Perl> |
404 | lowercase I<perl> refers to the Perl interpreter, while uppcercase I<Perl> |
362 | refers to the abstract Perl language itself. |
405 | refers to the abstract Perl language itself. |
|
|
406 | |
363 | |
407 | |
364 | =head2 JSON -> PERL |
408 | =head2 JSON -> PERL |
365 | |
409 | |
366 | =over 4 |
410 | =over 4 |
367 | |
411 | |
… | |
… | |
399 | |
443 | |
400 | A JSON null atom becomes C<undef> in Perl. |
444 | A JSON null atom becomes C<undef> in Perl. |
401 | |
445 | |
402 | =back |
446 | =back |
403 | |
447 | |
|
|
448 | |
404 | =head2 PERL -> JSON |
449 | =head2 PERL -> JSON |
405 | |
450 | |
406 | The mapping from Perl to JSON is slightly more difficult, as Perl is a |
451 | The mapping from Perl to JSON is slightly more difficult, as Perl is a |
407 | truly typeless language, so we can only guess which JSON type is meant by |
452 | truly typeless language, so we can only guess which JSON type is meant by |
408 | a Perl value. |
453 | a Perl value. |
… | |
… | |
410 | =over 4 |
455 | =over 4 |
411 | |
456 | |
412 | =item hash references |
457 | =item hash references |
413 | |
458 | |
414 | Perl hash references become JSON objects. As there is no inherent ordering |
459 | Perl hash references become JSON objects. As there is no inherent ordering |
415 | in hash keys, they will usually be encoded in a pseudo-random order that |
460 | in hash keys (or JSON objects), they will usually be encoded in a |
416 | can change between runs of the same program but stays generally the same |
461 | pseudo-random order that can change between runs of the same program but |
417 | within a single run of a program. JSON::XS can optionally sort the hash |
462 | stays generally the same within a single run of a program. JSON::XS can |
418 | keys (determined by the I<canonical> flag), so the same datastructure |
463 | optionally sort the hash keys (determined by the I<canonical> flag), so |
419 | will serialise to the same JSON text (given same settings and version of |
464 | the same datastructure will serialise to the same JSON text (given same |
420 | JSON::XS), but this incurs a runtime overhead. |
465 | settings and version of JSON::XS), but this incurs a runtime overhead |
|
|
466 | and is only rarely useful, e.g. when you want to compare some JSON text |
|
|
467 | against another for equality. |
421 | |
468 | |
422 | =item array references |
469 | =item array references |
423 | |
470 | |
424 | Perl array references become JSON arrays. |
471 | Perl array references become JSON arrays. |
|
|
472 | |
|
|
473 | =item other references |
|
|
474 | |
|
|
475 | Other unblessed references are generally not allowed and will cause an |
|
|
476 | exception to be thrown, except for references to the integers C<0> and |
|
|
477 | C<1>, which get turned into C<false> and C<true> atoms in JSON. You can |
|
|
478 | also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability. |
|
|
479 | |
|
|
480 | to_json [\0,JSON::XS::true] # yields [false,true] |
425 | |
481 | |
426 | =item blessed objects |
482 | =item blessed objects |
427 | |
483 | |
428 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
484 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
429 | underlying representation (hash- or arrayref), but this behaviour might |
485 | underlying representation (hash- or arrayref), but this behaviour might |
… | |
… | |
461 | $x += 0; # numify it, ensuring it will be dumped as a number |
517 | $x += 0; # numify it, ensuring it will be dumped as a number |
462 | $x *= 1; # same thing, the choise is yours. |
518 | $x *= 1; # same thing, the choise is yours. |
463 | |
519 | |
464 | You can not currently output JSON booleans or force the type in other, |
520 | You can not currently output JSON booleans or force the type in other, |
465 | less obscure, ways. Tell me if you need this capability. |
521 | less obscure, ways. Tell me if you need this capability. |
466 | |
|
|
467 | =item circular data structures |
|
|
468 | |
|
|
469 | Those will be encoded until memory or stackspace runs out. |
|
|
470 | |
522 | |
471 | =back |
523 | =back |
472 | |
524 | |
473 | |
525 | |
474 | =head1 COMPARISON |
526 | =head1 COMPARISON |
… | |
… | |
555 | |
607 | |
556 | Does not check input for validity. |
608 | Does not check input for validity. |
557 | |
609 | |
558 | =back |
610 | =back |
559 | |
611 | |
|
|
612 | |
|
|
613 | =head2 JSON and YAML |
|
|
614 | |
|
|
615 | You often hear that JSON is a subset (or a close subset) of YAML. This is, |
|
|
616 | however, a mass hysteria and very far from the truth. In general, there is |
|
|
617 | no way to configure JSON::XS to output a data structure as valid YAML. |
|
|
618 | |
|
|
619 | If you really must use JSON::XS to generate YAML, you should use this |
|
|
620 | algorithm (subject to change in future versions): |
|
|
621 | |
|
|
622 | my $to_yaml = JSON::XS->new->utf8->space_after (1); |
|
|
623 | my $yaml = $to_yaml->encode ($ref) . "\n"; |
|
|
624 | |
|
|
625 | This will usually generate JSON texts that also parse as valid |
|
|
626 | YAML. Please note that YAML has hardcoded limits on (simple) object key |
|
|
627 | lengths that JSON doesn't have, so you should make sure that your hash |
|
|
628 | keys are noticably shorter than the 1024 characters YAML allows. |
|
|
629 | |
|
|
630 | There might be other incompatibilities that I am not aware of. In general |
|
|
631 | you should not try to generate YAML with a JSON generator or vice versa, |
|
|
632 | or try to parse JSON with a YAML parser or vice versa: chances are high |
|
|
633 | that you will run into severe interoperability problems. |
|
|
634 | |
|
|
635 | |
560 | =head2 SPEED |
636 | =head2 SPEED |
561 | |
637 | |
562 | It seems that JSON::XS is surprisingly fast, as shown in the following |
638 | It seems that JSON::XS is surprisingly fast, as shown in the following |
563 | tables. They have been generated with the help of the C<eg/bench> program |
639 | tables. They have been generated with the help of the C<eg/bench> program |
564 | in the JSON::XS distribution, to make it easy to compare on your own |
640 | in the JSON::XS distribution, to make it easy to compare on your own |
565 | system. |
641 | system. |
566 | |
642 | |
567 | First comes a comparison between various modules using a very short JSON |
643 | First comes a comparison between various modules using a very short |
568 | string: |
644 | single-line JSON string: |
569 | |
645 | |
570 | {"method": "handleMessage", "params": ["user1", "we were just talking"], "id": null} |
646 | {"method": "handleMessage", "params": ["user1", "we were just talking"], \ |
|
|
647 | "id": null, "array":[1,11,234,-5,1e5,1e7, true, false]} |
571 | |
648 | |
572 | It shows the number of encodes/decodes per second (JSON::XS uses the |
649 | It shows the number of encodes/decodes per second (JSON::XS uses |
573 | functional interface, while JSON::XS/2 uses the OO interface with |
650 | the functional interface, while JSON::XS/2 uses the OO interface |
574 | pretty-printing and hashkey sorting enabled). Higher is better: |
651 | with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables |
|
|
652 | shrink). Higher is better: |
575 | |
653 | |
576 | module | encode | decode | |
654 | module | encode | decode | |
577 | -----------|------------|------------| |
655 | -----------|------------|------------| |
578 | JSON | 11488.516 | 7823.035 | |
656 | JSON | 7645.468 | 4208.613 | |
579 | JSON::DWIW | 94708.054 | 129094.260 | |
657 | JSON::DWIW | 40721.398 | 77101.176 | |
580 | JSON::PC | 63884.157 | 128528.212 | |
658 | JSON::PC | 65948.176 | 78251.940 | |
581 | JSON::Syck | 34898.677 | 42096.911 | |
659 | JSON::Syck | 22844.793 | 26479.192 | |
582 | JSON::XS | 654027.064 | 396423.669 | |
660 | JSON::XS | 388361.481 | 199728.762 | |
583 | JSON::XS/2 | 371564.190 | 371725.613 | |
661 | JSON::XS/2 | 218453.333 | 192399.266 | |
|
|
662 | JSON::XS/3 | 338250.323 | 192399.266 | |
|
|
663 | Storable | 15779.925 | 14169.946 | |
584 | -----------+------------+------------+ |
664 | -----------+------------+------------+ |
585 | |
665 | |
586 | That is, JSON::XS is more than six times faster than JSON::DWIW on |
666 | That is, JSON::XS is about five times faster than JSON::DWIW on encoding, |
587 | encoding, more than three times faster on decoding, and about thirty times |
667 | about three times faster on decoding, and over fourty times faster |
588 | faster than JSON, even with pretty-printing and key sorting. |
668 | than JSON, even with pretty-printing and key sorting. It also compares |
|
|
669 | favourably to Storable for small amounts of data. |
589 | |
670 | |
590 | Using a longer test string (roughly 18KB, generated from Yahoo! Locals |
671 | Using a longer test string (roughly 18KB, generated from Yahoo! Locals |
591 | search API (http://nanoref.com/yahooapis/mgPdGg): |
672 | search API (http://nanoref.com/yahooapis/mgPdGg): |
592 | |
673 | |
593 | module | encode | decode | |
674 | module | encode | decode | |
594 | -----------|------------|------------| |
675 | -----------|------------|------------| |
595 | JSON | 273.023 | 44.674 | |
676 | JSON | 254.685 | 37.665 | |
596 | JSON::DWIW | 1089.383 | 1145.704 | |
677 | JSON::DWIW | 843.343 | 1049.731 | |
597 | JSON::PC | 3097.419 | 2393.921 | |
678 | JSON::PC | 3602.116 | 2307.352 | |
598 | JSON::Syck | 514.060 | 843.053 | |
679 | JSON::Syck | 505.107 | 787.899 | |
599 | JSON::XS | 6479.668 | 3636.364 | |
680 | JSON::XS | 5747.196 | 3690.220 | |
600 | JSON::XS/2 | 3774.221 | 3599.124 | |
681 | JSON::XS/2 | 3968.121 | 3676.634 | |
|
|
682 | JSON::XS/3 | 6105.246 | 3662.508 | |
|
|
683 | Storable | 4417.337 | 5285.161 | |
601 | -----------+------------+------------+ |
684 | -----------+------------+------------+ |
602 | |
685 | |
603 | Again, JSON::XS leads by far. |
686 | Again, JSON::XS leads by far (except for Storable which non-surprisingly |
|
|
687 | decodes faster). |
604 | |
688 | |
605 | On large strings containing lots of high unicode characters, some modules |
689 | On large strings containing lots of high unicode characters, some modules |
606 | (such as JSON::PC) seem to decode faster than JSON::XS, but the result |
690 | (such as JSON::PC) seem to decode faster than JSON::XS, but the result |
607 | will be broken due to missing (or wrong) unicode handling. Others refuse |
691 | will be broken due to missing (or wrong) unicode handling. Others refuse |
608 | to decode or encode properly, so it was impossible to prepare a fair |
692 | to decode or encode properly, so it was impossible to prepare a fair |
… | |
… | |
625 | usually a good indication of the size of the resources required to decode |
709 | usually a good indication of the size of the resources required to decode |
626 | it into a Perl structure. |
710 | it into a Perl structure. |
627 | |
711 | |
628 | Third, JSON::XS recurses using the C stack when decoding objects and |
712 | Third, JSON::XS recurses using the C stack when decoding objects and |
629 | arrays. The C stack is a limited resource: for instance, on my amd64 |
713 | arrays. The C stack is a limited resource: for instance, on my amd64 |
630 | machine with 8MB of stack size I can decode around 180k nested arrays |
714 | machine with 8MB of stack size I can decode around 180k nested arrays but |
631 | but only 14k nested JSON objects. If that is exceeded, the program |
715 | only 14k nested JSON objects (due to perl itself recursing deeply on croak |
|
|
716 | to free the temporary). If that is exceeded, the program crashes. to be |
632 | crashes. Thats why the default nesting limit is set to 8192. If your |
717 | conservative, the default nesting limit is set to 512. If your process |
633 | process has a smaller stack, you should adjust this setting accordingly |
718 | has a smaller stack, you should adjust this setting accordingly with the |
634 | with the C<max_depth> method. |
719 | C<max_depth> method. |
635 | |
720 | |
636 | And last but least, something else could bomb you that I forgot to think |
721 | And last but least, something else could bomb you that I forgot to think |
637 | of. In that case, you get to keep the pieces. I am alway sopen for hints, |
722 | of. In that case, you get to keep the pieces. I am always open for hints, |
638 | though... |
723 | though... |
|
|
724 | |
|
|
725 | If you are using JSON::XS to return packets to consumption |
|
|
726 | by javascript scripts in a browser you should have a look at |
|
|
727 | L<http://jpsykes.com/47/practical-csrf-and-json-security> to see wether |
|
|
728 | you are vulnerable to some common attack vectors (which really are browser |
|
|
729 | design bugs, but it is still you who will have to deal with it, as major |
|
|
730 | browser developers care only for features, not about doing security |
|
|
731 | right). |
639 | |
732 | |
640 | |
733 | |
641 | =head1 BUGS |
734 | =head1 BUGS |
642 | |
735 | |
643 | While the goal of this module is to be correct, that unfortunately does |
736 | While the goal of this module is to be correct, that unfortunately does |
… | |
… | |
645 | still relatively early in its development. If you keep reporting bugs they |
738 | still relatively early in its development. If you keep reporting bugs they |
646 | will be fixed swiftly, though. |
739 | will be fixed swiftly, though. |
647 | |
740 | |
648 | =cut |
741 | =cut |
649 | |
742 | |
|
|
743 | sub true() { \1 } |
|
|
744 | sub false() { \0 } |
|
|
745 | |
650 | 1; |
746 | 1; |
651 | |
747 | |
652 | =head1 AUTHOR |
748 | =head1 AUTHOR |
653 | |
749 | |
654 | Marc Lehmann <schmorp@schmorp.de> |
750 | Marc Lehmann <schmorp@schmorp.de> |