首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

PHP 返回 Json 字符串,这2个关键点,你别大意了

引言

很多时候如果手动写 PHP,不使用框架,并且是 API 接口,应该怎么返回json数据呢?离开框架还能不能写应用,这是对一个程序员基本功最好的检验。

本文就说一说在PHP中如何返回json格式的数据。

学习时间

直接上代码,很简短,我们逐行讲解:

$data = ['code' => 1, 'msg' => 'success', 'list' => array()];

header('Content-Type: application/json');

echo json_encode($data);

首先原始数据是 $data,这是一个数组,我们想要做的就是把这个数组,作为序列化的json字符串发送出去。

接着,非常关键,就是一定要设定响应的 header,格式一定是 application/json。

准备停当,最后就是发字符串刷入缓存区,并输出给客户端。其中 json_encode 就是数组的的序列化函数。

如果是英文语种的国家,当然没什么问题。可是,对于支持国际化的应用,我们还是要使用通用的 UTF-8 编码,这样的接口可以走遍世界了 :) 只需要把 header 添加编码声明:

header('Content-type:application/json;charset=utf-8');

光说不练假把式,来个有点实操性质的例子吧:

$option = $_GET['option'];

if ( $option == 1 ) {

$data = [ 'a', 'b', 'c' ];

} else {

$data = [ 'name' => 'God', 'age' => -1 ];

}

header('Content-type: application/json;charset=utf-8');

echo json_encode( $data );

获取输入参数,处理参数,然后声明头部信息,最后输出给客户端,一气呵成。

进阶:错误处理

代码不变,可是数据总是在变,所以不能保证不出错。比如 json_encode 函数完全可能序列化失败而返回 false。那就需要故障处理一下了:

header("Content-Type: application/json;charset=utf-8");

$json = json_encode($data);

if ($json === false) {

$json = json_encode(["jsonError" => json_last_error_msg()]);

if ($json === false) {

$json = '{"jsonError":"unknown"}';

}

http_response_code(500);

}

echo $json;

经过故障捕捉,客户端请求后完全可以拿到故障信息,或者 500 服务器故障码。这样的API友好了许多。

写在最后

本文通过几个示例演示了PHP中如何返回json字符串,成熟的框架大多进行了很好的处理,而且捆绑在 response 响应体内。手动实现有助于我们理解程序的处理过程。

Happy coding :_)

我是 @程序员小助手 ,持续分享编程知识,欢迎关注。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20200629A0RWW100?refer=cp_1026
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群
领券