php输出json怎么用

PHP输出JSON的完整指南：从基础到实战

在Web开发中,JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，因其易读、易解析的特性，已成为前后端数据交互的主流选择，PHP作为后端开发的核心语言之一，经常需要将数据转换为JSON格式并输出给前端，本文将详细介绍PHP输出JSON的多种方法、常见问题及最佳实践，帮助你这一核心技能。

PHP输出JSON的基础方法：`json_encode()`与`echo`

PHP中输出JSON的核心函数是json_encode()，它将PHP变量转换为JSON格式的字符串，结合echo或print即可将JSON数据发送给前端。

基本语法

json_encode()的基本语法如下：

json_encode(mixed $value, int $flags = 0, int $depth = 512): string|false

$value：要转换的PHP变量（数组、对象、字符串、数字等）。
$flags：可选参数，用于控制输出格式（如是否美化JSON、是否转换特殊字符等）。
$depth：可选参数，指定递归转换的最大深度（默认512，足够日常使用）。

示例：将PHP数组转换为JSON并输出

情况1：索引数组

<?php
$phpArray = ["apple", "banana", "orange"];
$jsonString = json_encode($phpArray);
echo $jsonString;
?>

输出：

["apple","banana","orange"]

情况2：关联数组（转换为JSON对象）

<?php
$assocArray = ["name" => "张三", "age" => 25, "city" => "北京"];
$jsonString = json_encode($assocArray);
echo $jsonString;
?>

输出：

{"name":"张三","age":25,"city":"北京"}

情况3：对象转换

<?php
class User {
    public $name;
    public $age;
    public function __construct($name, $age) {
        $this->name = $name;
        $this->age = $age;
    }
}
$user = new User("李四", 30);
$jsonString = json_encode($user);
echo $jsonString;
?>

输出：

{"name":"李四","age":30}

关键点：设置正确的Content-Type头

直接echo JSON字符串时，前端可能无法正确解析数据（例如直接在浏览器访问时显示纯文本），为了让前端识别为JSON格式，需设置HTTP响应头Content-Type: application/json。

正确做法：

<?php
header('Content-Type: application/json; charset=utf-8');
$data = ["status" => "success", "message" => "操作成功"];
echo json_encode($data);
?>

前端收到的响应头会包含Content-Type: application/json，浏览器或JavaScript会自动将其解析为JSON对象。

进阶：控制JSON输出格式

json_encode()的$flags参数提供了丰富的选项，用于调整JSON的输出细节。

美化输出（缩进对齐）

开发调试时,可使用JSON_PRETTY_PRINT参数生成格式化的JSON（带缩进和换行），便于阅读：

<?php
header('Content-Type: application/json; charset=utf-8');
$data = [
    "name" => "王五",
    "hobbies" => ["reading", "swimming", "coding"],
    "info" => ["age" => 28, "city" => "上海"]
];
echo json_encode($data, JSON_PRETTY_PRINT);
?>

输出：

{
    "name": "王五",
    "hobbies": [
        "reading",
        "swimming",
        "coding"
    ],
    "info": {
        "age": 28,
        "city": "上海"
    }
}

注意：JSON_PRETTY_PRINT仅在PHP 5.4.0+中支持，且生产环境中建议关闭（增加数据体积）。

处理中文（避免乱码）

默认情况下,json_encode()会将中文转换为Unicode转义序列（如\u5f20\u4e09），若需保留中文，需设置JSON_UNESCAPED_UNICODE参数：

<?php
header('Content-Type: application/json; charset=utf-8');
$data = ["name" => "张三", "city" => "北京"];
echo json_encode($data, JSON_UNESCAPED_UNICODE);
?>

输出（保留中文）：

{"name":"张三","city":"北京"}

对比（不设置参数）：

{"name":"\u5f20\u4e09","city":"\u5317\u4eac"}

其他常用`$flags`参数

JSON_NUMERIC_CHECK：将数字类型的字符串转为数字（如"123"转为123）。

$data = ["id" => "1001", "price" => "99.99"];
echo json_encode($data, JSON_NUMERIC_CHECK);
// 输出：{"id":1001,"price":99.99}

JSON_FORCE_OBJECT：将索引数组转为对象（避免前端解析时类型混淆）。

$data = ["apple", "banana"];
echo json_encode($data, JSON_FORCE_OBJECT);
// 输出：{"0":"apple","1":"banana"}

JSON_UNESCAPED_SLASHES：不转义斜杠（如路径/api/user保持原样）。

$data = ["url" => "https://example.com/api/test"];
echo json_encode($data, JSON_UNESCAPED_SLASHES);
// 输出：{"url":"https://example.com/api/test"}

错误处理：`json_encode()`失败的常见场景

json_encode()在转换失败时会返回false，需通过json_last_error()和json_last_error_msg()捕获错误原因。

常见错误场景

场景1：转换资源类型（如文件句柄）

$fp = fopen("test.txt", "r");
echo json_encode($fp); // 资源无法转换，返回false

错误信息：Type is not supported（通过json_last_error_msg()获取）。

场景2：递归深度过深

$arr = [];
$arr[0] = &$arr; // 循环引用
echo json_encode($arr, 0, 1); // 深度限制为1，触发错误

错误信息：Maximum stack depth exceeded。

场景3：包含无效的UTF-8字符

$data = ["name" => "\xB1\x01"]; // 非法UTF-8字节
echo json_encode($data); // 返回false

错误信息：Malformed UTF-8 characters（需确保数据为有效UTF-8编码）。

错误处理示例

<?php
header('Content-Type: application/json; charset=utf-8');
function safe_json_encode($data) {
    $json = json_encode($data);
    if (json_last_error() !== JSON_ERROR_NONE) {
        throw new RuntimeException("JSON编码失败: " . json_last_error_msg());
    }
    return $json;
}
try {
    $data = ["name" => "测试", "resource" => fopen("php://memory", "r")];
    echo safe_json_encode($data);
} catch (RuntimeException $e) {
    echo json_encode(["error" => $e->getMessage()]);
}
?>

输出：

{"error":"JSON编码失败: Type is not supported"}

实战案例：构建RESTful API的JSON响应

假设我们需要开发一个用户信息接口,返回用户数据的JSON响应。

模拟数据库查询

<?php
// 模拟从数据库获取用户数据
function getUserById($id) {
    $users = [
        1 => ["id" => 1, "name" => "张三", "email" => "zhangsan@example.com"],
        2 => ["id" => 2, "name" => "李四", "email" => "lisi@example.com"]
    ];
    return $users[$id] ?? null;
}

输出JSON响应

<?php
header('Content-Type: application/json; charset=utf-8');
$userId = $_GET['id'] ?? null;
if (!$userId) {
    echo json_encode(["code" => 400, "message" => "用户ID不能为空"]);
    exit;

正文