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

Comparing JSON-XS/README (file contents):
Revision 1.25 by root, Wed Apr 16 18:38:38 2008 UTC vs.
Revision 1.39 by root, Tue Oct 29 15:55:49 2013 UTC

20 $perl_scalar = $coder->decode ($unicode_json_text); 20 $perl_scalar = $coder->decode ($unicode_json_text);
21 21
22 # Note that JSON version 2.0 and above will automatically use JSON::XS 22 # Note that JSON version 2.0 and above will automatically use JSON::XS
23 # if available, at virtually no speed overhead either, so you should 23 # if available, at virtually no speed overhead either, so you should
24 # be able to just: 24 # be able to just:
25 25
26 use JSON; 26 use JSON;
27 27
28 # and do the same things, except that you have a pure-perl fallback now. 28 # and do the same things, except that you have a pure-perl fallback now.
29 29
30DESCRIPTION 30DESCRIPTION
31 This module converts Perl data structures to JSON and vice versa. Its 31 This module converts Perl data structures to JSON and vice versa. Its
32 primary goal is to be *correct* and its secondary goal is to be *fast*. 32 primary goal is to be *correct* and its secondary goal is to be *fast*.
33 To reach the latter goal it was written in C. 33 To reach the latter goal it was written in C.
34 34
35 Beginning with version 2.0 of the JSON module, when both JSON and 35 Beginning with version 2.0 of the JSON module, when both JSON and
36 JSON::XS are installed, then JSON will fall back on JSON::XS (this can 36 JSON::XS are installed, then JSON will fall back on JSON::XS (this can
37 be overriden) with no overhead due to emulation (by inheritign 37 be overridden) with no overhead due to emulation (by inheriting
38 constructor and methods). If JSON::XS is not available, it will fall 38 constructor and methods). If JSON::XS is not available, it will fall
39 back to the compatible JSON::PP module as backend, so using JSON instead 39 back to the compatible JSON::PP module as backend, so using JSON instead
40 of JSON::XS gives you a portable JSON API that can be fast when you need 40 of JSON::XS gives you a portable JSON API that can be fast when you need
41 and doesn't require a C compiler when that is a problem. 41 and doesn't require a C compiler when that is a problem.
42 42
44 to write yet another JSON module? While it seems there are many JSON 44 to write yet another JSON module? While it seems there are many JSON
45 modules, none of them correctly handle all corner cases, and in most 45 modules, none of them correctly handle all corner cases, and in most
46 cases their maintainers are unresponsive, gone missing, or not listening 46 cases their maintainers are unresponsive, gone missing, or not listening
47 to bug reports for other reasons. 47 to bug reports for other reasons.
48 48
49 See COMPARISON, below, for a comparison to some other JSON modules.
50
51 See MAPPING, below, on how JSON::XS maps perl values to JSON values and 49 See MAPPING, below, on how JSON::XS maps perl values to JSON values and
52 vice versa. 50 vice versa.
53 51
54 FEATURES 52 FEATURES
55 * correct Unicode handling 53 * correct Unicode handling
57 This module knows how to handle Unicode, documents how and when it 55 This module knows how to handle Unicode, documents how and when it
58 does so, and even documents what "correct" means. 56 does so, and even documents what "correct" means.
59 57
60 * round-trip integrity 58 * round-trip integrity
61 59
62 When you serialise a perl data structure using only datatypes 60 When you serialise a perl data structure using only data types
63 supported by JSON, the deserialised data structure is identical on 61 supported by JSON and Perl, the deserialised data structure is
64 the Perl level. (e.g. the string "2.0" doesn't suddenly become "2" 62 identical on the Perl level. (e.g. the string "2.0" doesn't suddenly
65 just because it looks like a number). There minor *are* exceptions 63 become "2" just because it looks like a number). There *are* minor
66 to this, read the MAPPING section below to learn about those. 64 exceptions to this, read the MAPPING section below to learn about
65 those.
67 66
68 * strict checking of JSON correctness 67 * strict checking of JSON correctness
69 68
70 There is no guessing, no generating of illegal JSON texts by 69 There is no guessing, no generating of illegal JSON texts by
71 default, and only JSON is accepted as input by default (the latter 70 default, and only JSON is accepted as input by default (the latter
78 too. 77 too.
79 78
80 * simple to use 79 * simple to use
81 80
82 This module has both a simple functional interface as well as an 81 This module has both a simple functional interface as well as an
83 objetc oriented interface interface. 82 object oriented interface.
84 83
85 * reasonably versatile output formats 84 * reasonably versatile output formats
86 85
87 You can choose between the most compact guaranteed-single-line 86 You can choose between the most compact guaranteed-single-line
88 format possible (nice for simple line-based protocols), a pure-ascii 87 format possible (nice for simple line-based protocols), a pure-ASCII
89 format (for when your transport is not 8-bit clean, still supports 88 format (for when your transport is not 8-bit clean, still supports
90 the whole Unicode range), or a pretty-printed format (for when you 89 the whole Unicode range), or a pretty-printed format (for when you
91 want to read that stuff). Or you can combine those features in 90 want to read that stuff). Or you can combine those features in
92 whatever way you like. 91 whatever way you like.
93 92
101 100
102 This function call is functionally identical to: 101 This function call is functionally identical to:
103 102
104 $json_text = JSON::XS->new->utf8->encode ($perl_scalar) 103 $json_text = JSON::XS->new->utf8->encode ($perl_scalar)
105 104
106 except being faster. 105 Except being faster.
107 106
108 $perl_scalar = decode_json $json_text 107 $perl_scalar = decode_json $json_text
109 The opposite of "encode_json": expects an UTF-8 (binary) string and 108 The opposite of "encode_json": expects an UTF-8 (binary) string and
110 tries to parse that as an UTF-8 encoded JSON text, returning the 109 tries to parse that as an UTF-8 encoded JSON text, returning the
111 resulting reference. Croaks on error. 110 resulting reference. Croaks on error.
112 111
113 This function call is functionally identical to: 112 This function call is functionally identical to:
114 113
115 $perl_scalar = JSON::XS->new->utf8->decode ($json_text) 114 $perl_scalar = JSON::XS->new->utf8->decode ($json_text)
116 115
117 except being faster. 116 Except being faster.
118
119 $is_boolean = JSON::XS::is_bool $scalar
120 Returns true if the passed scalar represents either JSON::XS::true
121 or JSON::XS::false, two constants that act like 1 and 0,
122 respectively and are used to represent JSON "true" and "false"
123 values in Perl.
124
125 See MAPPING, below, for more information on how JSON values are
126 mapped to Perl.
127 117
128A FEW NOTES ON UNICODE AND PERL 118A FEW NOTES ON UNICODE AND PERL
129 Since this often leads to confusion, here are a few very clear words on 119 Since this often leads to confusion, here are a few very clear words on
130 how Unicode works in Perl, modulo bugs. 120 how Unicode works in Perl, modulo bugs.
131 121
152 142
153 If you didn't know about that flag, just the better, pretend it 143 If you didn't know about that flag, just the better, pretend it
154 doesn't exist. 144 doesn't exist.
155 145
156 4. A "Unicode String" is simply a string where each character can be 146 4. A "Unicode String" is simply a string where each character can be
157 validly interpreted as a Unicode codepoint. 147 validly interpreted as a Unicode code point.
158 If you have UTF-8 encoded data, it is no longer a Unicode string, 148 If you have UTF-8 encoded data, it is no longer a Unicode string,
159 but a Unicode string encoded in UTF-8, giving you a binary string. 149 but a Unicode string encoded in UTF-8, giving you a binary string.
160 150
161 5. A string containing "high" (> 255) character values is *not* a UTF-8 151 5. A string containing "high" (> 255) character values is *not* a UTF-8
162 string. 152 string.
370 output JSON objects by sorting their keys. This is adding a 360 output JSON objects by sorting their keys. This is adding a
371 comparatively high overhead. 361 comparatively high overhead.
372 362
373 If $enable is false, then the "encode" method will output key-value 363 If $enable is false, then the "encode" method will output key-value
374 pairs in the order Perl stores them (which will likely change 364 pairs in the order Perl stores them (which will likely change
375 between runs of the same script). 365 between runs of the same script, and can change even within the same
366 run from 5.18 onwards).
376 367
377 This option is useful if you want the same data structure to be 368 This option is useful if you want the same data structure to be
378 encoded as the same JSON text (given the same overall settings). If 369 encoded as the same JSON text (given the same overall settings). If
379 it is disabled, the same hash might be encoded differently even if 370 it is disabled, the same hash might be encoded differently even if
380 contains the same data, as key-value pairs have no inherent ordering 371 contains the same data, as key-value pairs have no inherent ordering
381 in Perl. 372 in Perl.
382 373
383 This setting has no effect when decoding JSON texts. 374 This setting has no effect when decoding JSON texts.
375
376 This setting has currently no effect on tied hashes.
384 377
385 $json = $json->allow_nonref ([$enable]) 378 $json = $json->allow_nonref ([$enable])
386 $enabled = $json->get_allow_nonref 379 $enabled = $json->get_allow_nonref
387 If $enable is true (or missing), then the "encode" method can 380 If $enable is true (or missing), then the "encode" method can
388 convert a non-reference into its corresponding string, number or 381 convert a non-reference into its corresponding string, number or
415 recommended to leave it off unless you know your communications 408 recommended to leave it off unless you know your communications
416 partner. 409 partner.
417 410
418 $json = $json->allow_blessed ([$enable]) 411 $json = $json->allow_blessed ([$enable])
419 $enabled = $json->get_allow_blessed 412 $enabled = $json->get_allow_blessed
413 See "OBJECT SERIALISATION" for details.
414
420 If $enable is true (or missing), then the "encode" method will not 415 If $enable is true (or missing), then the "encode" method will not
421 barf when it encounters a blessed reference. Instead, the value of 416 barf when it encounters a blessed reference that it cannot convert
422 the convert_blessed option will decide whether "null" 417 otherwise. Instead, a JSON "null" value is encoded instead of the
423 ("convert_blessed" disabled or no "TO_JSON" method found) or a 418 object.
424 representation of the object ("convert_blessed" enabled and
425 "TO_JSON" method found) is being encoded. Has no effect on "decode".
426 419
427 If $enable is false (the default), then "encode" will throw an 420 If $enable is false (the default), then "encode" will throw an
428 exception when it encounters a blessed object. 421 exception when it encounters a blessed object that it cannot convert
422 otherwise.
423
424 This setting has no effect on "decode".
429 425
430 $json = $json->convert_blessed ([$enable]) 426 $json = $json->convert_blessed ([$enable])
431 $enabled = $json->get_convert_blessed 427 $enabled = $json->get_convert_blessed
428 See "OBJECT SERIALISATION" for details.
429
432 If $enable is true (or missing), then "encode", upon encountering a 430 If $enable is true (or missing), then "encode", upon encountering a
433 blessed object, will check for the availability of the "TO_JSON" 431 blessed object, will check for the availability of the "TO_JSON"
434 method on the object's class. If found, it will be called in scalar 432 method on the object's class. If found, it will be called in scalar
435 context and the resulting scalar will be encoded instead of the 433 context and the resulting scalar will be encoded instead of the
436 object. If no "TO_JSON" method is found, the value of 434 object.
437 "allow_blessed" will decide what to do.
438 435
439 The "TO_JSON" method may safely call die if it wants. If "TO_JSON" 436 The "TO_JSON" method may safely call die if it wants. If "TO_JSON"
440 returns other blessed objects, those will be handled in the same 437 returns other blessed objects, those will be handled in the same
441 way. "TO_JSON" must take care of not causing an endless recursion 438 way. "TO_JSON" must take care of not causing an endless recursion
442 cycle (== crash) in this case. The name of "TO_JSON" was chosen 439 cycle (== crash) in this case. The name of "TO_JSON" was chosen
443 because other methods called by the Perl core (== not by the user of 440 because other methods called by the Perl core (== not by the user of
444 the object) are usually in upper case letters and to avoid 441 the object) are usually in upper case letters and to avoid
445 collisions with any "to_json" function or method. 442 collisions with any "to_json" function or method.
446 443
447 This setting does not yet influence "decode" in any way, but in the 444 If $enable is false (the default), then "encode" will not consider
448 future, global hooks might get installed that influence "decode" and 445 this type of conversion.
449 are enabled by this setting.
450 446
451 If $enable is false, then the "allow_blessed" setting will decide 447 This setting has no effect on "decode".
452 what to do when a blessed object is found. 448
449 $json = $json->allow_tags ([$enable])
450 $enabled = $json->allow_tags
451 See "OBJECT SERIALISATION" for details.
452
453 If $enable is true (or missing), then "encode", upon encountering a
454 blessed object, will check for the availability of the "FREEZE"
455 method on the object's class. If found, it will be used to serialise
456 the object into a nonstandard tagged JSON value (that JSON decoders
457 cannot decode).
458
459 It also causes "decode" to parse such tagged JSON values and
460 deserialise them via a call to the "THAW" method.
461
462 If $enable is false (the default), then "encode" will not consider
463 this type of conversion, and tagged JSON values will cause a parse
464 error in "decode", as if tags were not part of the grammar.
453 465
454 $json = $json->filter_json_object ([$coderef->($hashref)]) 466 $json = $json->filter_json_object ([$coderef->($hashref)])
455 When $coderef is specified, it will be called from "decode" each 467 When $coderef is specified, it will be called from "decode" each
456 time it decodes a JSON object. The only argument is a reference to 468 time it decodes a JSON object. The only argument is a reference to
457 the newly-created hash. If the code references returns a single 469 the newly-created hash. If the code references returns a single
593 605
594 See SECURITY CONSIDERATIONS, below, for more info on why this is 606 See SECURITY CONSIDERATIONS, below, for more info on why this is
595 useful. 607 useful.
596 608
597 $json_text = $json->encode ($perl_scalar) 609 $json_text = $json->encode ($perl_scalar)
598 Converts the given Perl data structure (a simple scalar or a 610 Converts the given Perl value or data structure to its JSON
599 reference to a hash or array) to its JSON representation. Simple 611 representation. Croaks on error.
600 scalars will be converted into JSON string or number sequences,
601 while references to arrays become JSON arrays and references to
602 hashes become JSON objects. Undefined Perl values (e.g. "undef")
603 become JSON "null" values. Neither "true" nor "false" values will be
604 generated.
605 612
606 $perl_scalar = $json->decode ($json_text) 613 $perl_scalar = $json->decode ($json_text)
607 The opposite of "encode": expects a JSON text and tries to parse it, 614 The opposite of "encode": expects a JSON text and tries to parse it,
608 returning the resulting simple scalar or reference. Croaks on error. 615 returning the resulting simple scalar or reference. Croaks on error.
609
610 JSON numbers and strings become simple Perl scalars. JSON arrays
611 become Perl arrayrefs and JSON objects become Perl hashrefs. "true"
612 becomes 1, "false" becomes 0 and "null" becomes "undef".
613 616
614 ($perl_scalar, $characters) = $json->decode_prefix ($json_text) 617 ($perl_scalar, $characters) = $json->decode_prefix ($json_text)
615 This works like the "decode" method, but instead of raising an 618 This works like the "decode" method, but instead of raising an
616 exception when there is trailing garbage after the first JSON 619 exception when there is trailing garbage after the first JSON
617 object, it will silently stop parsing there and return the number of 620 object, it will silently stop parsing there and return the number of
618 characters consumed so far. 621 characters consumed so far.
619 622
620 This is useful if your JSON texts are not delimited by an outer 623 This is useful if your JSON texts are not delimited by an outer
621 protocol (which is not the brightest thing to do in the first place)
622 and you need to know where the JSON text ends. 624 protocol and you need to know where the JSON text ends.
623 625
624 JSON::XS->new->decode_prefix ("[1] the tail") 626 JSON::XS->new->decode_prefix ("[1] the tail")
625 => ([], 3) 627 => ([], 3)
626 628
627INCREMENTAL PARSING 629INCREMENTAL PARSING
628 [This section and the API it details is still EXPERIMENTAL]
629
630 In some cases, there is the need for incremental parsing of JSON texts. 630 In some cases, there is the need for incremental parsing of JSON texts.
631 While this module always has to keep both JSON text and resulting Perl 631 While this module always has to keep both JSON text and resulting Perl
632 data structure in memory at one time, it does allow you to parse a JSON 632 data structure in memory at one time, it does allow you to parse a JSON
633 stream incrementally. It does so by accumulating text until it has a 633 stream incrementally. It does so by accumulating text until it has a
634 full JSON object, which it then can decode. This process is similar to 634 full JSON object, which it then can decode. This process is similar to
635 using "decode_prefix" to see if a full JSON object is available, but is 635 using "decode_prefix" to see if a full JSON object is available, but is
636 much more efficient (JSON::XS will only attempt to parse the JSON text 636 much more efficient (and can be implemented with a minimum of method
637 once it is sure it has enough text to get a decisive result, using a 637 calls).
638 very simple but truly incremental parser).
639 638
640 The following two methods deal with this. 639 JSON::XS will only attempt to parse the JSON text once it is sure it has
640 enough text to get a decisive result, using a very simple but truly
641 incremental parser. This means that it sometimes won't stop as early as
642 the full parser, for example, it doesn't detect mismatched parentheses.
643 The only thing it guarantees is that it starts decoding as soon as a
644 syntactically valid JSON text has been seen. This means you need to set
645 resource limits (e.g. "max_size") to ensure the parser will stop parsing
646 in the presence if syntax errors.
647
648 The following methods implement this incremental parser.
641 649
642 [void, scalar or list context] = $json->incr_parse ([$string]) 650 [void, scalar or list context] = $json->incr_parse ([$string])
643 This is the central parsing function. It can both append new text 651 This is the central parsing function. It can both append new text
644 and extract objects from the stream accumulated so far (both of 652 and extract objects from the stream accumulated so far (both of
645 these functions are optional). 653 these functions are optional).
653 661
654 If the method is called in scalar context, then it will try to 662 If the method is called in scalar context, then it will try to
655 extract exactly *one* JSON object. If that is successful, it will 663 extract exactly *one* JSON object. If that is successful, it will
656 return this object, otherwise it will return "undef". If there is a 664 return this object, otherwise it will return "undef". If there is a
657 parse error, this method will croak just as "decode" would do (one 665 parse error, this method will croak just as "decode" would do (one
658 can then use "incr_skip" to skip the errornous part). This is the 666 can then use "incr_skip" to skip the erroneous part). This is the
659 most common way of using the method. 667 most common way of using the method.
660 668
661 And finally, in list context, it will try to extract as many objects 669 And finally, in list context, it will try to extract as many objects
662 from the stream as it can find and return them, or the empty list 670 from the stream as it can find and return them, or the empty list
663 otherwise. For this to work, there must be no separators between the 671 otherwise. For this to work, there must be no separators between the
664 JSON objects or arrays, instead they must be concatenated 672 JSON objects or arrays, instead they must be concatenated
665 back-to-back. If an error occurs, an exception will be raised as in 673 back-to-back. If an error occurs, an exception will be raised as in
666 the scalar context case. Note that in this case, any 674 the scalar context case. Note that in this case, any
667 previously-parsed JSON texts will be lost. 675 previously-parsed JSON texts will be lost.
676
677 Example: Parse some JSON arrays/objects in a given string and return
678 them.
679
680 my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]");
668 681
669 $lvalue_string = $json->incr_text 682 $lvalue_string = $json->incr_text
670 This method returns the currently stored JSON fragment as an lvalue, 683 This method returns the currently stored JSON fragment as an lvalue,
671 that is, you can manipulate it. This *only* works when a preceding 684 that is, you can manipulate it. This *only* works when a preceding
672 call to "incr_parse" in *scalar context* successfully returned an 685 call to "incr_parse" in *scalar context* successfully returned an
680 after a JSON object or b) parsing multiple JSON objects separated by 693 after a JSON object or b) parsing multiple JSON objects separated by
681 non-JSON text (such as commas). 694 non-JSON text (such as commas).
682 695
683 $json->incr_skip 696 $json->incr_skip
684 This will reset the state of the incremental parser and will remove 697 This will reset the state of the incremental parser and will remove
685 the parsed text from the input buffer. This is useful after 698 the parsed text from the input buffer so far. This is useful after
686 "incr_parse" died, in which case the input buffer and incremental 699 "incr_parse" died, in which case the input buffer and incremental
687 parser state is left unchanged, to skip the text parsed so far and 700 parser state is left unchanged, to skip the text parsed so far and
688 to reset the parse state. 701 to reset the parse state.
702
703 The difference to "incr_reset" is that only text until the parse
704 error occurred is removed.
705
706 $json->incr_reset
707 This completely resets the incremental parser, that is, after this
708 call, it will be as if the parser had never parsed anything.
709
710 This is useful if you want to repeatedly parse JSON objects and want
711 to ignore any trailing data, which means you have to reset the
712 parser after each successful decode.
689 713
690 LIMITATIONS 714 LIMITATIONS
691 All options that affect decoding are supported, except "allow_nonref". 715 All options that affect decoding are supported, except "allow_nonref".
692 The reason for this is that it cannot be made to work sensibly: JSON 716 The reason for this is that it cannot be made to work sensibly: JSON
693 objects and arrays are self-delimited, i.e. you can concatenate them 717 objects and arrays are self-delimited, i.e. you can concatenate them
869 If the number consists of digits only, JSON::XS will try to 893 If the number consists of digits only, JSON::XS will try to
870 represent it as an integer value. If that fails, it will try to 894 represent it as an integer value. If that fails, it will try to
871 represent it as a numeric (floating point) value if that is possible 895 represent it as a numeric (floating point) value if that is possible
872 without loss of precision. Otherwise it will preserve the number as 896 without loss of precision. Otherwise it will preserve the number as
873 a string value (in which case you lose roundtripping ability, as the 897 a string value (in which case you lose roundtripping ability, as the
874 JSON number will be re-encoded toa JSON string). 898 JSON number will be re-encoded to a JSON string).
875 899
876 Numbers containing a fractional or exponential part will always be 900 Numbers containing a fractional or exponential part will always be
877 represented as numeric (floating point) values, possibly at a loss 901 represented as numeric (floating point) values, possibly at a loss
878 of precision (in which case you might lose perfect roundtripping 902 of precision (in which case you might lose perfect roundtripping
879 ability, but the JSON number will still be re-encoded as a JSON 903 ability, but the JSON number will still be re-encoded as a JSON
880 number). 904 number).
881 905
906 Note that precision is not accuracy - binary floating point values
907 cannot represent most decimal fractions exactly, and when converting
908 from and to floating point, JSON::XS only guarantees precision up to
909 but not including the least significant bit.
910
882 true, false 911 true, false
883 These JSON atoms become "JSON::XS::true" and "JSON::XS::false", 912 These JSON atoms become "Types::Serialiser::true" and
884 respectively. They are overloaded to act almost exactly like the 913 "Types::Serialiser::false", respectively. They are overloaded to act
885 numbers 1 and 0. You can check whether a scalar is a JSON boolean by 914 almost exactly like the numbers 1 and 0. You can check whether a
886 using the "JSON::XS::is_bool" function. 915 scalar is a JSON boolean by using the "Types::Serialiser::is_bool"
916 function (after "use Types::Serialier", of course).
887 917
888 null 918 null
889 A JSON null atom becomes "undef" in Perl. 919 A JSON null atom becomes "undef" in Perl.
920
921 shell-style comments ("# *text*")
922 As a nonstandard extension to the JSON syntax that is enabled by the
923 "relaxed" setting, shell-style comments are allowed. They can start
924 anywhere outside strings and go till the end of the line.
925
926 tagged values ("(*tag*)*value*").
927 Another nonstandard extension to the JSON syntax, enabled with the
928 "allow_tags" setting, are tagged values. In this implementation, the
929 *tag* must be a perl package/class name encoded as a JSON string,
930 and the *value* must be a JSON array encoding optional constructor
931 arguments.
932
933 See "OBJECT SERIALISATION", below, for details.
890 934
891 PERL -> JSON 935 PERL -> JSON
892 The mapping from Perl to JSON is slightly more difficult, as Perl is a 936 The mapping from Perl to JSON is slightly more difficult, as Perl is a
893 truly typeless language, so we can only guess which JSON type is meant 937 truly typeless language, so we can only guess which JSON type is meant
894 by a Perl value. 938 by a Perl value.
895 939
896 hash references 940 hash references
897 Perl hash references become JSON objects. As there is no inherent 941 Perl hash references become JSON objects. As there is no inherent
898 ordering in hash keys (or JSON objects), they will usually be 942 ordering in hash keys (or JSON objects), they will usually be
899 encoded in a pseudo-random order that can change between runs of the 943 encoded in a pseudo-random order. JSON::XS can optionally sort the
900 same program but stays generally the same within a single run of a 944 hash keys (determined by the *canonical* flag), so the same
901 program. JSON::XS can optionally sort the hash keys (determined by 945 datastructure will serialise to the same JSON text (given same
902 the *canonical* flag), so the same datastructure will serialise to 946 settings and version of JSON::XS), but this incurs a runtime
903 the same JSON text (given same settings and version of JSON::XS), 947 overhead and is only rarely useful, e.g. when you want to compare
904 but this incurs a runtime overhead and is only rarely useful, e.g. 948 some JSON text against another for equality.
905 when you want to compare some JSON text against another for
906 equality.
907 949
908 array references 950 array references
909 Perl array references become JSON arrays. 951 Perl array references become JSON arrays.
910 952
911 other references 953 other references
912 Other unblessed references are generally not allowed and will cause 954 Other unblessed references are generally not allowed and will cause
913 an exception to be thrown, except for references to the integers 0 955 an exception to be thrown, except for references to the integers 0
914 and 1, which get turned into "false" and "true" atoms in JSON. You 956 and 1, which get turned into "false" and "true" atoms in JSON.
915 can also use "JSON::XS::false" and "JSON::XS::true" to improve 957
958 Since "JSON::XS" uses the boolean model from Types::Serialiser, you
959 can also "use Types::Serialiser" and then use
960 "Types::Serialiser::false" and "Types::Serialiser::true" to improve
916 readability. 961 readability.
917 962
963 use Types::Serialiser;
918 encode_json [\0,JSON::XS::true] # yields [false,true] 964 encode_json [\0, Types::Serialiser::true] # yields [false,true]
919 965
920 JSON::XS::true, JSON::XS::false 966 Types::Serialiser::true, Types::Serialiser::false
921 These special values become JSON true and JSON false values, 967 These special values from the Types::Serialiser module become JSON
922 respectively. You can also use "\1" and "\0" directly if you want. 968 true and JSON false values, respectively. You can also use "\1" and
969 "\0" directly if you want.
923 970
924 blessed objects 971 blessed objects
925 Blessed objects are not directly representable in JSON. See the 972 Blessed objects are not directly representable in JSON, but
926 "allow_blessed" and "convert_blessed" methods on various options on 973 "JSON::XS" allows various ways of handling objects. See "OBJECT
927 how to deal with this: basically, you can choose between throwing an 974 SERIALISATION", below, for details.
928 exception, encoding the reference as if it weren't blessed, or
929 provide your own serialiser method.
930 975
931 simple scalars 976 simple scalars
932 Simple Perl scalars (any scalar that is not a reference) are the 977 Simple Perl scalars (any scalar that is not a reference) are the
933 most difficult objects to encode: JSON::XS will encode undefined 978 most difficult objects to encode: JSON::XS will encode undefined
934 scalars as JSON "null" values, scalars that have last been used in a 979 scalars as JSON "null" values, scalars that have last been used in a
962 1007
963 You can not currently force the type in other, less obscure, ways. 1008 You can not currently force the type in other, less obscure, ways.
964 Tell me if you need this capability (but don't forget to explain why 1009 Tell me if you need this capability (but don't forget to explain why
965 it's needed :). 1010 it's needed :).
966 1011
1012 Note that numerical precision has the same meaning as under Perl (so
1013 binary to decimal conversion follows the same rules as in Perl,
1014 which can differ to other languages). Also, your perl interpreter
1015 might expose extensions to the floating point numbers of your
1016 platform, such as infinities or NaN's - these cannot be represented
1017 in JSON, and it is an error to pass those in.
1018
1019 OBJECT SERIALISATION
1020 As JSON cannot directly represent Perl objects, you have to choose
1021 between a pure JSON representation (without the ability to deserialise
1022 the object automatically again), and a nonstandard extension to the JSON
1023 syntax, tagged values.
1024
1025 SERIALISATION
1026 What happens when "JSON::XS" encounters a Perl object depends on the
1027 "allow_blessed", "convert_blessed" and "allow_tags" settings, which are
1028 used in this order:
1029
1030 1. "allow_tags" is enabled and the object has a "FREEZE" method.
1031 In this case, "JSON::XS" uses the Types::Serialiser object
1032 serialisation protocol to create a tagged JSON value, using a
1033 nonstandard extension to the JSON syntax.
1034
1035 This works by invoking the "FREEZE" method on the object, with the
1036 first argument being the object to serialise, and the second
1037 argument being the constant string "JSON" to distinguish it from
1038 other serialisers.
1039
1040 The "FREEZE" method can return any number of values (i.e. zero or
1041 more). These values and the paclkage/classname of the object will
1042 then be encoded as a tagged JSON value in the following format:
1043
1044 ("classname")[FREEZE return values...]
1045
1046 e.g.:
1047
1048 ("URI")["http://www.google.com/"]
1049 ("MyDate")[2013,10,29]
1050 ("ImageData::JPEG")["Z3...VlCg=="]
1051
1052 For example, the hypothetical "My::Object" "FREEZE" method might use
1053 the objects "type" and "id" members to encode the object:
1054
1055 sub My::Object::FREEZE {
1056 my ($self, $serialiser) = @_;
1057
1058 ($self->{type}, $self->{id})
1059 }
1060
1061 2. "convert_blessed" is enabled and the object has a "TO_JSON" method.
1062 In this case, the "TO_JSON" method of the object is invoked in
1063 scalar context. It must return a single scalar that can be directly
1064 encoded into JSON. This scalar replaces the object in the JSON text.
1065
1066 For example, the following "TO_JSON" method will convert all URI
1067 objects to JSON strings when serialised. The fatc that these values
1068 originally were URI objects is lost.
1069
1070 sub URI::TO_JSON {
1071 my ($uri) = @_;
1072 $uri->as_string
1073 }
1074
1075 3. "allow_blessed" is enabled.
1076 The object will be serialised as a JSON null value.
1077
1078 4. none of the above
1079 If none of the settings are enabled or the respective methods are
1080 missing, "JSON::XS" throws an exception.
1081
1082 DESERIALISATION
1083 For deserialisation there are only two cases to consider: either
1084 nonstandard tagging was used, in which case "allow_tags" decides, or
1085 objects cannot be automatically be deserialised, in which case you can
1086 use postprocessing or the "filter_json_object" or
1087 "filter_json_single_key_object" callbacks to get some real objects our
1088 of your JSON.
1089
1090 This section only considers the tagged value case: I a tagged JSON
1091 object is encountered during decoding and "allow_tags" is disabled, a
1092 parse error will result (as if tagged values were not part of the
1093 grammar).
1094
1095 If "allow_tags" is enabled, "JSON::XS" will look up the "THAW" method of
1096 the package/classname used during serialisation (it will not attempt to
1097 load the package as a Perl module). If there is no such method, the
1098 decoding will fail with an error.
1099
1100 Otherwise, the "THAW" method is invoked with the classname as first
1101 argument, the constant string "JSON" as second argument, and all the
1102 values from the JSON array (the values originally returned by the
1103 "FREEZE" method) as remaining arguments.
1104
1105 The method must then return the object. While technically you can return
1106 any Perl scalar, you might have to enable the "enable_nonref" setting to
1107 make that work in all cases, so better return an actual blessed
1108 reference.
1109
1110 As an example, let's implement a "THAW" function that regenerates the
1111 "My::Object" from the "FREEZE" example earlier:
1112
1113 sub My::Object::THAW {
1114 my ($class, $serialiser, $type, $id) = @_;
1115
1116 $class->new (type => $type, id => $id)
1117 }
1118
967ENCODING/CODESET FLAG NOTES 1119ENCODING/CODESET FLAG NOTES
968 The interested reader might have seen a number of flags that signify 1120 The interested reader might have seen a number of flags that signify
969 encodings or codesets - "utf8", "latin1" and "ascii". There seems to be 1121 encodings or codesets - "utf8", "latin1" and "ascii". There seems to be
970 some confusion on what these do, so here is a short comparison: 1122 some confusion on what these do, so here is a short comparison:
971 1123
990 1142
991 "utf8" flag disabled 1143 "utf8" flag disabled
992 When "utf8" is disabled (the default), then "encode"/"decode" 1144 When "utf8" is disabled (the default), then "encode"/"decode"
993 generate and expect Unicode strings, that is, characters with high 1145 generate and expect Unicode strings, that is, characters with high
994 ordinal Unicode values (> 255) will be encoded as such characters, 1146 ordinal Unicode values (> 255) will be encoded as such characters,
995 and likewise such characters are decoded as-is, no canges to them 1147 and likewise such characters are decoded as-is, no changes to them
996 will be done, except "(re-)interpreting" them as Unicode codepoints 1148 will be done, except "(re-)interpreting" them as Unicode codepoints
997 or Unicode characters, respectively (to Perl, these are the same 1149 or Unicode characters, respectively (to Perl, these are the same
998 thing in strings unless you do funny/weird/dumb stuff). 1150 thing in strings unless you do funny/weird/dumb stuff).
999 1151
1000 This is useful when you want to do the encoding yourself (e.g. when 1152 This is useful when you want to do the encoding yourself (e.g. when
1057 structure back. This is useful when your channel for JSON transfer 1209 structure back. This is useful when your channel for JSON transfer
1058 is not 8-bit clean or the encoding might be mangled in between (e.g. 1210 is not 8-bit clean or the encoding might be mangled in between (e.g.
1059 in mail), and works because ASCII is a proper subset of most 8-bit 1211 in mail), and works because ASCII is a proper subset of most 8-bit
1060 and multibyte encodings in use in the world. 1212 and multibyte encodings in use in the world.
1061 1213
1214 JSON and ECMAscript
1215 JSON syntax is based on how literals are represented in javascript (the
1216 not-standardised predecessor of ECMAscript) which is presumably why it
1217 is called "JavaScript Object Notation".
1218
1219 However, JSON is not a subset (and also not a superset of course) of
1220 ECMAscript (the standard) or javascript (whatever browsers actually
1221 implement).
1222
1223 If you want to use javascript's "eval" function to "parse" JSON, you
1224 might run into parse errors for valid JSON texts, or the resulting data
1225 structure might not be queryable:
1226
1227 One of the problems is that U+2028 and U+2029 are valid characters
1228 inside JSON strings, but are not allowed in ECMAscript string literals,
1229 so the following Perl fragment will not output something that can be
1230 guaranteed to be parsable by javascript's "eval":
1231
1232 use JSON::XS;
1233
1234 print encode_json [chr 0x2028];
1235
1236 The right fix for this is to use a proper JSON parser in your javascript
1237 programs, and not rely on "eval" (see for example Douglas Crockford's
1238 json2.js parser).
1239
1240 If this is not an option, you can, as a stop-gap measure, simply encode
1241 to ASCII-only JSON:
1242
1243 use JSON::XS;
1244
1245 print JSON::XS->new->ascii->encode ([chr 0x2028]);
1246
1247 Note that this will enlarge the resulting JSON text quite a bit if you
1248 have many non-ASCII characters. You might be tempted to run some regexes
1249 to only escape U+2028 and U+2029, e.g.:
1250
1251 # DO NOT USE THIS!
1252 my $json = JSON::XS->new->utf8->encode ([chr 0x2028]);
1253 $json =~ s/\xe2\x80\xa8/\\u2028/g; # escape U+2028
1254 $json =~ s/\xe2\x80\xa9/\\u2029/g; # escape U+2029
1255 print $json;
1256
1257 Note that *this is a bad idea*: the above only works for U+2028 and
1258 U+2029 and thus only for fully ECMAscript-compliant parsers. Many
1259 existing javascript implementations, however, have issues with other
1260 characters as well - using "eval" naively simply *will* cause problems.
1261
1262 Another problem is that some javascript implementations reserve some
1263 property names for their own purposes (which probably makes them
1264 non-ECMAscript-compliant). For example, Iceweasel reserves the
1265 "__proto__" property name for its own purposes.
1266
1267 If that is a problem, you could parse try to filter the resulting JSON
1268 output for these property strings, e.g.:
1269
1270 $json =~ s/"__proto__"\s*:/"__proto__renamed":/g;
1271
1272 This works because "__proto__" is not valid outside of strings, so every
1273 occurrence of ""__proto__"\s*:" must be a string used as property name.
1274
1275 If you know of other incompatibilities, please let me know.
1276
1062 JSON and YAML 1277 JSON and YAML
1063 You often hear that JSON is a subset of YAML. This is, however, a mass 1278 You often hear that JSON is a subset of YAML. This is, however, a mass
1064 hysteria(*) and very far from the truth (as of the time of this 1279 hysteria(*) and very far from the truth (as of the time of this
1065 writing), so let me state it clearly: *in general, there is no way to 1280 writing), so let me state it clearly: *in general, there is no way to
1066 configure JSON::XS to output a data structure as valid YAML* that works 1281 configure JSON::XS to output a data structure as valid YAML* that works
1073 my $yaml = $to_yaml->encode ($ref) . "\n"; 1288 my $yaml = $to_yaml->encode ($ref) . "\n";
1074 1289
1075 This will *usually* generate JSON texts that also parse as valid YAML. 1290 This will *usually* generate JSON texts that also parse as valid YAML.
1076 Please note that YAML has hardcoded limits on (simple) object key 1291 Please note that YAML has hardcoded limits on (simple) object key
1077 lengths that JSON doesn't have and also has different and incompatible 1292 lengths that JSON doesn't have and also has different and incompatible
1078 unicode handling, so you should make sure that your hash keys are 1293 unicode character escape syntax, so you should make sure that your hash
1079 noticeably shorter than the 1024 "stream characters" YAML allows and 1294 keys are noticeably shorter than the 1024 "stream characters" YAML
1080 that you do not have characters with codepoint values outside the 1295 allows and that you do not have characters with codepoint values outside
1081 Unicode BMP (basic multilingual page). YAML also does not allow "\/" 1296 the Unicode BMP (basic multilingual page). YAML also does not allow "\/"
1082 sequences in strings (which JSON::XS does not *currently* generate, but 1297 sequences in strings (which JSON::XS does not *currently* generate, but
1083 other JSON generators might). 1298 other JSON generators might).
1084 1299
1085 There might be other incompatibilities that I am not aware of (or the 1300 There might be other incompatibilities that I am not aware of (or the
1086 YAML specification has been changed yet again - it does so quite often). 1301 YAML specification has been changed yet again - it does so quite often).
1103 (which is not that difficult or long) and finally make YAML 1318 (which is not that difficult or long) and finally make YAML
1104 compatible to it, and educating users about the changes, instead of 1319 compatible to it, and educating users about the changes, instead of
1105 spreading lies about the real compatibility for many *years* and 1320 spreading lies about the real compatibility for many *years* and
1106 trying to silence people who point out that it isn't true. 1321 trying to silence people who point out that it isn't true.
1107 1322
1323 Addendum/2009: the YAML 1.2 spec is still incompatible with JSON,
1324 even though the incompatibilities have been documented (and are
1325 known to Brian) for many years and the spec makes explicit claims
1326 that YAML is a superset of JSON. It would be so easy to fix, but
1327 apparently, bullying people and corrupting userdata is so much
1328 easier.
1329
1108 SPEED 1330 SPEED
1109 It seems that JSON::XS is surprisingly fast, as shown in the following 1331 It seems that JSON::XS is surprisingly fast, as shown in the following
1110 tables. They have been generated with the help of the "eg/bench" program 1332 tables. They have been generated with the help of the "eg/bench" program
1111 in the JSON::XS distribution, to make it easy to compare on your own 1333 in the JSON::XS distribution, to make it easy to compare on your own
1112 system. 1334 system.
1115 single-line JSON string (also available at 1337 single-line JSON string (also available at
1116 <http://dist.schmorp.de/misc/json/short.json>). 1338 <http://dist.schmorp.de/misc/json/short.json>).
1117 1339
1118 {"method": "handleMessage", "params": ["user1", 1340 {"method": "handleMessage", "params": ["user1",
1119 "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7, 1341 "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,
1120 true, false]} 1342 1, 0]}
1121 1343
1122 It shows the number of encodes/decodes per second (JSON::XS uses the 1344 It shows the number of encodes/decodes per second (JSON::XS uses the
1123 functional interface, while JSON::XS/2 uses the OO interface with 1345 functional interface, while JSON::XS/2 uses the OO interface with
1124 pretty-printing and hashkey sorting enabled, JSON::XS/3 enables shrink). 1346 pretty-printing and hashkey sorting enabled, JSON::XS/3 enables shrink.
1125 Higher is better: 1347 JSON::DWIW/DS uses the deserialise function, while JSON::DWIW::FJ uses
1348 the from_json method). Higher is better:
1126 1349
1127 module | encode | decode | 1350 module | encode | decode |
1128 -----------|------------|------------| 1351 --------------|------------|------------|
1129 JSON 1.x | 4990.842 | 4088.813 | 1352 JSON::DWIW/DS | 86302.551 | 102300.098 |
1130 JSON::DWIW | 51653.990 | 71575.154 | 1353 JSON::DWIW/FJ | 86302.551 | 75983.768 |
1131 JSON::PC | 65948.176 | 74631.744 | 1354 JSON::PP | 15827.562 | 6638.658 |
1132 JSON::PP | 8931.652 | 3817.168 | 1355 JSON::Syck | 63358.066 | 47662.545 |
1133 JSON::Syck | 24877.248 | 27776.848 | 1356 JSON::XS | 511500.488 | 511500.488 |
1134 JSON::XS | 388361.481 | 227951.304 | 1357 JSON::XS/2 | 291271.111 | 388361.481 |
1135 JSON::XS/2 | 227951.304 | 218453.333 | 1358 JSON::XS/3 | 361577.931 | 361577.931 |
1136 JSON::XS/3 | 338250.323 | 218453.333 | 1359 Storable | 66788.280 | 265462.278 |
1137 Storable | 16500.016 | 135300.129 |
1138 -----------+------------+------------+ 1360 --------------+------------+------------+
1139 1361
1140 That is, JSON::XS is about five times faster than JSON::DWIW on 1362 That is, JSON::XS is almost six times faster than JSON::DWIW on
1141 encoding, about three times faster on decoding, and over forty times 1363 encoding, about five times faster on decoding, and over thirty to
1142 faster than JSON, even with pretty-printing and key sorting. It also 1364 seventy times faster than JSON's pure perl implementation. It also
1143 compares favourably to Storable for small amounts of data. 1365 compares favourably to Storable for small amounts of data.
1144 1366
1145 Using a longer test string (roughly 18KB, generated from Yahoo! Locals 1367 Using a longer test string (roughly 18KB, generated from Yahoo! Locals
1146 search API (<http://dist.schmorp.de/misc/json/long.json>). 1368 search API (<http://dist.schmorp.de/misc/json/long.json>).
1147 1369
1148 module | encode | decode | 1370 module | encode | decode |
1149 -----------|------------|------------| 1371 --------------|------------|------------|
1150 JSON 1.x | 55.260 | 34.971 | 1372 JSON::DWIW/DS | 1647.927 | 2673.916 |
1151 JSON::DWIW | 825.228 | 1082.513 | 1373 JSON::DWIW/FJ | 1630.249 | 2596.128 |
1152 JSON::PC | 3571.444 | 2394.829 |
1153 JSON::PP | 210.987 | 32.574 | 1374 JSON::PP | 400.640 | 62.311 |
1154 JSON::Syck | 552.551 | 787.544 | 1375 JSON::Syck | 1481.040 | 1524.869 |
1155 JSON::XS | 5780.463 | 4854.519 | 1376 JSON::XS | 20661.596 | 9541.183 |
1156 JSON::XS/2 | 3869.998 | 4798.975 | 1377 JSON::XS/2 | 10683.403 | 9416.938 |
1157 JSON::XS/3 | 5862.880 | 4798.975 | 1378 JSON::XS/3 | 20661.596 | 9400.054 |
1158 Storable | 4445.002 | 5235.027 | 1379 Storable | 19765.806 | 10000.725 |
1159 -----------+------------+------------+ 1380 --------------+------------+------------+
1160 1381
1161 Again, JSON::XS leads by far (except for Storable which non-surprisingly 1382 Again, JSON::XS leads by far (except for Storable which non-surprisingly
1162 decodes faster). 1383 decodes a bit faster).
1163 1384
1164 On large strings containing lots of high Unicode characters, some 1385 On large strings containing lots of high Unicode characters, some
1165 modules (such as JSON::PC) seem to decode faster than JSON::XS, but the 1386 modules (such as JSON::PC) seem to decode faster than JSON::XS, but the
1166 result will be broken due to missing (or wrong) Unicode handling. Others 1387 result will be broken due to missing (or wrong) Unicode handling. Others
1167 refuse to decode or encode properly, so it was impossible to prepare a 1388 refuse to decode or encode properly, so it was impossible to prepare a
1202 information you might want to make sure that exceptions thrown by 1423 information you might want to make sure that exceptions thrown by
1203 JSON::XS will not end up in front of untrusted eyes. 1424 JSON::XS will not end up in front of untrusted eyes.
1204 1425
1205 If you are using JSON::XS to return packets to consumption by JavaScript 1426 If you are using JSON::XS to return packets to consumption by JavaScript
1206 scripts in a browser you should have a look at 1427 scripts in a browser you should have a look at
1207 <http://jpsykes.com/47/practical-csrf-and-json-security> to see whether 1428 <http://blog.archive.jpsykes.com/47/practical-csrf-and-json-security/>
1208 you are vulnerable to some common attack vectors (which really are 1429 to see whether you are vulnerable to some common attack vectors (which
1209 browser design bugs, but it is still you who will have to deal with it, 1430 really are browser design bugs, but it is still you who will have to
1210 as major browser developers care only for features, not about getting 1431 deal with it, as major browser developers care only for features, not
1211 security right). 1432 about getting security right).
1433
1434INTEROPERABILITY WITH OTHER MODULES
1435 "JSON::XS" uses the Types::Serialiser module to provide boolean
1436 constants. That means that the JSON true and false values will be
1437 comaptible to true and false values of iother modules that do the same,
1438 such as JSON::PP and CBOR::XS.
1212 1439
1213THREADS 1440THREADS
1214 This module is *not* guaranteed to be thread safe and there are no plans 1441 This module is *not* guaranteed to be thread safe and there are no plans
1215 to change this until Perl gets thread support (as opposed to the 1442 to change this until Perl gets thread support (as opposed to the
1216 horribly slow so-called "threads" which are simply slow and bloated 1443 horribly slow so-called "threads" which are simply slow and bloated
1217 process simulations - use fork, it's *much* faster, cheaper, better). 1444 process simulations - use fork, it's *much* faster, cheaper, better).
1218 1445
1219 (It might actually work, but you have been warned). 1446 (It might actually work, but you have been warned).
1220 1447
1448THE PERILS OF SETLOCALE
1449 Sometimes people avoid the Perl locale support and directly call the
1450 system's setlocale function with "LC_ALL".
1451
1452 This breaks both perl and modules such as JSON::XS, as stringification
1453 of numbers no longer works correctly (e.g. "$x = 0.1; print "$x"+1"
1454 might print 1, and JSON::XS might output illegal JSON as JSON::XS relies
1455 on perl to stringify numbers).
1456
1457 The solution is simple: don't call "setlocale", or use it for only those
1458 categories you need, such as "LC_MESSAGES" or "LC_CTYPE".
1459
1460 If you need "LC_NUMERIC", you should enable it only around the code that
1461 actually needs it (avoiding stringification of numbers), and restore it
1462 afterwards.
1463
1221BUGS 1464BUGS
1222 While the goal of this module is to be correct, that unfortunately does 1465 While the goal of this module is to be correct, that unfortunately does
1223 not mean it's bug-free, only that I think its design is bug-free. It is 1466 not mean it's bug-free, only that I think its design is bug-free. If you
1224 still relatively early in its development. If you keep reporting bugs
1225 they will be fixed swiftly, though. 1467 keep reporting bugs they will be fixed swiftly, though.
1226 1468
1227 Please refrain from using rt.cpan.org or any other bug reporting 1469 Please refrain from using rt.cpan.org or any other bug reporting
1228 service. I put the contact address into my modules for a reason. 1470 service. I put the contact address into my modules for a reason.
1229 1471
1230SEE ALSO 1472SEE ALSO

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines