1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
|
|
3 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
|
|
4 | |
3 | =encoding utf-8 |
5 | =encoding utf-8 |
4 | |
|
|
5 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
|
|
6 | |
6 | |
7 | JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ |
7 | JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ |
8 | (http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html) |
8 | (http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html) |
9 | |
9 | |
10 | =head1 SYNOPSIS |
10 | =head1 SYNOPSIS |
… | |
… | |
37 | primary goal is to be I<correct> and its secondary goal is to be |
37 | primary goal is to be I<correct> and its secondary goal is to be |
38 | I<fast>. To reach the latter goal it was written in C. |
38 | I<fast>. To reach the latter goal it was written in C. |
39 | |
39 | |
40 | Beginning with version 2.0 of the JSON module, when both JSON and |
40 | Beginning with version 2.0 of the JSON module, when both JSON and |
41 | JSON::XS are installed, then JSON will fall back on JSON::XS (this can be |
41 | JSON::XS are installed, then JSON will fall back on JSON::XS (this can be |
42 | overriden) with no overhead due to emulation (by inheritign constructor |
42 | overridden) with no overhead due to emulation (by inheriting constructor |
43 | and methods). If JSON::XS is not available, it will fall back to the |
43 | and methods). If JSON::XS is not available, it will fall back to the |
44 | compatible JSON::PP module as backend, so using JSON instead of JSON::XS |
44 | compatible JSON::PP module as backend, so using JSON instead of JSON::XS |
45 | gives you a portable JSON API that can be fast when you need and doesn't |
45 | gives you a portable JSON API that can be fast when you need and doesn't |
46 | require a C compiler when that is a problem. |
46 | require a C compiler when that is a problem. |
47 | |
47 | |
… | |
… | |
49 | to write yet another JSON module? While it seems there are many JSON |
49 | to write yet another JSON module? While it seems there are many JSON |
50 | modules, none of them correctly handle all corner cases, and in most cases |
50 | modules, none of them correctly handle all corner cases, and in most cases |
51 | their maintainers are unresponsive, gone missing, or not listening to bug |
51 | their maintainers are unresponsive, gone missing, or not listening to bug |
52 | reports for other reasons. |
52 | reports for other reasons. |
53 | |
53 | |
54 | See COMPARISON, below, for a comparison to some other JSON modules. |
|
|
55 | |
|
|
56 | See MAPPING, below, on how JSON::XS maps perl values to JSON values and |
54 | See MAPPING, below, on how JSON::XS maps perl values to JSON values and |
57 | vice versa. |
55 | vice versa. |
58 | |
56 | |
59 | =head2 FEATURES |
57 | =head2 FEATURES |
60 | |
58 | |
… | |
… | |
65 | This module knows how to handle Unicode, documents how and when it does |
63 | This module knows how to handle Unicode, documents how and when it does |
66 | so, and even documents what "correct" means. |
64 | so, and even documents what "correct" means. |
67 | |
65 | |
68 | =item * round-trip integrity |
66 | =item * round-trip integrity |
69 | |
67 | |
70 | When you serialise a perl data structure using only datatypes supported |
68 | When you serialise a perl data structure using only data types supported |
71 | by JSON, the deserialised data structure is identical on the Perl level. |
69 | by JSON, the deserialised data structure is identical on the Perl level. |
72 | (e.g. the string "2.0" doesn't suddenly become "2" just because it looks |
70 | (e.g. the string "2.0" doesn't suddenly become "2" just because it looks |
73 | like a number). There minor I<are> exceptions to this, read the MAPPING |
71 | like a number). There minor I<are> exceptions to this, read the MAPPING |
74 | section below to learn about those. |
72 | section below to learn about those. |
75 | |
73 | |
… | |
… | |
84 | Compared to other JSON modules and other serialisers such as Storable, |
82 | Compared to other JSON modules and other serialisers such as Storable, |
85 | this module usually compares favourably in terms of speed, too. |
83 | this module usually compares favourably in terms of speed, too. |
86 | |
84 | |
87 | =item * simple to use |
85 | =item * simple to use |
88 | |
86 | |
89 | This module has both a simple functional interface as well as an objetc |
87 | This module has both a simple functional interface as well as an object |
90 | oriented interface interface. |
88 | oriented interface interface. |
91 | |
89 | |
92 | =item * reasonably versatile output formats |
90 | =item * reasonably versatile output formats |
93 | |
91 | |
94 | You can choose between the most compact guaranteed-single-line format |
92 | You can choose between the most compact guaranteed-single-line format |
95 | possible (nice for simple line-based protocols), a pure-ascii format |
93 | possible (nice for simple line-based protocols), a pure-ASCII format |
96 | (for when your transport is not 8-bit clean, still supports the whole |
94 | (for when your transport is not 8-bit clean, still supports the whole |
97 | Unicode range), or a pretty-printed format (for when you want to read that |
95 | Unicode range), or a pretty-printed format (for when you want to read that |
98 | stuff). Or you can combine those features in whatever way you like. |
96 | stuff). Or you can combine those features in whatever way you like. |
99 | |
97 | |
100 | =back |
98 | =back |
101 | |
99 | |
102 | =cut |
100 | =cut |
103 | |
101 | |
104 | package JSON::XS; |
102 | package JSON::XS; |
105 | |
103 | |
106 | use strict; |
104 | use common::sense; |
107 | |
105 | |
108 | our $VERSION = '2.2'; |
106 | our $VERSION = '2.27'; |
109 | our @ISA = qw(Exporter); |
107 | our @ISA = qw(Exporter); |
110 | |
108 | |
111 | our @EXPORT = qw(encode_json decode_json to_json from_json); |
109 | our @EXPORT = qw(encode_json decode_json to_json from_json); |
112 | |
110 | |
113 | sub to_json($) { |
111 | sub to_json($) { |
… | |
… | |
137 | |
135 | |
138 | This function call is functionally identical to: |
136 | This function call is functionally identical to: |
139 | |
137 | |
140 | $json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
138 | $json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
141 | |
139 | |
142 | except being faster. |
140 | Except being faster. |
143 | |
141 | |
144 | =item $perl_scalar = decode_json $json_text |
142 | =item $perl_scalar = decode_json $json_text |
145 | |
143 | |
146 | The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries |
144 | The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries |
147 | to parse that as an UTF-8 encoded JSON text, returning the resulting |
145 | to parse that as an UTF-8 encoded JSON text, returning the resulting |
… | |
… | |
149 | |
147 | |
150 | This function call is functionally identical to: |
148 | This function call is functionally identical to: |
151 | |
149 | |
152 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
150 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
153 | |
151 | |
154 | except being faster. |
152 | Except being faster. |
155 | |
153 | |
156 | =item $is_boolean = JSON::XS::is_bool $scalar |
154 | =item $is_boolean = JSON::XS::is_bool $scalar |
157 | |
155 | |
158 | Returns true if the passed scalar represents either JSON::XS::true or |
156 | Returns true if the passed scalar represents either JSON::XS::true or |
159 | JSON::XS::false, two constants that act like C<1> and C<0>, respectively |
157 | JSON::XS::false, two constants that act like C<1> and C<0>, respectively |
… | |
… | |
197 | |
195 | |
198 | If you didn't know about that flag, just the better, pretend it doesn't |
196 | If you didn't know about that flag, just the better, pretend it doesn't |
199 | exist. |
197 | exist. |
200 | |
198 | |
201 | =item 4. A "Unicode String" is simply a string where each character can be |
199 | =item 4. A "Unicode String" is simply a string where each character can be |
202 | validly interpreted as a Unicode codepoint. |
200 | validly interpreted as a Unicode code point. |
203 | |
201 | |
204 | If you have UTF-8 encoded data, it is no longer a Unicode string, but a |
202 | If you have UTF-8 encoded data, it is no longer a Unicode string, but a |
205 | Unicode string encoded in UTF-8, giving you a binary string. |
203 | Unicode string encoded in UTF-8, giving you a binary string. |
206 | |
204 | |
207 | =item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string. |
205 | =item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string. |
… | |
… | |
442 | the same JSON text (given the same overall settings). If it is disabled, |
440 | the same JSON text (given the same overall settings). If it is disabled, |
443 | the same hash might be encoded differently even if contains the same data, |
441 | the same hash might be encoded differently even if contains the same data, |
444 | as key-value pairs have no inherent ordering in Perl. |
442 | as key-value pairs have no inherent ordering in Perl. |
445 | |
443 | |
446 | This setting has no effect when decoding JSON texts. |
444 | This setting has no effect when decoding JSON texts. |
|
|
445 | |
|
|
446 | This setting has currently no effect on tied hashes. |
447 | |
447 | |
448 | =item $json = $json->allow_nonref ([$enable]) |
448 | =item $json = $json->allow_nonref ([$enable]) |
449 | |
449 | |
450 | =item $enabled = $json->get_allow_nonref |
450 | =item $enabled = $json->get_allow_nonref |
451 | |
451 | |
… | |
… | |
628 | =item $json = $json->max_depth ([$maximum_nesting_depth]) |
628 | =item $json = $json->max_depth ([$maximum_nesting_depth]) |
629 | |
629 | |
630 | =item $max_depth = $json->get_max_depth |
630 | =item $max_depth = $json->get_max_depth |
631 | |
631 | |
632 | Sets the maximum nesting level (default C<512>) accepted while encoding |
632 | Sets the maximum nesting level (default C<512>) accepted while encoding |
633 | or decoding. If the JSON text or Perl data structure has an equal or |
633 | or decoding. If a higher nesting level is detected in JSON text or a Perl |
634 | higher nesting level then this limit, then the encoder and decoder will |
634 | data structure, then the encoder and decoder will stop and croak at that |
635 | stop and croak at that point. |
635 | point. |
636 | |
636 | |
637 | Nesting level is defined by number of hash- or arrayrefs that the encoder |
637 | Nesting level is defined by number of hash- or arrayrefs that the encoder |
638 | needs to traverse to reach a given point or the number of C<{> or C<[> |
638 | needs to traverse to reach a given point or the number of C<{> or C<[> |
639 | characters without their matching closing parenthesis crossed to reach a |
639 | characters without their matching closing parenthesis crossed to reach a |
640 | given character in a string. |
640 | given character in a string. |
641 | |
641 | |
642 | Setting the maximum depth to one disallows any nesting, so that ensures |
642 | Setting the maximum depth to one disallows any nesting, so that ensures |
643 | that the object is only a single hash/object or array. |
643 | that the object is only a single hash/object or array. |
644 | |
644 | |
645 | The argument to C<max_depth> will be rounded up to the next highest power |
|
|
646 | of two. If no argument is given, the highest possible setting will be |
645 | If no argument is given, the highest possible setting will be used, which |
647 | used, which is rarely useful. |
646 | is rarely useful. |
|
|
647 | |
|
|
648 | Note that nesting is implemented by recursion in C. The default value has |
|
|
649 | been chosen to be as large as typical operating systems allow without |
|
|
650 | crashing. |
648 | |
651 | |
649 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
652 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
650 | |
653 | |
651 | =item $json = $json->max_size ([$maximum_string_size]) |
654 | =item $json = $json->max_size ([$maximum_string_size]) |
652 | |
655 | |
653 | =item $max_size = $json->get_max_size |
656 | =item $max_size = $json->get_max_size |
654 | |
657 | |
655 | Set the maximum length a JSON text may have (in bytes) where decoding is |
658 | Set the maximum length a JSON text may have (in bytes) where decoding is |
656 | being attempted. The default is C<0>, meaning no limit. When C<decode> |
659 | being attempted. The default is C<0>, meaning no limit. When C<decode> |
657 | is called on a string longer then this number of characters it will not |
660 | is called on a string that is longer then this many bytes, it will not |
658 | attempt to decode the string but throw an exception. This setting has no |
661 | attempt to decode the string but throw an exception. This setting has no |
659 | effect on C<encode> (yet). |
662 | effect on C<encode> (yet). |
660 | |
663 | |
661 | The argument to C<max_size> will be rounded up to the next B<highest> |
664 | If no argument is given, the limit check will be deactivated (same as when |
662 | power of two (so may be more than requested). If no argument is given, the |
665 | C<0> is specified). |
663 | limit check will be deactivated (same as when C<0> is specified). |
|
|
664 | |
666 | |
665 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
667 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
666 | |
668 | |
667 | =item $json_text = $json->encode ($perl_scalar) |
669 | =item $json_text = $json->encode ($perl_scalar) |
668 | |
670 | |
… | |
… | |
699 | =back |
701 | =back |
700 | |
702 | |
701 | |
703 | |
702 | =head1 INCREMENTAL PARSING |
704 | =head1 INCREMENTAL PARSING |
703 | |
705 | |
704 | [This section and the API it details is still EXPERIMENTAL] |
|
|
705 | |
|
|
706 | In some cases, there is the need for incremental parsing of JSON |
706 | In some cases, there is the need for incremental parsing of JSON |
707 | texts. While this module always has to keep both JSON text and resulting |
707 | texts. While this module always has to keep both JSON text and resulting |
708 | Perl data structure in memory at one time, it does allow you to parse a |
708 | Perl data structure in memory at one time, it does allow you to parse a |
709 | JSON stream incrementally. It does so by accumulating text until it has |
709 | JSON stream incrementally. It does so by accumulating text until it has |
710 | a full JSON object, which it then can decode. This process is similar to |
710 | a full JSON object, which it then can decode. This process is similar to |
711 | using C<decode_prefix> to see if a full JSON object is available, but is |
711 | using C<decode_prefix> to see if a full JSON object is available, but |
712 | much more efficient (JSON::XS will only attempt to parse the JSON text |
712 | is much more efficient (and can be implemented with a minimum of method |
|
|
713 | calls). |
|
|
714 | |
|
|
715 | JSON::XS will only attempt to parse the JSON text once it is sure it |
713 | once it is sure it has enough text to get a decisive result, using a very |
716 | has enough text to get a decisive result, using a very simple but |
714 | simple but truly incremental parser). |
717 | truly incremental parser. This means that it sometimes won't stop as |
|
|
718 | early as the full parser, for example, it doesn't detect parenthese |
|
|
719 | mismatches. The only thing it guarantees is that it starts decoding as |
|
|
720 | soon as a syntactically valid JSON text has been seen. This means you need |
|
|
721 | to set resource limits (e.g. C<max_size>) to ensure the parser will stop |
|
|
722 | parsing in the presence if syntax errors. |
715 | |
723 | |
716 | The following two methods deal with this. |
724 | The following methods implement this incremental parser. |
717 | |
725 | |
718 | =over 4 |
726 | =over 4 |
719 | |
727 | |
720 | =item [void, scalar or list context] = $json->incr_parse ([$string]) |
728 | =item [void, scalar or list context] = $json->incr_parse ([$string]) |
721 | |
729 | |
… | |
… | |
759 | JSON object or b) parsing multiple JSON objects separated by non-JSON text |
767 | JSON object or b) parsing multiple JSON objects separated by non-JSON text |
760 | (such as commas). |
768 | (such as commas). |
761 | |
769 | |
762 | =item $json->incr_skip |
770 | =item $json->incr_skip |
763 | |
771 | |
764 | This will reset the state of the incremental parser and will remove the |
772 | This will reset the state of the incremental parser and will remove |
765 | parsed text from the input buffer. This is useful after C<incr_parse> |
773 | the parsed text from the input buffer so far. This is useful after |
766 | died, in which case the input buffer and incremental parser state is left |
774 | C<incr_parse> died, in which case the input buffer and incremental parser |
767 | unchanged, to skip the text parsed so far and to reset the parse state. |
775 | state is left unchanged, to skip the text parsed so far and to reset the |
|
|
776 | parse state. |
|
|
777 | |
|
|
778 | The difference to C<incr_reset> is that only text until the parse error |
|
|
779 | occured is removed. |
|
|
780 | |
|
|
781 | =item $json->incr_reset |
|
|
782 | |
|
|
783 | This completely resets the incremental parser, that is, after this call, |
|
|
784 | it will be as if the parser had never parsed anything. |
|
|
785 | |
|
|
786 | This is useful if you want to repeatedly parse JSON objects and want to |
|
|
787 | ignore any trailing data, which means you have to reset the parser after |
|
|
788 | each successful decode. |
768 | |
789 | |
769 | =back |
790 | =back |
770 | |
791 | |
771 | =head2 LIMITATIONS |
792 | =head2 LIMITATIONS |
772 | |
793 | |
… | |
… | |
1013 | Other unblessed references are generally not allowed and will cause an |
1034 | Other unblessed references are generally not allowed and will cause an |
1014 | exception to be thrown, except for references to the integers C<0> and |
1035 | exception to be thrown, except for references to the integers C<0> and |
1015 | C<1>, which get turned into C<false> and C<true> atoms in JSON. You can |
1036 | C<1>, which get turned into C<false> and C<true> atoms in JSON. You can |
1016 | also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability. |
1037 | also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability. |
1017 | |
1038 | |
1018 | encode_json [\0,JSON::XS::true] # yields [false,true] |
1039 | encode_json [\0, JSON::XS::true] # yields [false,true] |
1019 | |
1040 | |
1020 | =item JSON::XS::true, JSON::XS::false |
1041 | =item JSON::XS::true, JSON::XS::false |
1021 | |
1042 | |
1022 | These special values become JSON true and JSON false values, |
1043 | These special values become JSON true and JSON false values, |
1023 | respectively. You can also use C<\1> and C<\0> directly if you want. |
1044 | respectively. You can also use C<\1> and C<\0> directly if you want. |
… | |
… | |
1165 | proper subset of most 8-bit and multibyte encodings in use in the world. |
1186 | proper subset of most 8-bit and multibyte encodings in use in the world. |
1166 | |
1187 | |
1167 | =back |
1188 | =back |
1168 | |
1189 | |
1169 | |
1190 | |
|
|
1191 | =head2 JSON and ECMAscript |
|
|
1192 | |
|
|
1193 | JSON syntax is based on how literals are represented in javascript (the |
|
|
1194 | not-standardised predecessor of ECMAscript) which is presumably why it is |
|
|
1195 | called "JavaScript Object Notation". |
|
|
1196 | |
|
|
1197 | However, JSON is not a subset (and also not a superset of course) of |
|
|
1198 | ECMAscript (the standard) or javascript (whatever browsers actually |
|
|
1199 | implement). |
|
|
1200 | |
|
|
1201 | If you want to use javascript's C<eval> function to "parse" JSON, you |
|
|
1202 | might run into parse errors for valid JSON texts, or the resulting data |
|
|
1203 | structure might not be queryable: |
|
|
1204 | |
|
|
1205 | One of the problems is that U+2028 and U+2029 are valid characters inside |
|
|
1206 | JSON strings, but are not allowed in ECMAscript string literals, so the |
|
|
1207 | following Perl fragment will not output something that can be guaranteed |
|
|
1208 | to be parsable by javascript's C<eval>: |
|
|
1209 | |
|
|
1210 | use JSON::XS; |
|
|
1211 | |
|
|
1212 | print encode_json [chr 0x2028]; |
|
|
1213 | |
|
|
1214 | The right fix for this is to use a proper JSON parser in your javascript |
|
|
1215 | programs, and not rely on C<eval> (see for example Douglas Crockford's |
|
|
1216 | F<json2.js> parser). |
|
|
1217 | |
|
|
1218 | If this is not an option, you can, as a stop-gap measure, simply encode to |
|
|
1219 | ASCII-only JSON: |
|
|
1220 | |
|
|
1221 | use JSON::XS; |
|
|
1222 | |
|
|
1223 | print JSON::XS->new->ascii->encode ([chr 0x2028]); |
|
|
1224 | |
|
|
1225 | Note that this will enlarge the resulting JSON text quite a bit if you |
|
|
1226 | have many non-ASCII characters. You might be tempted to run some regexes |
|
|
1227 | to only escape U+2028 and U+2029, e.g.: |
|
|
1228 | |
|
|
1229 | # DO NOT USE THIS! |
|
|
1230 | my $json = JSON::XS->new->utf8->encode ([chr 0x2028]); |
|
|
1231 | $json =~ s/\xe2\x80\xa8/\\u2028/g; # escape U+2028 |
|
|
1232 | $json =~ s/\xe2\x80\xa9/\\u2029/g; # escape U+2029 |
|
|
1233 | print $json; |
|
|
1234 | |
|
|
1235 | Note that I<this is a bad idea>: the above only works for U+2028 and |
|
|
1236 | U+2029 and thus only for fully ECMAscript-compliant parsers. Many existing |
|
|
1237 | javascript implementations, however, have issues with other characters as |
|
|
1238 | well - using C<eval> naively simply I<will> cause problems. |
|
|
1239 | |
|
|
1240 | Another problem is that some javascript implementations reserve |
|
|
1241 | some property names for their own purposes (which probably makes |
|
|
1242 | them non-ECMAscript-compliant). For example, Iceweasel reserves the |
|
|
1243 | C<__proto__> property name for it's own purposes. |
|
|
1244 | |
|
|
1245 | If that is a problem, you could parse try to filter the resulting JSON |
|
|
1246 | output for these property strings, e.g.: |
|
|
1247 | |
|
|
1248 | $json =~ s/"__proto__"\s*:/"__proto__renamed":/g; |
|
|
1249 | |
|
|
1250 | This works because C<__proto__> is not valid outside of strings, so every |
|
|
1251 | occurence of C<"__proto__"\s*:> must be a string used as property name. |
|
|
1252 | |
|
|
1253 | If you know of other incompatibilities, please let me know. |
|
|
1254 | |
|
|
1255 | |
1170 | =head2 JSON and YAML |
1256 | =head2 JSON and YAML |
1171 | |
1257 | |
1172 | You often hear that JSON is a subset of YAML. This is, however, a mass |
1258 | You often hear that JSON is a subset of YAML. This is, however, a mass |
1173 | hysteria(*) and very far from the truth (as of the time of this writing), |
1259 | hysteria(*) and very far from the truth (as of the time of this writing), |
1174 | so let me state it clearly: I<in general, there is no way to configure |
1260 | so let me state it clearly: I<in general, there is no way to configure |
… | |
… | |
1182 | my $yaml = $to_yaml->encode ($ref) . "\n"; |
1268 | my $yaml = $to_yaml->encode ($ref) . "\n"; |
1183 | |
1269 | |
1184 | This will I<usually> generate JSON texts that also parse as valid |
1270 | This will I<usually> generate JSON texts that also parse as valid |
1185 | YAML. Please note that YAML has hardcoded limits on (simple) object key |
1271 | YAML. Please note that YAML has hardcoded limits on (simple) object key |
1186 | lengths that JSON doesn't have and also has different and incompatible |
1272 | lengths that JSON doesn't have and also has different and incompatible |
1187 | unicode handling, so you should make sure that your hash keys are |
1273 | unicode character escape syntax, so you should make sure that your hash |
1188 | noticeably shorter than the 1024 "stream characters" YAML allows and that |
1274 | keys are noticeably shorter than the 1024 "stream characters" YAML allows |
1189 | you do not have characters with codepoint values outside the Unicode BMP |
1275 | and that you do not have characters with codepoint values outside the |
1190 | (basic multilingual page). YAML also does not allow C<\/> sequences in |
1276 | Unicode BMP (basic multilingual page). YAML also does not allow C<\/> |
1191 | strings (which JSON::XS does not I<currently> generate, but other JSON |
1277 | sequences in strings (which JSON::XS does not I<currently> generate, but |
1192 | generators might). |
1278 | other JSON generators might). |
1193 | |
1279 | |
1194 | There might be other incompatibilities that I am not aware of (or the YAML |
1280 | There might be other incompatibilities that I am not aware of (or the YAML |
1195 | specification has been changed yet again - it does so quite often). In |
1281 | specification has been changed yet again - it does so quite often). In |
1196 | general you should not try to generate YAML with a JSON generator or vice |
1282 | general you should not try to generate YAML with a JSON generator or vice |
1197 | versa, or try to parse JSON with a YAML parser or vice versa: chances are |
1283 | versa, or try to parse JSON with a YAML parser or vice versa: chances are |
… | |
… | |
1216 | that difficult or long) and finally make YAML compatible to it, and |
1302 | that difficult or long) and finally make YAML compatible to it, and |
1217 | educating users about the changes, instead of spreading lies about the |
1303 | educating users about the changes, instead of spreading lies about the |
1218 | real compatibility for many I<years> and trying to silence people who |
1304 | real compatibility for many I<years> and trying to silence people who |
1219 | point out that it isn't true. |
1305 | point out that it isn't true. |
1220 | |
1306 | |
|
|
1307 | Addendum/2009: the YAML 1.2 spec is still incomaptible with JSON, even |
|
|
1308 | though the incompatibilities have been documented (and are known to |
|
|
1309 | Brian) for many years and the spec makes explicit claims that YAML is a |
|
|
1310 | superset of JSON. It would be so easy to fix, but apparently, bullying and |
|
|
1311 | corrupting userdata is so much easier. |
|
|
1312 | |
1221 | =back |
1313 | =back |
1222 | |
1314 | |
1223 | |
1315 | |
1224 | =head2 SPEED |
1316 | =head2 SPEED |
1225 | |
1317 | |
… | |
… | |
1230 | |
1322 | |
1231 | First comes a comparison between various modules using |
1323 | First comes a comparison between various modules using |
1232 | a very short single-line JSON string (also available at |
1324 | a very short single-line JSON string (also available at |
1233 | L<http://dist.schmorp.de/misc/json/short.json>). |
1325 | L<http://dist.schmorp.de/misc/json/short.json>). |
1234 | |
1326 | |
1235 | {"method": "handleMessage", "params": ["user1", "we were just talking"], \ |
1327 | {"method": "handleMessage", "params": ["user1", |
1236 | "id": null, "array":[1,11,234,-5,1e5,1e7, true, false]} |
1328 | "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7, |
|
|
1329 | true, false]} |
1237 | |
1330 | |
1238 | It shows the number of encodes/decodes per second (JSON::XS uses |
1331 | It shows the number of encodes/decodes per second (JSON::XS uses |
1239 | the functional interface, while JSON::XS/2 uses the OO interface |
1332 | the functional interface, while JSON::XS/2 uses the OO interface |
1240 | with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables |
1333 | with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables |
1241 | shrink). Higher is better: |
1334 | shrink). Higher is better: |
… | |
… | |
1319 | information you might want to make sure that exceptions thrown by JSON::XS |
1412 | information you might want to make sure that exceptions thrown by JSON::XS |
1320 | will not end up in front of untrusted eyes. |
1413 | will not end up in front of untrusted eyes. |
1321 | |
1414 | |
1322 | If you are using JSON::XS to return packets to consumption |
1415 | If you are using JSON::XS to return packets to consumption |
1323 | by JavaScript scripts in a browser you should have a look at |
1416 | by JavaScript scripts in a browser you should have a look at |
1324 | L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether |
1417 | L<http://blog.archive.jpsykes.com/47/practical-csrf-and-json-security/> to |
1325 | you are vulnerable to some common attack vectors (which really are browser |
1418 | see whether you are vulnerable to some common attack vectors (which really |
1326 | design bugs, but it is still you who will have to deal with it, as major |
1419 | are browser design bugs, but it is still you who will have to deal with |
1327 | browser developers care only for features, not about getting security |
1420 | it, as major browser developers care only for features, not about getting |
1328 | right). |
1421 | security right). |
1329 | |
1422 | |
1330 | |
1423 | |
1331 | =head1 THREADS |
1424 | =head1 THREADS |
1332 | |
1425 | |
1333 | This module is I<not> guaranteed to be thread safe and there are no |
1426 | This module is I<not> guaranteed to be thread safe and there are no |
… | |
… | |
1339 | |
1432 | |
1340 | |
1433 | |
1341 | =head1 BUGS |
1434 | =head1 BUGS |
1342 | |
1435 | |
1343 | While the goal of this module is to be correct, that unfortunately does |
1436 | While the goal of this module is to be correct, that unfortunately does |
1344 | not mean it's bug-free, only that I think its design is bug-free. It is |
1437 | not mean it's bug-free, only that I think its design is bug-free. If you |
1345 | still relatively early in its development. If you keep reporting bugs they |
1438 | keep reporting bugs they will be fixed swiftly, though. |
1346 | will be fixed swiftly, though. |
|
|
1347 | |
1439 | |
1348 | Please refrain from using rt.cpan.org or any other bug reporting |
1440 | Please refrain from using rt.cpan.org or any other bug reporting |
1349 | service. I put the contact address into my modules for a reason. |
1441 | service. I put the contact address into my modules for a reason. |
1350 | |
1442 | |
1351 | =cut |
1443 | =cut |