1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
3 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
|
|
4 | |
|
|
5 | JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ |
|
|
6 | (http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html) |
4 | |
7 | |
5 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
6 | |
9 | |
7 | use JSON::XS; |
10 | use JSON::XS; |
8 | |
11 | |
… | |
… | |
81 | |
84 | |
82 | package JSON::XS; |
85 | package JSON::XS; |
83 | |
86 | |
84 | use strict; |
87 | use strict; |
85 | |
88 | |
86 | our $VERSION = '1.43'; |
89 | our $VERSION = '1.51'; |
87 | our @ISA = qw(Exporter); |
90 | our @ISA = qw(Exporter); |
88 | |
91 | |
89 | our @EXPORT = qw(to_json from_json); |
92 | our @EXPORT = qw(to_json from_json); |
90 | |
93 | |
91 | use Exporter; |
94 | use Exporter; |
… | |
… | |
98 | |
101 | |
99 | =over 4 |
102 | =over 4 |
100 | |
103 | |
101 | =item $json_text = to_json $perl_scalar |
104 | =item $json_text = to_json $perl_scalar |
102 | |
105 | |
103 | Converts the given Perl data structure (a simple scalar or a reference to |
106 | Converts the given Perl data structure to a UTF-8 encoded, binary string |
104 | a hash or array) to a UTF-8 encoded, binary string (that is, the string contains |
107 | (that is, the string contains octets only). Croaks on error. |
105 | octets only). Croaks on error. |
|
|
106 | |
108 | |
107 | This function call is functionally identical to: |
109 | This function call is functionally identical to: |
108 | |
110 | |
109 | $json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
111 | $json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
110 | |
112 | |
111 | except being faster. |
113 | except being faster. |
112 | |
114 | |
113 | =item $perl_scalar = from_json $json_text |
115 | =item $perl_scalar = from_json $json_text |
114 | |
116 | |
115 | The opposite of C<to_json>: expects an UTF-8 (binary) string and tries to |
117 | The opposite of C<to_json>: expects an UTF-8 (binary) string and tries |
116 | parse that as an UTF-8 encoded JSON text, returning the resulting simple |
118 | to parse that as an UTF-8 encoded JSON text, returning the resulting |
117 | scalar or reference. Croaks on error. |
119 | reference. Croaks on error. |
118 | |
120 | |
119 | This function call is functionally identical to: |
121 | This function call is functionally identical to: |
120 | |
122 | |
121 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
123 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
122 | |
124 | |
… | |
… | |
130 | |
132 | |
131 | See MAPPING, below, for more information on how JSON values are mapped to |
133 | See MAPPING, below, for more information on how JSON values are mapped to |
132 | Perl. |
134 | Perl. |
133 | |
135 | |
134 | =back |
136 | =back |
|
|
137 | |
|
|
138 | |
|
|
139 | =head1 A FEW NOTES ON UNICODE AND PERL |
|
|
140 | |
|
|
141 | Since this often leads to confusion, here are a few very clear words on |
|
|
142 | how Unicode works in Perl, modulo bugs. |
|
|
143 | |
|
|
144 | =over 4 |
|
|
145 | |
|
|
146 | =item 1. Perl strings can store characters with ordinal values > 255. |
|
|
147 | |
|
|
148 | This enables you to store unicode characters as single characters in a |
|
|
149 | Perl string - very natural. |
|
|
150 | |
|
|
151 | =item 2. Perl does I<not> associate an encoding with your strings. |
|
|
152 | |
|
|
153 | Unless you force it to, e.g. when matching it against a regex, or printing |
|
|
154 | the scalar to a file, in which case Perl either interprets your string as |
|
|
155 | locale-encoded text, octets/binary, or as Unicode, depending on various |
|
|
156 | settings. In no case is an encoding stored together with your data, it is |
|
|
157 | I<use> that decides encoding, not any magical metadata. |
|
|
158 | |
|
|
159 | =item 3. The internal utf-8 flag has no meaning with regards to the |
|
|
160 | encoding of your string. |
|
|
161 | |
|
|
162 | Just ignore that flag unless you debug a Perl bug, a module written in |
|
|
163 | XS or want to dive into the internals of perl. Otherwise it will only |
|
|
164 | confuse you, as, despite the name, it says nothing about how your string |
|
|
165 | is encoded. You can have unicode strings with that flag set, with that |
|
|
166 | flag clear, and you can have binary data with that flag set and that flag |
|
|
167 | clear. Other possibilities exist, too. |
|
|
168 | |
|
|
169 | If you didn't know about that flag, just the better, pretend it doesn't |
|
|
170 | exist. |
|
|
171 | |
|
|
172 | =item 4. A "Unicode String" is simply a string where each character can be |
|
|
173 | validly interpreted as a Unicode codepoint. |
|
|
174 | |
|
|
175 | If you have UTF-8 encoded data, it is no longer a Unicode string, but a |
|
|
176 | Unicode string encoded in UTF-8, giving you a binary string. |
|
|
177 | |
|
|
178 | =item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string. |
|
|
179 | |
|
|
180 | Its a fact. Learn to live with it. |
|
|
181 | |
|
|
182 | =back |
|
|
183 | |
|
|
184 | I hope this helps :) |
135 | |
185 | |
136 | |
186 | |
137 | =head1 OBJECT-ORIENTED INTERFACE |
187 | =head1 OBJECT-ORIENTED INTERFACE |
138 | |
188 | |
139 | The object oriented interface lets you configure your own encoding or |
189 | The object oriented interface lets you configure your own encoding or |
… | |
… | |
277 | This setting has no effect when decoding JSON texts. |
327 | This setting has no effect when decoding JSON texts. |
278 | |
328 | |
279 | Example, space_before and indent disabled, space_after enabled: |
329 | Example, space_before and indent disabled, space_after enabled: |
280 | |
330 | |
281 | {"key": "value"} |
331 | {"key": "value"} |
|
|
332 | |
|
|
333 | =item $json = $json->relaxed ([$enable]) |
|
|
334 | |
|
|
335 | If C<$enable> is true (or missing), then C<decode> will accept some |
|
|
336 | extensions to normal JSON syntax (see below). C<encode> will not be |
|
|
337 | affected in anyway. I<Be aware that this option makes you accept invalid |
|
|
338 | JSON texts as if they were valid!>. I suggest only to use this option to |
|
|
339 | parse application-specific files written by humans (configuration files, |
|
|
340 | resource files etc.) |
|
|
341 | |
|
|
342 | If C<$enable> is false (the default), then C<decode> will only accept |
|
|
343 | valid JSON texts. |
|
|
344 | |
|
|
345 | Currently accepted extensions are: |
|
|
346 | |
|
|
347 | =over 4 |
|
|
348 | |
|
|
349 | =item * list items can have an end-comma |
|
|
350 | |
|
|
351 | JSON I<separates> array elements and key-value pairs with commas. This |
|
|
352 | can be annoying if you write JSON texts manually and want to be able to |
|
|
353 | quickly append elements, so this extension accepts comma at the end of |
|
|
354 | such items not just between them: |
|
|
355 | |
|
|
356 | [ |
|
|
357 | 1, |
|
|
358 | 2, <- this comma not normally allowed |
|
|
359 | ] |
|
|
360 | { |
|
|
361 | "k1": "v1", |
|
|
362 | "k2": "v2", <- this comma not normally allowed |
|
|
363 | } |
|
|
364 | |
|
|
365 | =item * shell-style '#'-comments |
|
|
366 | |
|
|
367 | Whenever JSON allows whitespace, shell-style comments are additionally |
|
|
368 | allowed. They are terminated by the first carriage-return or line-feed |
|
|
369 | character, after which more white-space and comments are allowed. |
|
|
370 | |
|
|
371 | [ |
|
|
372 | 1, # this comment not allowed in JSON |
|
|
373 | # neither this one... |
|
|
374 | ] |
|
|
375 | |
|
|
376 | =back |
282 | |
377 | |
283 | =item $json = $json->canonical ([$enable]) |
378 | =item $json = $json->canonical ([$enable]) |
284 | |
379 | |
285 | If C<$enable> is true (or missing), then the C<encode> method will output JSON objects |
380 | If C<$enable> is true (or missing), then the C<encode> method will output JSON objects |
286 | by sorting their keys. This is adding a comparatively high overhead. |
381 | by sorting their keys. This is adding a comparatively high overhead. |
… | |
… | |
621 | to_json [\0,JSON::XS::true] # yields [false,true] |
716 | to_json [\0,JSON::XS::true] # yields [false,true] |
622 | |
717 | |
623 | =item JSON::XS::true, JSON::XS::false |
718 | =item JSON::XS::true, JSON::XS::false |
624 | |
719 | |
625 | These special values become JSON true and JSON false values, |
720 | These special values become JSON true and JSON false values, |
626 | respectively. You cna alos use C<\1> and C<\0> directly if you want. |
721 | respectively. You can also use C<\1> and C<\0> directly if you want. |
627 | |
722 | |
628 | =item blessed objects |
723 | =item blessed objects |
629 | |
724 | |
630 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
725 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
631 | underlying representation (hash- or arrayref), but this behaviour might |
726 | underlying representation (hash- or arrayref), but this behaviour might |
… | |
… | |
881 | design bugs, but it is still you who will have to deal with it, as major |
976 | design bugs, but it is still you who will have to deal with it, as major |
882 | browser developers care only for features, not about doing security |
977 | browser developers care only for features, not about doing security |
883 | right). |
978 | right). |
884 | |
979 | |
885 | |
980 | |
|
|
981 | =head1 THREADS |
|
|
982 | |
|
|
983 | This module is I<not> guarenteed to be thread safe and there are no |
|
|
984 | plans to change this until Perl gets thread support (as opposed to the |
|
|
985 | horribly slow so-called "threads" which are simply slow and bloated |
|
|
986 | process simulations - use fork, its I<much> faster, cheaper, better). |
|
|
987 | |
|
|
988 | (It might actually work, but you ahve ben warned). |
|
|
989 | |
|
|
990 | |
886 | =head1 BUGS |
991 | =head1 BUGS |
887 | |
992 | |
888 | While the goal of this module is to be correct, that unfortunately does |
993 | While the goal of this module is to be correct, that unfortunately does |
889 | not mean its bug-free, only that I think its design is bug-free. It is |
994 | not mean its bug-free, only that I think its design is bug-free. It is |
890 | still relatively early in its development. If you keep reporting bugs they |
995 | still relatively early in its development. If you keep reporting bugs they |
891 | will be fixed swiftly, though. |
996 | will be fixed swiftly, though. |
|
|
997 | |
|
|
998 | Please refrain from using rt.cpan.org or any other bug reporting |
|
|
999 | service. I put the contact address into my modules for a reason. |
892 | |
1000 | |
893 | =cut |
1001 | =cut |
894 | |
1002 | |
895 | our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" }; |
1003 | our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" }; |
896 | our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" }; |
1004 | our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" }; |