… | |
… | |
85 | |
85 | |
86 | package JSON::XS; |
86 | package JSON::XS; |
87 | |
87 | |
88 | use strict; |
88 | use strict; |
89 | |
89 | |
90 | BEGIN { |
|
|
91 | our $VERSION = '1.23'; |
90 | our $VERSION = '1.4'; |
92 | our @ISA = qw(Exporter); |
91 | our @ISA = qw(Exporter); |
93 | |
92 | |
94 | our @EXPORT = qw(to_json from_json objToJson jsonToObj); |
93 | our @EXPORT = qw(to_json from_json objToJson jsonToObj); |
95 | require Exporter; |
|
|
96 | |
94 | |
97 | require XSLoader; |
95 | use Exporter; |
98 | XSLoader::load JSON::XS::, $VERSION; |
96 | use XSLoader; |
99 | } |
|
|
100 | |
97 | |
101 | =head1 FUNCTIONAL INTERFACE |
98 | =head1 FUNCTIONAL INTERFACE |
102 | |
99 | |
103 | The following convinience methods are provided by this module. They are |
100 | The following convinience methods are provided by this module. They are |
104 | exported by default: |
101 | exported by default: |
… | |
… | |
126 | This function call is functionally identical to: |
123 | This function call is functionally identical to: |
127 | |
124 | |
128 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
125 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
129 | |
126 | |
130 | except being faster. |
127 | except being faster. |
|
|
128 | |
|
|
129 | =item $is_boolean = JSON::XS::is_bool $scalar |
|
|
130 | |
|
|
131 | Returns true if the passed scalar represents either JSON::XS::true or |
|
|
132 | JSON::XS::false, two constants that act like C<1> and C<0>, respectively |
|
|
133 | and are used to represent JSON C<true> and C<false> values in Perl. |
|
|
134 | |
|
|
135 | See MAPPING, below, for more information on how JSON values are mapped to |
|
|
136 | Perl. |
131 | |
137 | |
132 | =back |
138 | =back |
133 | |
139 | |
134 | |
140 | |
135 | =head1 OBJECT-ORIENTED INTERFACE |
141 | =head1 OBJECT-ORIENTED INTERFACE |
… | |
… | |
309 | Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>, |
315 | Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>, |
310 | resulting in an invalid JSON text: |
316 | resulting in an invalid JSON text: |
311 | |
317 | |
312 | JSON::XS->new->allow_nonref->encode ("Hello, World!") |
318 | JSON::XS->new->allow_nonref->encode ("Hello, World!") |
313 | => "Hello, World!" |
319 | => "Hello, World!" |
|
|
320 | |
|
|
321 | =item $json = $json->allow_blessed ([$enable]) |
|
|
322 | |
|
|
323 | If C<$enable> is true (or missing), then the C<encode> method will not |
|
|
324 | barf when it encounters a blessed reference. Instead, the value of the |
|
|
325 | B<convert_blessed> option will decide wether C<null> (C<convert_blessed> |
|
|
326 | disabled or no C<to_json> method found) or a representation of the |
|
|
327 | object (C<convert_blessed> enabled and C<to_json> method found) is being |
|
|
328 | encoded. Has no effect on C<decode>. |
|
|
329 | |
|
|
330 | If C<$enable> is false (the default), then C<encode> will throw an |
|
|
331 | exception when it encounters a blessed object. |
|
|
332 | |
|
|
333 | =item $json = $json->convert_blessed ([$enable]) |
|
|
334 | |
|
|
335 | If C<$enable> is true (or missing), then C<encode>, upon encountering a |
|
|
336 | blessed object, will check for the availability of the C<TO_JSON> method |
|
|
337 | on the object's class. If found, it will be called in scalar context |
|
|
338 | and the resulting scalar will be encoded instead of the object. If no |
|
|
339 | C<TO_JSON> method is found, the value of C<allow_blessed> will decide what |
|
|
340 | to do. |
|
|
341 | |
|
|
342 | The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON> |
|
|
343 | returns other blessed objects, those will be handled in the same |
|
|
344 | way. C<TO_JSON> must take care of not causing an endless recursion cycle |
|
|
345 | (== crash) in this case. The name of C<TO_JSON> was chosen because other |
|
|
346 | methods called by the Perl core (== not the user of the object) are |
|
|
347 | usually in upper case letters and to avoid collisions with the C<to_json> |
|
|
348 | function. |
|
|
349 | |
|
|
350 | If C<$enable> is false, then the C<allow_blessed> setting will decide what |
|
|
351 | to do when a blessed object is found. |
314 | |
352 | |
315 | =item $json = $json->shrink ([$enable]) |
353 | =item $json = $json->shrink ([$enable]) |
316 | |
354 | |
317 | Perl usually over-allocates memory a bit when allocating space for |
355 | Perl usually over-allocates memory a bit when allocating space for |
318 | strings. This flag optionally resizes strings generated by either |
356 | strings. This flag optionally resizes strings generated by either |
… | |
… | |
432 | conversion details, but an integer may take slightly less memory and might |
470 | conversion details, but an integer may take slightly less memory and might |
433 | represent more values exactly than (floating point) numbers. |
471 | represent more values exactly than (floating point) numbers. |
434 | |
472 | |
435 | =item true, false |
473 | =item true, false |
436 | |
474 | |
437 | These JSON atoms become C<0>, C<1>, respectively. Information is lost in |
475 | These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, |
438 | this process. Future versions might represent those values differently, |
476 | respectively. They are overloaded to act almost exactly like the numbers |
439 | but they will be guarenteed to act like these integers would normally in |
477 | C<1> and C<0>. You can check wether a scalar is a JSON boolean by using |
440 | Perl. |
478 | the C<JSON::XS::is_bool> function. |
441 | |
479 | |
442 | =item null |
480 | =item null |
443 | |
481 | |
444 | A JSON null atom becomes C<undef> in Perl. |
482 | A JSON null atom becomes C<undef> in Perl. |
445 | |
483 | |
… | |
… | |
477 | C<1>, which get turned into C<false> and C<true> atoms in JSON. You can |
515 | 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. |
516 | also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability. |
479 | |
517 | |
480 | to_json [\0,JSON::XS::true] # yields [false,true] |
518 | to_json [\0,JSON::XS::true] # yields [false,true] |
481 | |
519 | |
|
|
520 | =item JSON::XS::true, JSON::XS::false |
|
|
521 | |
|
|
522 | These special values become JSON true and JSON false values, |
|
|
523 | respectively. You cna alos use C<\1> and C<\0> directly if you want. |
|
|
524 | |
482 | =item blessed objects |
525 | =item blessed objects |
483 | |
526 | |
484 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
527 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
485 | underlying representation (hash- or arrayref), but this behaviour might |
528 | underlying representation (hash- or arrayref), but this behaviour might |
486 | change in future versions. |
529 | change in future versions. |
… | |
… | |
614 | |
657 | |
615 | You often hear that JSON is a subset (or a close subset) of YAML. This is, |
658 | 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 |
659 | 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. |
660 | no way to configure JSON::XS to output a data structure as valid YAML. |
618 | |
661 | |
619 | If you really must use JSON::XS to generate YAML, you should this |
662 | If you really must use JSON::XS to generate YAML, you should use this |
620 | algorithm (subject to change in future versions): |
663 | algorithm (subject to change in future versions): |
621 | |
664 | |
622 | my $to_yaml = JSON::XS->new->utf8->space_after (1); |
665 | my $to_yaml = JSON::XS->new->utf8->space_after (1); |
623 | my $yaml = $to_yaml->encode ($ref) . "\n"; |
666 | my $yaml = $to_yaml->encode ($ref) . "\n"; |
624 | |
667 | |
625 | This will usually generate JSON texts that also parse as valid |
668 | This will usually generate JSON texts that also parse as valid |
626 | YAML. Please note that YAML has hardcoded limits on object key lengths |
669 | YAML. Please note that YAML has hardcoded limits on (simple) object key |
627 | that JSON doesn't have, so you should make sure that your hash keys are |
670 | lengths that JSON doesn't have, so you should make sure that your hash |
628 | noticably shorter than 1024 characters. |
671 | keys are noticably shorter than the 1024 characters YAML allows. |
629 | |
672 | |
630 | There might be other incompatibilities that I am not aware of. In general |
673 | 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, |
674 | 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. |
675 | or try to parse JSON with a YAML parser or vice versa: chances are high |
|
|
676 | that you will run into severe interoperability problems. |
633 | |
677 | |
634 | |
678 | |
635 | =head2 SPEED |
679 | =head2 SPEED |
636 | |
680 | |
637 | It seems that JSON::XS is surprisingly fast, as shown in the following |
681 | It seems that JSON::XS is surprisingly fast, as shown in the following |
… | |
… | |
651 | shrink). Higher is better: |
695 | shrink). Higher is better: |
652 | |
696 | |
653 | module | encode | decode | |
697 | module | encode | decode | |
654 | -----------|------------|------------| |
698 | -----------|------------|------------| |
655 | JSON | 7645.468 | 4208.613 | |
699 | JSON | 7645.468 | 4208.613 | |
656 | JSON::DWIW | 68534.379 | 79437.576 | |
700 | JSON::DWIW | 40721.398 | 77101.176 | |
657 | JSON::PC | 65948.176 | 78251.940 | |
701 | JSON::PC | 65948.176 | 78251.940 | |
658 | JSON::Syck | 23379.621 | 28416.694 | |
702 | JSON::Syck | 22844.793 | 26479.192 | |
659 | JSON::XS | 388361.481 | 199728.762 | |
703 | JSON::XS | 388361.481 | 199728.762 | |
660 | JSON::XS/2 | 218453.333 | 192399.266 | |
704 | JSON::XS/2 | 218453.333 | 192399.266 | |
661 | JSON::XS/3 | 338250.323 | 192399.266 | |
705 | JSON::XS/3 | 338250.323 | 192399.266 | |
662 | Storable | 15732.573 | 28571.553 | |
706 | Storable | 15779.925 | 14169.946 | |
663 | -----------+------------+------------+ |
707 | -----------+------------+------------+ |
664 | |
708 | |
665 | That is, JSON::XS is about five times faster than JSON::DWIW on encoding, |
709 | That is, JSON::XS is about five times faster than JSON::DWIW on encoding, |
666 | about three times faster on decoding, and over fourty times faster |
710 | about three times faster on decoding, and over fourty times faster |
667 | than JSON, even with pretty-printing and key sorting. It also compares |
711 | than JSON, even with pretty-printing and key sorting. It also compares |
… | |
… | |
671 | search API (http://nanoref.com/yahooapis/mgPdGg): |
715 | search API (http://nanoref.com/yahooapis/mgPdGg): |
672 | |
716 | |
673 | module | encode | decode | |
717 | module | encode | decode | |
674 | -----------|------------|------------| |
718 | -----------|------------|------------| |
675 | JSON | 254.685 | 37.665 | |
719 | JSON | 254.685 | 37.665 | |
676 | JSON::DWIW | 1014.244 | 1087.678 | |
720 | JSON::DWIW | 843.343 | 1049.731 | |
677 | JSON::PC | 3602.116 | 2307.352 | |
721 | JSON::PC | 3602.116 | 2307.352 | |
678 | JSON::Syck | 558.035 | 776.263 | |
722 | JSON::Syck | 505.107 | 787.899 | |
679 | JSON::XS | 5747.196 | 3543.684 | |
723 | JSON::XS | 5747.196 | 3690.220 | |
680 | JSON::XS/2 | 3968.121 | 3589.170 | |
724 | JSON::XS/2 | 3968.121 | 3676.634 | |
681 | JSON::XS/3 | 6105.246 | 3561.134 | |
725 | JSON::XS/3 | 6105.246 | 3662.508 | |
682 | Storable | 4456.337 | 5320.020 | |
726 | Storable | 4417.337 | 5285.161 | |
683 | -----------+------------+------------+ |
727 | -----------+------------+------------+ |
684 | |
728 | |
685 | Again, JSON::XS leads by far. |
729 | Again, JSON::XS leads by far (except for Storable which non-surprisingly |
|
|
730 | decodes faster). |
686 | |
731 | |
687 | On large strings containing lots of high unicode characters, some modules |
732 | On large strings containing lots of high unicode characters, some modules |
688 | (such as JSON::PC) seem to decode faster than JSON::XS, but the result |
733 | (such as JSON::PC) seem to decode faster than JSON::XS, but the result |
689 | will be broken due to missing (or wrong) unicode handling. Others refuse |
734 | will be broken due to missing (or wrong) unicode handling. Others refuse |
690 | to decode or encode properly, so it was impossible to prepare a fair |
735 | to decode or encode properly, so it was impossible to prepare a fair |
… | |
… | |
718 | |
763 | |
719 | And last but least, something else could bomb you that I forgot to think |
764 | And last but least, something else could bomb you that I forgot to think |
720 | of. In that case, you get to keep the pieces. I am always open for hints, |
765 | of. In that case, you get to keep the pieces. I am always open for hints, |
721 | though... |
766 | though... |
722 | |
767 | |
|
|
768 | If you are using JSON::XS to return packets to consumption |
|
|
769 | by javascript scripts in a browser you should have a look at |
|
|
770 | L<http://jpsykes.com/47/practical-csrf-and-json-security> to see wether |
|
|
771 | you are vulnerable to some common attack vectors (which really are browser |
|
|
772 | design bugs, but it is still you who will have to deal with it, as major |
|
|
773 | browser developers care only for features, not about doing security |
|
|
774 | right). |
|
|
775 | |
723 | |
776 | |
724 | =head1 BUGS |
777 | =head1 BUGS |
725 | |
778 | |
726 | While the goal of this module is to be correct, that unfortunately does |
779 | While the goal of this module is to be correct, that unfortunately does |
727 | not mean its bug-free, only that I think its design is bug-free. It is |
780 | not mean its bug-free, only that I think its design is bug-free. It is |
728 | still relatively early in its development. If you keep reporting bugs they |
781 | still relatively early in its development. If you keep reporting bugs they |
729 | will be fixed swiftly, though. |
782 | will be fixed swiftly, though. |
730 | |
783 | |
731 | =cut |
784 | =cut |
732 | |
785 | |
|
|
786 | our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" }; |
|
|
787 | our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" }; |
|
|
788 | |
733 | sub true() { \1 } |
789 | sub true() { $true } |
734 | sub false() { \0 } |
790 | sub false() { $false } |
|
|
791 | |
|
|
792 | sub is_bool($) { |
|
|
793 | UNIVERSAL::isa $_[0], "JSON::XS::Boolean" |
|
|
794 | # or UNIVERSAL::isa $_[0], "JSON::Literal" |
|
|
795 | } |
|
|
796 | |
|
|
797 | XSLoader::load "JSON::XS", $VERSION; |
|
|
798 | |
|
|
799 | package JSON::XS::Boolean; |
|
|
800 | |
|
|
801 | use overload |
|
|
802 | "0+" => sub { ${$_[0]} }, |
|
|
803 | "++" => sub { $_[0] = ${$_[0]} + 1 }, |
|
|
804 | "--" => sub { $_[0] = ${$_[0]} - 1 }, |
|
|
805 | fallback => 1; |
735 | |
806 | |
736 | 1; |
807 | 1; |
737 | |
808 | |
738 | =head1 AUTHOR |
809 | =head1 AUTHOR |
739 | |
810 | |