… | |
… | |
64 | so, and even documents what "correct" means. |
64 | so, and even documents what "correct" means. |
65 | |
65 | |
66 | =item * round-trip integrity |
66 | =item * round-trip integrity |
67 | |
67 | |
68 | When you serialise a perl data structure using only data types supported |
68 | When you serialise a perl data structure using only data types supported |
69 | by JSON, the deserialised data structure is identical on the Perl level. |
69 | by JSON and Perl, the deserialised data structure is identical on the Perl |
70 | (e.g. the string "2.0" doesn't suddenly become "2" just because it looks |
70 | level. (e.g. the string "2.0" doesn't suddenly become "2" just because |
71 | like a number). There minor I<are> exceptions to this, read the MAPPING |
71 | it looks like a number). There I<are> minor exceptions to this, read the |
72 | section below to learn about those. |
72 | MAPPING section below to learn about those. |
73 | |
73 | |
74 | =item * strict checking of JSON correctness |
74 | =item * strict checking of JSON correctness |
75 | |
75 | |
76 | There is no guessing, no generating of illegal JSON texts by default, |
76 | There is no guessing, no generating of illegal JSON texts by default, |
77 | and only JSON is accepted as input by default (the latter is a security |
77 | and only JSON is accepted as input by default (the latter is a security |
… | |
… | |
83 | this module usually compares favourably in terms of speed, too. |
83 | this module usually compares favourably in terms of speed, too. |
84 | |
84 | |
85 | =item * simple to use |
85 | =item * simple to use |
86 | |
86 | |
87 | This module has both a simple functional interface as well as an object |
87 | This module has both a simple functional interface as well as an object |
88 | oriented interface interface. |
88 | oriented interface. |
89 | |
89 | |
90 | =item * reasonably versatile output formats |
90 | =item * reasonably versatile output formats |
91 | |
91 | |
92 | You can choose between the most compact guaranteed-single-line format |
92 | You can choose between the most compact guaranteed-single-line format |
93 | possible (nice for simple line-based protocols), a pure-ASCII format |
93 | possible (nice for simple line-based protocols), a pure-ASCII format |
… | |
… | |
101 | |
101 | |
102 | package JSON::XS; |
102 | package JSON::XS; |
103 | |
103 | |
104 | use common::sense; |
104 | use common::sense; |
105 | |
105 | |
106 | our $VERSION = '2.24'; |
106 | our $VERSION = 2.34; |
107 | our @ISA = qw(Exporter); |
107 | our @ISA = qw(Exporter); |
108 | |
108 | |
109 | our @EXPORT = qw(encode_json decode_json to_json from_json); |
109 | our @EXPORT = qw(encode_json decode_json); |
110 | |
|
|
111 | sub to_json($) { |
|
|
112 | require Carp; |
|
|
113 | Carp::croak ("JSON::XS::to_json has been renamed to encode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call"); |
|
|
114 | } |
|
|
115 | |
|
|
116 | sub from_json($) { |
|
|
117 | require Carp; |
|
|
118 | Carp::croak ("JSON::XS::from_json has been renamed to decode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call"); |
|
|
119 | } |
|
|
120 | |
110 | |
121 | use Exporter; |
111 | use Exporter; |
122 | use XSLoader; |
112 | use XSLoader; |
123 | |
113 | |
124 | =head1 FUNCTIONAL INTERFACE |
114 | =head1 FUNCTIONAL INTERFACE |
… | |
… | |
432 | If C<$enable> is true (or missing), then the C<encode> method will output JSON objects |
422 | If C<$enable> is true (or missing), then the C<encode> method will output JSON objects |
433 | by sorting their keys. This is adding a comparatively high overhead. |
423 | by sorting their keys. This is adding a comparatively high overhead. |
434 | |
424 | |
435 | If C<$enable> is false, then the C<encode> method will output key-value |
425 | If C<$enable> is false, then the C<encode> method will output key-value |
436 | pairs in the order Perl stores them (which will likely change between runs |
426 | pairs in the order Perl stores them (which will likely change between runs |
437 | of the same script). |
427 | of the same script, and can change even within the same run from 5.18 |
|
|
428 | onwards). |
438 | |
429 | |
439 | This option is useful if you want the same data structure to be encoded as |
430 | This option is useful if you want the same data structure to be encoded as |
440 | the same JSON text (given the same overall settings). If it is disabled, |
431 | the same JSON text (given the same overall settings). If it is disabled, |
441 | the same hash might be encoded differently even if contains the same data, |
432 | the same hash might be encoded differently even if contains the same data, |
442 | as key-value pairs have no inherent ordering in Perl. |
433 | as key-value pairs have no inherent ordering in Perl. |
443 | |
434 | |
444 | This setting has no effect when decoding JSON texts. |
435 | This setting has no effect when decoding JSON texts. |
|
|
436 | |
|
|
437 | This setting has currently no effect on tied hashes. |
445 | |
438 | |
446 | =item $json = $json->allow_nonref ([$enable]) |
439 | =item $json = $json->allow_nonref ([$enable]) |
447 | |
440 | |
448 | =item $enabled = $json->get_allow_nonref |
441 | =item $enabled = $json->get_allow_nonref |
449 | |
442 | |
… | |
… | |
664 | |
657 | |
665 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
658 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
666 | |
659 | |
667 | =item $json_text = $json->encode ($perl_scalar) |
660 | =item $json_text = $json->encode ($perl_scalar) |
668 | |
661 | |
669 | Converts the given Perl data structure (a simple scalar or a reference |
662 | Converts the given Perl value or data structure to its JSON |
670 | to a hash or array) to its JSON representation. Simple scalars will be |
663 | representation. Croaks on error. |
671 | converted into JSON string or number sequences, while references to arrays |
|
|
672 | become JSON arrays and references to hashes become JSON objects. Undefined |
|
|
673 | Perl values (e.g. C<undef>) become JSON C<null> values. Neither C<true> |
|
|
674 | nor C<false> values will be generated. |
|
|
675 | |
664 | |
676 | =item $perl_scalar = $json->decode ($json_text) |
665 | =item $perl_scalar = $json->decode ($json_text) |
677 | |
666 | |
678 | The opposite of C<encode>: expects a JSON text and tries to parse it, |
667 | The opposite of C<encode>: expects a JSON text and tries to parse it, |
679 | returning the resulting simple scalar or reference. Croaks on error. |
668 | returning the resulting simple scalar or reference. Croaks on error. |
680 | |
|
|
681 | JSON numbers and strings become simple Perl scalars. JSON arrays become |
|
|
682 | Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes |
|
|
683 | C<1>, C<false> becomes C<0> and C<null> becomes C<undef>. |
|
|
684 | |
669 | |
685 | =item ($perl_scalar, $characters) = $json->decode_prefix ($json_text) |
670 | =item ($perl_scalar, $characters) = $json->decode_prefix ($json_text) |
686 | |
671 | |
687 | This works like the C<decode> method, but instead of raising an exception |
672 | This works like the C<decode> method, but instead of raising an exception |
688 | when there is trailing garbage after the first JSON object, it will |
673 | when there is trailing garbage after the first JSON object, it will |
… | |
… | |
711 | calls). |
696 | calls). |
712 | |
697 | |
713 | JSON::XS will only attempt to parse the JSON text once it is sure it |
698 | JSON::XS will only attempt to parse the JSON text once it is sure it |
714 | has enough text to get a decisive result, using a very simple but |
699 | has enough text to get a decisive result, using a very simple but |
715 | truly incremental parser. This means that it sometimes won't stop as |
700 | truly incremental parser. This means that it sometimes won't stop as |
716 | early as the full parser, for example, it doesn't detect parenthese |
701 | early as the full parser, for example, it doesn't detect mismatched |
717 | mismatches. The only thing it guarantees is that it starts decoding as |
702 | parentheses. The only thing it guarantees is that it starts decoding as |
718 | soon as a syntactically valid JSON text has been seen. This means you need |
703 | soon as a syntactically valid JSON text has been seen. This means you need |
719 | to set resource limits (e.g. C<max_size>) to ensure the parser will stop |
704 | to set resource limits (e.g. C<max_size>) to ensure the parser will stop |
720 | parsing in the presence if syntax errors. |
705 | parsing in the presence if syntax errors. |
721 | |
706 | |
722 | The following methods implement this incremental parser. |
707 | The following methods implement this incremental parser. |
… | |
… | |
738 | |
723 | |
739 | If the method is called in scalar context, then it will try to extract |
724 | If the method is called in scalar context, then it will try to extract |
740 | exactly I<one> JSON object. If that is successful, it will return this |
725 | exactly I<one> JSON object. If that is successful, it will return this |
741 | object, otherwise it will return C<undef>. If there is a parse error, |
726 | object, otherwise it will return C<undef>. If there is a parse error, |
742 | this method will croak just as C<decode> would do (one can then use |
727 | this method will croak just as C<decode> would do (one can then use |
743 | C<incr_skip> to skip the errornous part). This is the most common way of |
728 | C<incr_skip> to skip the erroneous part). This is the most common way of |
744 | using the method. |
729 | using the method. |
745 | |
730 | |
746 | And finally, in list context, it will try to extract as many objects |
731 | And finally, in list context, it will try to extract as many objects |
747 | from the stream as it can find and return them, or the empty list |
732 | from the stream as it can find and return them, or the empty list |
748 | otherwise. For this to work, there must be no separators between the JSON |
733 | otherwise. For this to work, there must be no separators between the JSON |
749 | objects or arrays, instead they must be concatenated back-to-back. If |
734 | objects or arrays, instead they must be concatenated back-to-back. If |
750 | an error occurs, an exception will be raised as in the scalar context |
735 | an error occurs, an exception will be raised as in the scalar context |
751 | case. Note that in this case, any previously-parsed JSON texts will be |
736 | case. Note that in this case, any previously-parsed JSON texts will be |
752 | lost. |
737 | lost. |
753 | |
738 | |
|
|
739 | Example: Parse some JSON arrays/objects in a given string and return |
|
|
740 | them. |
|
|
741 | |
|
|
742 | my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]"); |
|
|
743 | |
754 | =item $lvalue_string = $json->incr_text |
744 | =item $lvalue_string = $json->incr_text |
755 | |
745 | |
756 | This method returns the currently stored JSON fragment as an lvalue, that |
746 | This method returns the currently stored JSON fragment as an lvalue, that |
757 | is, you can manipulate it. This I<only> works when a preceding call to |
747 | is, you can manipulate it. This I<only> works when a preceding call to |
758 | C<incr_parse> in I<scalar context> successfully returned an object. Under |
748 | C<incr_parse> in I<scalar context> successfully returned an object. Under |
… | |
… | |
772 | C<incr_parse> died, in which case the input buffer and incremental parser |
762 | C<incr_parse> died, in which case the input buffer and incremental parser |
773 | state is left unchanged, to skip the text parsed so far and to reset the |
763 | state is left unchanged, to skip the text parsed so far and to reset the |
774 | parse state. |
764 | parse state. |
775 | |
765 | |
776 | The difference to C<incr_reset> is that only text until the parse error |
766 | The difference to C<incr_reset> is that only text until the parse error |
777 | occured is removed. |
767 | occurred is removed. |
778 | |
768 | |
779 | =item $json->incr_reset |
769 | =item $json->incr_reset |
780 | |
770 | |
781 | This completely resets the incremental parser, that is, after this call, |
771 | This completely resets the incremental parser, that is, after this call, |
782 | it will be as if the parser had never parsed anything. |
772 | it will be as if the parser had never parsed anything. |
… | |
… | |
980 | If the number consists of digits only, JSON::XS will try to represent |
970 | If the number consists of digits only, JSON::XS will try to represent |
981 | it as an integer value. If that fails, it will try to represent it as |
971 | it as an integer value. If that fails, it will try to represent it as |
982 | a numeric (floating point) value if that is possible without loss of |
972 | a numeric (floating point) value if that is possible without loss of |
983 | precision. Otherwise it will preserve the number as a string value (in |
973 | precision. Otherwise it will preserve the number as a string value (in |
984 | which case you lose roundtripping ability, as the JSON number will be |
974 | which case you lose roundtripping ability, as the JSON number will be |
985 | re-encoded toa JSON string). |
975 | re-encoded to a JSON string). |
986 | |
976 | |
987 | Numbers containing a fractional or exponential part will always be |
977 | Numbers containing a fractional or exponential part will always be |
988 | represented as numeric (floating point) values, possibly at a loss of |
978 | represented as numeric (floating point) values, possibly at a loss of |
989 | precision (in which case you might lose perfect roundtripping ability, but |
979 | precision (in which case you might lose perfect roundtripping ability, but |
990 | the JSON number will still be re-encoded as a JSON number). |
980 | the JSON number will still be re-encoded as a JSON number). |
991 | |
981 | |
|
|
982 | Note that precision is not accuracy - binary floating point values cannot |
|
|
983 | represent most decimal fractions exactly, and when converting from and to |
|
|
984 | floating point, JSON::XS only guarantees precision up to but not including |
|
|
985 | the least significant bit. |
|
|
986 | |
992 | =item true, false |
987 | =item true, false |
993 | |
988 | |
994 | These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, |
989 | These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, |
995 | respectively. They are overloaded to act almost exactly like the numbers |
990 | respectively. They are overloaded to act almost exactly like the numbers |
996 | C<1> and C<0>. You can check whether a scalar is a JSON boolean by using |
991 | C<1> and C<0>. You can check whether a scalar is a JSON boolean by using |
… | |
… | |
1011 | |
1006 | |
1012 | =over 4 |
1007 | =over 4 |
1013 | |
1008 | |
1014 | =item hash references |
1009 | =item hash references |
1015 | |
1010 | |
1016 | Perl hash references become JSON objects. As there is no inherent ordering |
1011 | Perl hash references become JSON objects. As there is no inherent |
1017 | in hash keys (or JSON objects), they will usually be encoded in a |
1012 | ordering in hash keys (or JSON objects), they will usually be encoded |
1018 | pseudo-random order that can change between runs of the same program but |
1013 | in a pseudo-random order. JSON::XS can optionally sort the hash keys |
1019 | stays generally the same within a single run of a program. JSON::XS can |
1014 | (determined by the I<canonical> flag), so the same datastructure will |
1020 | optionally sort the hash keys (determined by the I<canonical> flag), so |
1015 | serialise to the same JSON text (given same settings and version of |
1021 | the same datastructure will serialise to the same JSON text (given same |
1016 | JSON::XS), but this incurs a runtime overhead and is only rarely useful, |
1022 | settings and version of JSON::XS), but this incurs a runtime overhead |
1017 | e.g. when you want to compare some JSON text against another for equality. |
1023 | and is only rarely useful, e.g. when you want to compare some JSON text |
|
|
1024 | against another for equality. |
|
|
1025 | |
1018 | |
1026 | =item array references |
1019 | =item array references |
1027 | |
1020 | |
1028 | Perl array references become JSON arrays. |
1021 | Perl array references become JSON arrays. |
1029 | |
1022 | |
… | |
… | |
1082 | $x *= 1; # same thing, the choice is yours. |
1075 | $x *= 1; # same thing, the choice is yours. |
1083 | |
1076 | |
1084 | You can not currently force the type in other, less obscure, ways. Tell me |
1077 | You can not currently force the type in other, less obscure, ways. Tell me |
1085 | if you need this capability (but don't forget to explain why it's needed |
1078 | if you need this capability (but don't forget to explain why it's needed |
1086 | :). |
1079 | :). |
|
|
1080 | |
|
|
1081 | Note that numerical precision has the same meaning as under Perl (so |
|
|
1082 | binary to decimal conversion follows the same rules as in Perl, which |
|
|
1083 | can differ to other languages). Also, your perl interpreter might expose |
|
|
1084 | extensions to the floating point numbers of your platform, such as |
|
|
1085 | infinities or NaN's - these cannot be represented in JSON, and it is an |
|
|
1086 | error to pass those in. |
1087 | |
1087 | |
1088 | =back |
1088 | =back |
1089 | |
1089 | |
1090 | |
1090 | |
1091 | =head1 ENCODING/CODESET FLAG NOTES |
1091 | =head1 ENCODING/CODESET FLAG NOTES |
… | |
… | |
1118 | =item C<utf8> flag disabled |
1118 | =item C<utf8> flag disabled |
1119 | |
1119 | |
1120 | When C<utf8> is disabled (the default), then C<encode>/C<decode> generate |
1120 | When C<utf8> is disabled (the default), then C<encode>/C<decode> generate |
1121 | and expect Unicode strings, that is, characters with high ordinal Unicode |
1121 | and expect Unicode strings, that is, characters with high ordinal Unicode |
1122 | values (> 255) will be encoded as such characters, and likewise such |
1122 | values (> 255) will be encoded as such characters, and likewise such |
1123 | characters are decoded as-is, no canges to them will be done, except |
1123 | characters are decoded as-is, no changes to them will be done, except |
1124 | "(re-)interpreting" them as Unicode codepoints or Unicode characters, |
1124 | "(re-)interpreting" them as Unicode codepoints or Unicode characters, |
1125 | respectively (to Perl, these are the same thing in strings unless you do |
1125 | respectively (to Perl, these are the same thing in strings unless you do |
1126 | funny/weird/dumb stuff). |
1126 | funny/weird/dumb stuff). |
1127 | |
1127 | |
1128 | This is useful when you want to do the encoding yourself (e.g. when you |
1128 | This is useful when you want to do the encoding yourself (e.g. when you |
… | |
… | |
1236 | well - using C<eval> naively simply I<will> cause problems. |
1236 | well - using C<eval> naively simply I<will> cause problems. |
1237 | |
1237 | |
1238 | Another problem is that some javascript implementations reserve |
1238 | Another problem is that some javascript implementations reserve |
1239 | some property names for their own purposes (which probably makes |
1239 | some property names for their own purposes (which probably makes |
1240 | them non-ECMAscript-compliant). For example, Iceweasel reserves the |
1240 | them non-ECMAscript-compliant). For example, Iceweasel reserves the |
1241 | C<__proto__> property name for it's own purposes. |
1241 | C<__proto__> property name for its own purposes. |
1242 | |
1242 | |
1243 | If that is a problem, you could parse try to filter the resulting JSON |
1243 | If that is a problem, you could parse try to filter the resulting JSON |
1244 | output for these property strings, e.g.: |
1244 | output for these property strings, e.g.: |
1245 | |
1245 | |
1246 | $json =~ s/"__proto__"\s*:/"__proto__renamed":/g; |
1246 | $json =~ s/"__proto__"\s*:/"__proto__renamed":/g; |
1247 | |
1247 | |
1248 | This works because C<__proto__> is not valid outside of strings, so every |
1248 | This works because C<__proto__> is not valid outside of strings, so every |
1249 | occurence of C<"__proto__"\s*:> must be a string used as property name. |
1249 | occurrence of C<"__proto__"\s*:> must be a string used as property name. |
1250 | |
1250 | |
1251 | If you know of other incompatibilities, please let me know. |
1251 | If you know of other incompatibilities, please let me know. |
1252 | |
1252 | |
1253 | |
1253 | |
1254 | =head2 JSON and YAML |
1254 | =head2 JSON and YAML |
… | |
… | |
1266 | my $yaml = $to_yaml->encode ($ref) . "\n"; |
1266 | my $yaml = $to_yaml->encode ($ref) . "\n"; |
1267 | |
1267 | |
1268 | This will I<usually> generate JSON texts that also parse as valid |
1268 | This will I<usually> generate JSON texts that also parse as valid |
1269 | YAML. Please note that YAML has hardcoded limits on (simple) object key |
1269 | YAML. Please note that YAML has hardcoded limits on (simple) object key |
1270 | lengths that JSON doesn't have and also has different and incompatible |
1270 | lengths that JSON doesn't have and also has different and incompatible |
1271 | unicode handling, so you should make sure that your hash keys are |
1271 | unicode character escape syntax, so you should make sure that your hash |
1272 | noticeably shorter than the 1024 "stream characters" YAML allows and that |
1272 | keys are noticeably shorter than the 1024 "stream characters" YAML allows |
1273 | you do not have characters with codepoint values outside the Unicode BMP |
1273 | and that you do not have characters with codepoint values outside the |
1274 | (basic multilingual page). YAML also does not allow C<\/> sequences in |
1274 | Unicode BMP (basic multilingual page). YAML also does not allow C<\/> |
1275 | strings (which JSON::XS does not I<currently> generate, but other JSON |
1275 | sequences in strings (which JSON::XS does not I<currently> generate, but |
1276 | generators might). |
1276 | other JSON generators might). |
1277 | |
1277 | |
1278 | There might be other incompatibilities that I am not aware of (or the YAML |
1278 | There might be other incompatibilities that I am not aware of (or the YAML |
1279 | specification has been changed yet again - it does so quite often). In |
1279 | specification has been changed yet again - it does so quite often). In |
1280 | general you should not try to generate YAML with a JSON generator or vice |
1280 | general you should not try to generate YAML with a JSON generator or vice |
1281 | versa, or try to parse JSON with a YAML parser or vice versa: chances are |
1281 | versa, or try to parse JSON with a YAML parser or vice versa: chances are |
… | |
… | |
1300 | that difficult or long) and finally make YAML compatible to it, and |
1300 | that difficult or long) and finally make YAML compatible to it, and |
1301 | educating users about the changes, instead of spreading lies about the |
1301 | educating users about the changes, instead of spreading lies about the |
1302 | real compatibility for many I<years> and trying to silence people who |
1302 | real compatibility for many I<years> and trying to silence people who |
1303 | point out that it isn't true. |
1303 | point out that it isn't true. |
1304 | |
1304 | |
|
|
1305 | Addendum/2009: the YAML 1.2 spec is still incompatible with JSON, even |
|
|
1306 | though the incompatibilities have been documented (and are known to Brian) |
|
|
1307 | for many years and the spec makes explicit claims that YAML is a superset |
|
|
1308 | of JSON. It would be so easy to fix, but apparently, bullying people and |
|
|
1309 | corrupting userdata is so much easier. |
|
|
1310 | |
1305 | =back |
1311 | =back |
1306 | |
1312 | |
1307 | |
1313 | |
1308 | =head2 SPEED |
1314 | =head2 SPEED |
1309 | |
1315 | |
… | |
… | |
1316 | a very short single-line JSON string (also available at |
1322 | a very short single-line JSON string (also available at |
1317 | L<http://dist.schmorp.de/misc/json/short.json>). |
1323 | L<http://dist.schmorp.de/misc/json/short.json>). |
1318 | |
1324 | |
1319 | {"method": "handleMessage", "params": ["user1", |
1325 | {"method": "handleMessage", "params": ["user1", |
1320 | "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7, |
1326 | "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7, |
1321 | true, false]} |
1327 | 1, 0]} |
1322 | |
1328 | |
1323 | It shows the number of encodes/decodes per second (JSON::XS uses |
1329 | It shows the number of encodes/decodes per second (JSON::XS uses |
1324 | the functional interface, while JSON::XS/2 uses the OO interface |
1330 | the functional interface, while JSON::XS/2 uses the OO interface |
1325 | with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables |
1331 | with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables |
1326 | shrink). Higher is better: |
1332 | shrink. JSON::DWIW/DS uses the deserialise function, while JSON::DWIW::FJ |
|
|
1333 | uses the from_json method). Higher is better: |
1327 | |
1334 | |
1328 | module | encode | decode | |
1335 | module | encode | decode | |
1329 | -----------|------------|------------| |
1336 | --------------|------------|------------| |
1330 | JSON 1.x | 4990.842 | 4088.813 | |
1337 | JSON::DWIW/DS | 86302.551 | 102300.098 | |
1331 | JSON::DWIW | 51653.990 | 71575.154 | |
1338 | JSON::DWIW/FJ | 86302.551 | 75983.768 | |
1332 | JSON::PC | 65948.176 | 74631.744 | |
1339 | JSON::PP | 15827.562 | 6638.658 | |
1333 | JSON::PP | 8931.652 | 3817.168 | |
1340 | JSON::Syck | 63358.066 | 47662.545 | |
1334 | JSON::Syck | 24877.248 | 27776.848 | |
1341 | JSON::XS | 511500.488 | 511500.488 | |
1335 | JSON::XS | 388361.481 | 227951.304 | |
1342 | JSON::XS/2 | 291271.111 | 388361.481 | |
1336 | JSON::XS/2 | 227951.304 | 218453.333 | |
1343 | JSON::XS/3 | 361577.931 | 361577.931 | |
1337 | JSON::XS/3 | 338250.323 | 218453.333 | |
1344 | Storable | 66788.280 | 265462.278 | |
1338 | Storable | 16500.016 | 135300.129 | |
|
|
1339 | -----------+------------+------------+ |
1345 | --------------+------------+------------+ |
1340 | |
1346 | |
1341 | That is, JSON::XS is about five times faster than JSON::DWIW on encoding, |
1347 | That is, JSON::XS is almost six times faster than JSON::DWIW on encoding, |
1342 | about three times faster on decoding, and over forty times faster |
1348 | about five times faster on decoding, and over thirty to seventy times |
1343 | than JSON, even with pretty-printing and key sorting. It also compares |
1349 | faster than JSON's pure perl implementation. It also compares favourably |
1344 | favourably to Storable for small amounts of data. |
1350 | to Storable for small amounts of data. |
1345 | |
1351 | |
1346 | Using a longer test string (roughly 18KB, generated from Yahoo! Locals |
1352 | Using a longer test string (roughly 18KB, generated from Yahoo! Locals |
1347 | search API (L<http://dist.schmorp.de/misc/json/long.json>). |
1353 | search API (L<http://dist.schmorp.de/misc/json/long.json>). |
1348 | |
1354 | |
1349 | module | encode | decode | |
1355 | module | encode | decode | |
1350 | -----------|------------|------------| |
1356 | --------------|------------|------------| |
1351 | JSON 1.x | 55.260 | 34.971 | |
1357 | JSON::DWIW/DS | 1647.927 | 2673.916 | |
1352 | JSON::DWIW | 825.228 | 1082.513 | |
1358 | JSON::DWIW/FJ | 1630.249 | 2596.128 | |
1353 | JSON::PC | 3571.444 | 2394.829 | |
|
|
1354 | JSON::PP | 210.987 | 32.574 | |
1359 | JSON::PP | 400.640 | 62.311 | |
1355 | JSON::Syck | 552.551 | 787.544 | |
1360 | JSON::Syck | 1481.040 | 1524.869 | |
1356 | JSON::XS | 5780.463 | 4854.519 | |
1361 | JSON::XS | 20661.596 | 9541.183 | |
1357 | JSON::XS/2 | 3869.998 | 4798.975 | |
1362 | JSON::XS/2 | 10683.403 | 9416.938 | |
1358 | JSON::XS/3 | 5862.880 | 4798.975 | |
1363 | JSON::XS/3 | 20661.596 | 9400.054 | |
1359 | Storable | 4445.002 | 5235.027 | |
1364 | Storable | 19765.806 | 10000.725 | |
1360 | -----------+------------+------------+ |
1365 | --------------+------------+------------+ |
1361 | |
1366 | |
1362 | Again, JSON::XS leads by far (except for Storable which non-surprisingly |
1367 | Again, JSON::XS leads by far (except for Storable which non-surprisingly |
1363 | decodes faster). |
1368 | decodes a bit faster). |
1364 | |
1369 | |
1365 | On large strings containing lots of high Unicode characters, some modules |
1370 | On large strings containing lots of high Unicode characters, some modules |
1366 | (such as JSON::PC) seem to decode faster than JSON::XS, but the result |
1371 | (such as JSON::PC) seem to decode faster than JSON::XS, but the result |
1367 | will be broken due to missing (or wrong) Unicode handling. Others refuse |
1372 | will be broken due to missing (or wrong) Unicode handling. Others refuse |
1368 | to decode or encode properly, so it was impossible to prepare a fair |
1373 | to decode or encode properly, so it was impossible to prepare a fair |
… | |
… | |
1404 | information you might want to make sure that exceptions thrown by JSON::XS |
1409 | information you might want to make sure that exceptions thrown by JSON::XS |
1405 | will not end up in front of untrusted eyes. |
1410 | will not end up in front of untrusted eyes. |
1406 | |
1411 | |
1407 | If you are using JSON::XS to return packets to consumption |
1412 | If you are using JSON::XS to return packets to consumption |
1408 | by JavaScript scripts in a browser you should have a look at |
1413 | by JavaScript scripts in a browser you should have a look at |
1409 | L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether |
1414 | L<http://blog.archive.jpsykes.com/47/practical-csrf-and-json-security/> to |
1410 | you are vulnerable to some common attack vectors (which really are browser |
1415 | see whether you are vulnerable to some common attack vectors (which really |
1411 | design bugs, but it is still you who will have to deal with it, as major |
1416 | are browser design bugs, but it is still you who will have to deal with |
1412 | browser developers care only for features, not about getting security |
1417 | it, as major browser developers care only for features, not about getting |
1413 | right). |
1418 | security right). |
1414 | |
1419 | |
1415 | |
1420 | |
1416 | =head1 THREADS |
1421 | =head1 THREADS |
1417 | |
1422 | |
1418 | This module is I<not> guaranteed to be thread safe and there are no |
1423 | This module is I<not> guaranteed to be thread safe and there are no |
1419 | plans to change this until Perl gets thread support (as opposed to the |
1424 | plans to change this until Perl gets thread support (as opposed to the |
1420 | horribly slow so-called "threads" which are simply slow and bloated |
1425 | horribly slow so-called "threads" which are simply slow and bloated |
1421 | process simulations - use fork, it's I<much> faster, cheaper, better). |
1426 | process simulations - use fork, it's I<much> faster, cheaper, better). |
1422 | |
1427 | |
1423 | (It might actually work, but you have been warned). |
1428 | (It might actually work, but you have been warned). |
|
|
1429 | |
|
|
1430 | |
|
|
1431 | =head1 THE PERILS OF SETLOCALE |
|
|
1432 | |
|
|
1433 | Sometimes people avoid the Perl locale support and directly call the |
|
|
1434 | system's setlocale function with C<LC_ALL>. |
|
|
1435 | |
|
|
1436 | This breaks both perl and modules such as JSON::XS, as stringification of |
|
|
1437 | numbers no longer works correctly (e.g. C<$x = 0.1; print "$x"+1> might |
|
|
1438 | print C<1>, and JSON::XS might output illegal JSON as JSON::XS relies on |
|
|
1439 | perl to stringify numbers). |
|
|
1440 | |
|
|
1441 | The solution is simple: don't call C<setlocale>, or use it for only those |
|
|
1442 | categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>. |
|
|
1443 | |
|
|
1444 | If you need C<LC_NUMERIC>, you should enable it only around the code that |
|
|
1445 | actually needs it (avoiding stringification of numbers), and restore it |
|
|
1446 | afterwards. |
1424 | |
1447 | |
1425 | |
1448 | |
1426 | =head1 BUGS |
1449 | =head1 BUGS |
1427 | |
1450 | |
1428 | While the goal of this module is to be correct, that unfortunately does |
1451 | While the goal of this module is to be correct, that unfortunately does |