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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.123 by root, Sat Aug 8 10:06:02 2009 UTC vs.
Revision 1.129 by root, Tue Jan 19 01:02:19 2010 UTC

101 101
102package JSON::XS; 102package JSON::XS;
103 103
104use common::sense; 104use common::sense;
105 105
106our $VERSION = '2.25'; 106our $VERSION = '2.28';
107our @ISA = qw(Exporter); 107our @ISA = qw(Exporter);
108 108
109our @EXPORT = qw(encode_json decode_json to_json from_json); 109our @EXPORT = qw(encode_json decode_json to_json from_json);
110 110
111sub to_json($) { 111sub to_json($) {
1268 my $yaml = $to_yaml->encode ($ref) . "\n"; 1268 my $yaml = $to_yaml->encode ($ref) . "\n";
1269 1269
1270This will I<usually> generate JSON texts that also parse as valid 1270This will I<usually> generate JSON texts that also parse as valid
1271YAML. Please note that YAML has hardcoded limits on (simple) object key 1271YAML. Please note that YAML has hardcoded limits on (simple) object key
1272lengths that JSON doesn't have and also has different and incompatible 1272lengths that JSON doesn't have and also has different and incompatible
1273unicode handling, so you should make sure that your hash keys are 1273unicode character escape syntax, so you should make sure that your hash
1274noticeably shorter than the 1024 "stream characters" YAML allows and that 1274keys are noticeably shorter than the 1024 "stream characters" YAML allows
1275you do not have characters with codepoint values outside the Unicode BMP 1275and that you do not have characters with codepoint values outside the
1276(basic multilingual page). YAML also does not allow C<\/> sequences in 1276Unicode BMP (basic multilingual page). YAML also does not allow C<\/>
1277strings (which JSON::XS does not I<currently> generate, but other JSON 1277sequences in strings (which JSON::XS does not I<currently> generate, but
1278generators might). 1278other JSON generators might).
1279 1279
1280There might be other incompatibilities that I am not aware of (or the YAML 1280There might be other incompatibilities that I am not aware of (or the YAML
1281specification has been changed yet again - it does so quite often). In 1281specification has been changed yet again - it does so quite often). In
1282general you should not try to generate YAML with a JSON generator or vice 1282general you should not try to generate YAML with a JSON generator or vice
1283versa, or try to parse JSON with a YAML parser or vice versa: chances are 1283versa, or try to parse JSON with a YAML parser or vice versa: chances are
1302that difficult or long) and finally make YAML compatible to it, and 1302that difficult or long) and finally make YAML compatible to it, and
1303educating users about the changes, instead of spreading lies about the 1303educating users about the changes, instead of spreading lies about the
1304real compatibility for many I<years> and trying to silence people who 1304real compatibility for many I<years> and trying to silence people who
1305point out that it isn't true. 1305point out that it isn't true.
1306 1306
1307Addendum/2009: the YAML 1.2 spec is still incomaptible with JSON, even
1308though the incompatibilities have been documented (and are known to
1309Brian) for many years and the spec makes explicit claims that YAML is a
1310superset of JSON. It would be so easy to fix, but apparently, bullying and
1311corrupting userdata is so much easier.
1312
1307=back 1313=back
1308 1314
1309 1315
1310=head2 SPEED 1316=head2 SPEED
1311 1317
1318a very short single-line JSON string (also available at 1324a very short single-line JSON string (also available at
1319L<http://dist.schmorp.de/misc/json/short.json>). 1325L<http://dist.schmorp.de/misc/json/short.json>).
1320 1326
1321 {"method": "handleMessage", "params": ["user1", 1327 {"method": "handleMessage", "params": ["user1",
1322 "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7, 1328 "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,
1323 true, false]} 1329 1, 0]}
1324 1330
1325It shows the number of encodes/decodes per second (JSON::XS uses 1331It shows the number of encodes/decodes per second (JSON::XS uses
1326the functional interface, while JSON::XS/2 uses the OO interface 1332the functional interface, while JSON::XS/2 uses the OO interface
1327with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables 1333with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables
1328shrink). Higher is better: 1334shrink. JSON::DWIW/DS uses the deserialise function, while JSON::DWIW::FJ
1335uses the from_json method). Higher is better:
1329 1336
1330 module | encode | decode | 1337 module | encode | decode |
1331 -----------|------------|------------| 1338 --------------|------------|------------|
1332 JSON 1.x | 4990.842 | 4088.813 | 1339 JSON::DWIW/DS | 86302.551 | 102300.098 |
1333 JSON::DWIW | 51653.990 | 71575.154 | 1340 JSON::DWIW/FJ | 86302.551 | 75983.768 |
1334 JSON::PC | 65948.176 | 74631.744 | 1341 JSON::PP | 15827.562 | 6638.658 |
1335 JSON::PP | 8931.652 | 3817.168 | 1342 JSON::Syck | 63358.066 | 47662.545 |
1336 JSON::Syck | 24877.248 | 27776.848 | 1343 JSON::XS | 511500.488 | 511500.488 |
1337 JSON::XS | 388361.481 | 227951.304 | 1344 JSON::XS/2 | 291271.111 | 388361.481 |
1338 JSON::XS/2 | 227951.304 | 218453.333 | 1345 JSON::XS/3 | 361577.931 | 361577.931 |
1339 JSON::XS/3 | 338250.323 | 218453.333 | 1346 Storable | 66788.280 | 265462.278 |
1340 Storable | 16500.016 | 135300.129 |
1341 -----------+------------+------------+ 1347 --------------+------------+------------+
1342 1348
1343That is, JSON::XS is about five times faster than JSON::DWIW on encoding, 1349That is, JSON::XS is almost six times faster than JSON::DWIW on encoding,
1344about three times faster on decoding, and over forty times faster 1350about five times faster on decoding, and over thirty to seventy times
1345than JSON, even with pretty-printing and key sorting. It also compares 1351faster than JSON's pure perl implementation. It also compares favourably
1346favourably to Storable for small amounts of data. 1352to Storable for small amounts of data.
1347 1353
1348Using a longer test string (roughly 18KB, generated from Yahoo! Locals 1354Using a longer test string (roughly 18KB, generated from Yahoo! Locals
1349search API (L<http://dist.schmorp.de/misc/json/long.json>). 1355search API (L<http://dist.schmorp.de/misc/json/long.json>).
1350 1356
1351 module | encode | decode | 1357 module | encode | decode |
1352 -----------|------------|------------| 1358 --------------|------------|------------|
1353 JSON 1.x | 55.260 | 34.971 | 1359 JSON::DWIW/DS | 1647.927 | 2673.916 |
1354 JSON::DWIW | 825.228 | 1082.513 | 1360 JSON::DWIW/FJ | 1630.249 | 2596.128 |
1355 JSON::PC | 3571.444 | 2394.829 |
1356 JSON::PP | 210.987 | 32.574 | 1361 JSON::PP | 400.640 | 62.311 |
1357 JSON::Syck | 552.551 | 787.544 | 1362 JSON::Syck | 1481.040 | 1524.869 |
1358 JSON::XS | 5780.463 | 4854.519 | 1363 JSON::XS | 20661.596 | 9541.183 |
1359 JSON::XS/2 | 3869.998 | 4798.975 | 1364 JSON::XS/2 | 10683.403 | 9416.938 |
1360 JSON::XS/3 | 5862.880 | 4798.975 | 1365 JSON::XS/3 | 20661.596 | 9400.054 |
1361 Storable | 4445.002 | 5235.027 | 1366 Storable | 19765.806 | 10000.725 |
1362 -----------+------------+------------+ 1367 --------------+------------+------------+
1363 1368
1364Again, JSON::XS leads by far (except for Storable which non-surprisingly 1369Again, JSON::XS leads by far (except for Storable which non-surprisingly
1365decodes faster). 1370decodes a bit faster).
1366 1371
1367On large strings containing lots of high Unicode characters, some modules 1372On large strings containing lots of high Unicode characters, some modules
1368(such as JSON::PC) seem to decode faster than JSON::XS, but the result 1373(such as JSON::PC) seem to decode faster than JSON::XS, but the result
1369will be broken due to missing (or wrong) Unicode handling. Others refuse 1374will be broken due to missing (or wrong) Unicode handling. Others refuse
1370to decode or encode properly, so it was impossible to prepare a fair 1375to decode or encode properly, so it was impossible to prepare a fair
1406information you might want to make sure that exceptions thrown by JSON::XS 1411information you might want to make sure that exceptions thrown by JSON::XS
1407will not end up in front of untrusted eyes. 1412will not end up in front of untrusted eyes.
1408 1413
1409If you are using JSON::XS to return packets to consumption 1414If you are using JSON::XS to return packets to consumption
1410by JavaScript scripts in a browser you should have a look at 1415by JavaScript scripts in a browser you should have a look at
1411L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether 1416L<http://blog.archive.jpsykes.com/47/practical-csrf-and-json-security/> to
1412you are vulnerable to some common attack vectors (which really are browser 1417see whether you are vulnerable to some common attack vectors (which really
1413design bugs, but it is still you who will have to deal with it, as major 1418are browser design bugs, but it is still you who will have to deal with
1414browser developers care only for features, not about getting security 1419it, as major browser developers care only for features, not about getting
1415right). 1420security right).
1416 1421
1417 1422
1418=head1 THREADS 1423=head1 THREADS
1419 1424
1420This module is I<not> guaranteed to be thread safe and there are no 1425This module is I<not> guaranteed to be thread safe and there are no

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines