3分钟短文 | PHP 返回 Json 字符串，这2个关键点，你别大意了

程序员小助手

发布于 2020-07-02 14:45:13

6590

发布于 2020-07-02 14:45:13

文章被收录于专栏：程序员小助手

引言

很多时候如果手动写 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友好了许多。