PHP 使用 JSON
目前,JSON 已经成为最流行的数据交换格式之一,各大网站的 API 几乎都支持它。
《数据类型和 JSON 格式》,探讨它的设计思想;总结一下 PHP 语言对它的支持,这是开发互联网应用程序(特别是编写 API)必须了解的知识。
从 5.2 版本开始,PHP 原生提供 json_encode()
和 json_decode()
函数,前者用于编码,后者用于解码。
json_ encode()
该函数主要用来将数组和对象,转换为 JSON 格式
数组转换
1 | $arr = array ('a'=>1,'b'=>2,'c'=>3,'d'=>4,'e'=>5); |
结果为:{"a":1,"b":2,"c":3,"d":4,"e":5}
对象转换
1 | $obj->body = 'another post'; |
结果为1
2
3
4
5
6
7{
"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)转为对象格式。
索引数组
1 | $arr = Array('one', 'two', 'three'); |
结果为:["one","two","three"]
关联数组
1 | $arr = Array('1'=>'one', '2'=>'two', '3'=>'three'); |
结果就变了:{"1":"one","2":"two","3":"three"}
注意,数据格式从”[]”(数组)变成了”{}”(对象);如果需要将”索引数组”强制转化成”对象”,可以这样写1
2
3json_encode( (object)$arr );
//或者
json_encode ( $arr, JSON_FORCE_OBJECT );
类(class)的转换
下面是一个 PHP 的类1
2
3
4
5
6
7
8
9class 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 转换1
2
3$foo = new Foo;
$foo_json = json_encode($ foo);
echo $foo_json;
输出结果是:{"public_ex":"this is public"}
可以看到,除了公开变量(public),其他东西(常量、私有变量、方法等等)都遗失了。
json_ decode()
该函数用于将 JSON 文本转换为相应的 PHP 数据结构1
2
3$json = '{"foo": 12345}';
$obj = json_decode($ json);
print $obj->{'foo'}; // 12345
通常情况下,json_decode()
总是返回一个 PHP 对象,而不是数组1
2$json = '{"a":1,"b":2,"c":3,"d":4,"e":5}';
var_dump(json_decode($json));
结果就是生成一个 PHP 对象1
2
3
4
5
6
7object(stdClass)#1 (5) {
["a"] => int(1)
["b"] => int(2)
["c"] => int(3)
["d"] => int(4)
["e"] => int(5)
}
如果想要强制生成 PHP 关联数组,json_decode()
需要加一个参数 true:1
2$json = '{"a":1,"b":2,"c":3,"d":4,"e":5}';
var_dump(json_decode($json,true));
结果就生成了一个关联数组1
2
3
4
5
6
7array(5) {
["a"] => int(1)
["b"] => int(2)
["c"] => int(3)
["d"] => int(4)
["e"] => int(5)
}
json_ decode () 的常见错误
下面三种 JSON 写法都是错的,你能看出错在哪里吗?1
2
3$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()
,将会返回 null1
var_dump(json_decode("Hello World")); //null
解析 JSON 文件并遍历
解析 JSON 文件并进行遍历打印,以此制作一个不需要数据库支持的网址导航页面。
JSON 文件格式:site.json1
2
3
4
5
6
7
8
9
10
11
12
13[{
"title": "网站",
"list": [
{
"name": "Inoreader",
"url": "https://www.inoreader.com/"
},
{
"name": "Instapaper",
"url": "https://www.instapaper.com/"
}
]
}]
解析
使用 file_get_contents()
函数加载 JSON 文件,json_decode()
函数进行编码1
2
3
4$file = "site.json";
$json_str = file_get_contents($file);
$json=json_decode($json_str,true); //对 JSON 文件进行编码,当参数为 TRUE 时,将返回 array 而非 object;可通过 print_r($json) 测试不同效果。
if (!is_array($json)) die('数据读取失败,文件不存在或者格式不正确'); //判断编码是否成功
遍历
使用 for 循环,需要设置循环变量;以下用数组的长度,用 sizeof()
函数1
2
3
4
5
6
7
8
9$x=sizeof($json); //获取数组的长度,以此进行循环遍历。
for($i=0;$i< $x;$i++){
echo $json[$i]['title'];
$y=sizeof($json[$i]['list']);//获取当前数组下子数组的长度,以此进行循环遍历。
for($j=0;$j< $y;$j++){
echo $json[$i]['list'][$j]['url'];
echo $json[$i]['list'][$j]['name'];
};
};