在PHP语言中使用JSON

来源：互联网发布：冰雪奇缘音乐分析知乎编辑：程序博客网时间：2024/06/04 18:07

在PHP语言中使用JSON

作者：阮一峰

日期： 2011年1月14日

目前，JSON已经成为最流行的数据交换格式之一，各大网站的API几乎都支持它。

我写过一篇《数据类型和JSON格式》，探讨它的设计思想。今天，我想总结一下PHP语言对它的支持，这是开发互联网应用程序（特别是编写API）必须了解的知识。

从5.2版本开始，PHP原生提供json_encode()和json_decode()函数，前者用于编码，后者用于解码。

一、json_encode()

该函数主要用来将数组和对象，转换为json格式。先看一个数组转换的例子：

　　$arr = array ('a'=>1,'b'=>2,'c'=>3,'d'=>4,'e'=>5);　　　　echo json_encode($arr);

结果为

　　{"a":1,"b":2,"c":3,"d":4,"e":5}

再看一个对象转换的例子：

　　$obj->body           = 'another post';　　　　$obj->id             = 21;　　　　$obj->approved       = true;　　　　$obj->favorite_count = 1;　　　　$obj->status         = NULL;　　　　echo json_encode($obj);

结果为

　　{　　　　"body":"another post",　　　　　　"id":21,　　　　　　"approved":true,　　　　　　"favorite_count":1,　　　　　　"status":null　　}

由于json只接受utf-8编码的字符，所以json_encode()的参数必须是utf-8编码，否则会得到空字符或者null。当中文使用GB2312编码，或者外文使用ISO-8859-1编码的时候，这一点要特别注意。

二、索引数组和关联数组

PHP支持两种数组，一种是只保存"值"（value）的索引数组（indexed array），另一种是保存"名值对"（name/value）的关联数组（associative array）。

由于javascript不支持关联数组，所以json_encode()只将索引数组（indexed array）转为数组格式，而将关联数组（associative array）转为对象格式。

比如，现在有一个索引数组

　　$arr = Array('one', 'two', 'three');　　　　echo json_encode($arr);

结果为：

　　["one","two","three"]

如果将它改为关联数组：

　　$arr = Array('1'=>'one', '2'=>'two', '3'=>'three'); 　　　　echo json_encode($arr);

结果就变了：

　　{"1":"one","2":"two","3":"three"}

注意，数据格式从"[]"（数组）变成了"{}"（对象）。

如果你需要将"索引数组"强制转化成"对象"，可以这样写

　　json_encode( (object)$arr );

或者

　　json_encode ( $arr, JSON_FORCE_OBJECT );

三、类（class）的转换

下面是一个PHP的类：

　　class Foo {　　　　　　const     ERROR_CODE = '404';　　　　　　public    $public_ex = 'this is public';　　　　　　private   $private_ex = 'this is private!';　　　　　　protected $protected_ex = 'this should be protected';  　　　　　　public function getErrorCode() {　　　　　　　　return self::ERROR_CODE;　　　　　　}　　　　}

现在，对这个类的实例进行json转换：

　　$foo = new Foo;　　　　$foo_json = json_encode($foo);　　　　echo $foo_json;

输出结果是

　　{"public_ex":"this is public"}

可以看到，除了公开变量（public），其他东西（常量、私有变量、方法等等）都遗失了。

四、json_decode()

该函数用于将json文本转换为相应的PHP数据结构。下面是一个例子：

　　$json = '{"foo": 12345}'; 　　　　$obj = json_decode($json);　　　　print $obj->{'foo'}; // 12345

通常情况下，json_decode()总是返回一个PHP对象，而不是数组。比如：

　　$json = '{"a":1,"b":2,"c":3,"d":4,"e":5}'; 　　　　var_dump(json_decode($json));

结果就是生成一个PHP对象：

　　object(stdClass)#1 (5) {　　　　　　["a"] => int(1)　　　　["b"] => int(2)　　　　["c"] => int(3)　　　　["d"] => int(4)　　　　["e"] => int(5)　　　　}

如果想要强制生成PHP关联数组，json_decode()需要加一个参数true：

　　$json = '{"a":1,"b":2,"c":3,"d":4,"e":5}'; 　　　　var_dump(json_decode($json,true));

结果就生成了一个关联数组：

　　array(5) {　　　　 　　["a"] => int(1)　　 　　["b"] => int(2)　　 　　["c"] => int(3)　　 　　["d"] => int(4)　　 　　["e"] => int(5)　　　　}

五、json_decode()的常见错误

下面三种json写法都是错的，你能看出错在哪里吗？

　　$bad_json = "{ 'bar': 'baz' }";　　　　$bad_json = '{ bar: "baz" }';　　　　$bad_json = '{ "bar": "baz", }';

对这三个字符串执行json_decode()都将返回null，并且报错。

第一个的错误是，json的分隔符（delimiter）只允许使用双引号，不能使用单引号。第二个的错误是，json名值对的"名"（冒号左边的部分），任何情况下都必须使用双引号。第三个的错误是，最后一个值之后不能添加逗号（trailing comma）。

另外，json只能用来表示对象（object）和数组（array），如果对一个字符串或数值使用json_decode()，将会返回null。

　　var_dump(json_decode("Hello World")); //null

六、参考材料

　　[1] PHP Manual
　　[2] Ed Finkler, JSON is Everybody's Friend

（完）

珠峰培训

2016.03.08: Systemd 入门教程：实战篇
上一篇文章，我介绍了 Systemd 的主要命令，今天介绍如何使用它完成一些基本的任务。
2016.03.07: Systemd 入门教程：命令篇
Systemd 是 Linux 系统工具，用来启动守护进程，已成为大多数发行版的标准配置。
2016.02.28: Linux 守护进程的启动方法
"守护进程"（daemon）就是一直在后台运行的进程（daemon）。
2016.01.06: Commit message 和 Change log 编写指南
Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。

广告（购买广告位）

留言（38条）

ideadodo 说：

阮兄，请教个问题，我正在学php，已经学完这些东西了 http://www.w3school.com.cn/php/index.asp ，下一步学什么，能推荐一下吗？谢谢！

2011年1月14日 20:21 |# | 引用

阮一峰说：

To ideadodo:

可以阅读“PHP and MySQL Web Development”，作者Luke Welling 和Laura Thomson。

2011年1月15日 01:14 |# | 引用

aNd1coder 说：

谢谢，内容写得浅显易懂

2011年1月15日 09:23 |# | 引用

ikbear 说：

引用阮一峰的发言：
To ideadodo:
可以阅读“PHP and MySQL Web Development”，作者Luke Welling 和Laura Thomson。

我也在看这本:-)

2011年1月15日 09:41 |# | 引用

QQD 说：

我想问一下阮一峰先生
对文学之后你对什么感兴趣了？

2011年1月16日 14:42 |# | 引用

56480708 说：

请问这个网站用的是什么blog系统 ~ 感觉不错

2011年1月16日 16:24 |# | 引用

toobull 说：

楼主...我看到你文章最后常见错误里边说：
第一个的错误是，json的分隔符（delimiter）只允许使用双引号，不能使用单引号。第二个的错误是，json名值对的"名"（冒号左边的部分），任何情况下都必须使用双引号。第三个的错误是，最后一个值之后不能添加逗号（trailing comma）。

对于第一个，我在写js的时候，之前没有注意，都习惯性的给json用的单引号分割的，但是好像使用没有什么问题，对于第二个，json名没有添加引号也可以正常使用....最后一个好像的确会报错。

而对于第一个问题，我搜索了很多信息，也没有找到相关说明，请楼主指教....

2011年5月12日 15:09 |# | 引用

anyLiv 说：

@toobull：

作者写的是 PHP 的情况跟 JS 处理 JSON 时还是有很多区别的...

2011年6月14日 22:40 |# | 引用

ysbear 说：

toobull,楼主写的应该是在PHP处理JSON时出现的情况，而你说的好像是JS里处理JSON的情况。
而且你还有个误区，不是说不出错的就是对的，写程序要严谨，对于一切可能出错的地方我们都应该避免它出错

2011年7月 8日 10:54 |# | 引用

yxcity 说：

写的还好！

2012年3月19日 18:06 |# | 引用

关小开说：

请教json_decode()在对长数字进行解析的时候是不是会自动进行取整？怎么解决？

2012年6月18日 11:51 |# | 引用

Cherrot 说：

浅显易懂，谢谢阮兄的分享！

2012年7月25日 16:03 |# | 引用

疯狂的蚂蚁说：

写的非常清晰，刚好拿来用了，谢谢博主

2012年8月18日 23:54 |# | 引用

cmoooo 说：

var_dump(json_decode($json),true);

这一行代码示例有错误，应该为：

var_dump(json_decode($json ,true));

2012年10月15日 22:27 |# | 引用

纪庆说：

非常棒

2013年1月14日 13:12 |# | 引用

谈腾说：

通俗易懂，学习了！

2013年1月20日 16:56 |# | 引用

Mr_easy 说：

写的很详细，谢谢你！

2013年1月22日 08:51 |# | 引用

飘雪说：

怎么向另一个php页面post json数据呢？php页面又如何接受post过来的json数据？

2013年1月25日 16:20 |# | 引用

飞龙说：

$arr = Array('one', 'two', 'three'); 请问，这里的 array 为何大写？

2013年2月25日 17:18 |# | 引用

lip2up 说：

引用toobull的发言：
楼主...我看到你文章最后常见错误里边说：
第一个的错误是，json的分隔符（delimiter）只允许使用双引号，不能使用单引号。第二个的错误是，json名值对的"名"（冒号左边的部分），任何情况下都必须使用双引号。第三个的错误是，最后一个值之后不能添加逗号（trailing comma）。
对于第一个，我在写js的时候，之前没有注意，都习惯性的给json用的单引号分割的，但是好像使用没有什么问题，对于第二个，json名没有添加引号也可以正常使用....最后一个好像的确会报错。

这位朋友混淆了 JS 支持的对象格式与 JSON 数据格式，尽管两者很相似，但 JSON 要求键值必须用双引号括起来，这是跨语言数据交换所必须的。ECMAScript 5 新引入的 JSON 对象的 parse 方法是不支持不带双引号的键值的。

2013年2月27日 10:21 |# | 引用

岳宗坤说：

您好，我在找javascript中到底有没有关联数组这个东西，很多人都把json对象叫做关联数组，不知道这种叫法是否正确，看到这篇文章中提到“由于javascript不支持关联数组”，眼前一亮，不知您能否提供一些比较有说服力的参考资料？
BTW，我也一直认为javascript不支持关联数组，但是一直没有找到有说服力的证据，希望能帮我弄清楚。

2013年6月 4日 18:31 |# | 引用

asdfg 说：

引用岳宗坤的发言：
您好，我在找javascript中到底有没有关联数组这个东西，很多人都把json对象叫做关联数组，不知道这种叫法是否正确，看到这篇文章中提到“由于javascript不支持关联数组”，眼前一亮，不知您能否提供一些比较有说服力的参考资料？
BTW，我也一直认为javascript不支持关联数组，但是一直没有找到有说服力的证据，希望能帮我弄清楚。

我觉很简单，之所以他们叫json为关联数组是因为json同时具备关联数组的特征，换句话说，js中的所有对象都具备这个特征，只不过json更明显，就犹如人是灵长类动物，但有的人却称自己是人而不是灵长类动物，但是放在动物眼里或许就叫灵长类动物

2013年8月 9日 10:09 |# | 引用

Wei 说：

引用cmoooo的发言：
var_dump(json_decode($json),true);
这一行代码示例有错误，应该为：
var_dump(json_decode($json ,true));

赞同

2013年8月19日 12:24 |# | 引用

阮一峰说：

@cmoooo：

谢谢指出，已经更正了。

2013年8月20日 04:59 |# | 引用

sme 说：

谢谢阮老师，看得博客文章越多，越发现能写出阮老师你这样子深入浅出的文章真的少之又少。

2014年3月18日 18:38 |# | 引用

Janpun 说：

写得非常简单易懂，但是代码好像有点问题，前面的空格都是中文状态下的空格，php中会报错，初学者不太容易发现

2014年4月 8日 11:41 |# | 引用

九明说：

json实际使用比较多，文章浅显易懂

2014年4月10日 14:05 |# | 引用

shrekuu 说：

试了一下，原来这样也可以：echo $obj->{'foo'};
我还以为只能：echo $obj->foo;
呵呵，谢谢了。

2014年6月 3日 10:55 |# | 引用

liyu 说：

javascript也支持关联数组。只不过不能像PHP那样定义在一个语句中。
比如：
var arr = [];
arr["key1"] = 1;
arr["key2"] = 2;

其实js中关联数组和对象的界限比较模糊，都是键值对的集合。

2014年8月 7日 12:28 |# | 引用

计算机的潜意识说：

感谢

2015年1月30日 08:55 |# | 引用

wing 说：

感谢分享，讲的很详细

2015年3月22日 19:53 |# | 引用

tree 说：

好教材

2015年5月13日 17:16 |# | 引用

omind 说：

确实是很好的入门教程，马上可以用json了，哈哈

2015年6月 3日 11:43 |# | 引用

stonex 说：

通俗易懂，尤其是数组和对象部分

2015年6月30日 12:36 |# | 引用

myyc 说：

"json只能用来表示对象（object）和数组（array），如果对一个字符串或数值使用json_decode()，将会返回null。"

这个表述有问题吧？根据rfc4627的说法：
A JSON value MUST be an object, array, number, or string, or one of the following three literal names: false null true

var_dump(json_decode('"Hello World"')); //string(11) "Hello World"
var_dump(json_decode("123")); // int(123)

2015年9月16日 14:35 |# | 引用

愚公说：

引用飞龙的发言：
$arr = Array('one', 'two', 'three'); 请问，这里的 array 为何大写？

官方手册标准写法，你也可以小写。

2015年9月17日 11:37 |# | 引用

Issac 说：

@toobull：

你写的不是json，json对格式是严格要求的，你写的那个是js的object

2016年1月12日 16:57 |# | 引用

T66 说：

默默点个赞！

2016年2月 3日 15:37 |# | 引用

0 0

在PHP语言中使用JSON

在PHP语言中使用JSON

文档信息

相关文章

广告（购买广告位）

留言（38条）