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