如何使用php返回的json

如何使用PHP返回的JSON：从基础到实践的完整指南

在Web开发中,JSON（JavaScript Object Notation）已成为前后端数据交换的主流格式，PHP作为后端开发的核心语言之一，经常需要将数据封装为JSON格式返回给前端（如JavaScript、移动端等），本文将详细介绍PHP返回JSON的正确方法、常见问题及最佳实践，帮助你高效实现前后端数据交互。

PHP返回JSON的基础方法：`json_encode()`与`header()`

PHP提供了内置函数json_encode()，可将PHP变量（数组、对象等）转换为JSON字符串，但仅调用json_encode()是不够的——还需要通过header()设置正确的HTTP头信息，告诉前端返回的是JSON数据，避免前端解析错误。

核心函数：`json_encode()`

json_encode()用于将PHP值转换为JSON格式，其基本语法为：

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

$value：要转换的PHP变量（通常为数组或对象）。
$options：可选配置参数（如JSON_UNESCAPED_UNICODE避免中文乱码，JSON_PRETTY_PRINT格式化输出）。
$depth：指定递归深度（默认512，通常无需修改）。

示例：返回简单JSON

<?php
$data = [
    "name" => "张三",
    "age" => 25,
    "is_student" => false
];
// 将PHP数组转为JSON字符串
$jsonStr = json_encode($data);
// 设置HTTP头信息，指定返回JSON格式
header('Content-Type: application/json; charset=utf-8');
// 输出JSON字符串
echo $jsonStr;
?>

执行后,浏览器或客户端会收到如下JSON数据：

{"name":"张三","age":25,"is_student":false}

必须设置HTTP头：`Content-Type: application/json`

前端（如JavaScript的fetch()、axios）通过HTTP头中的Content-Type判断响应类型，若未设置application/json，前端可能会将响应当作普通文本解析，导致无法正确解析JSON数据。

常见错误示例：

<?php
$data = ["status" => "success"];
echo json_encode($data); // 未设置Content-Type，前端可能解析失败
?>

正确做法：在输出JSON前，务必调用header()设置头信息：

header('Content-Type: application/json; charset=utf-8');
echo json_encode($data);

处理`json_encode()`的常见问题

中文乱码：使用`JSON_UNESCAPED_UNICODE`

json_encode()默认会对非ASCII字符（如中文）进行转义（如\u4e2d\u6587），导致前端显示乱码，通过JSON_UNESCAPED_UNICODE选项可避免转义，保留原始字符。

示例：

<?php
$data = ["message" => "你好，世界"];
// 默认转义（输出：{"message":"\u4f60\u597d\uff0c\u4e16\u754c"}）
echo json_encode($data);
// 不转义中文（输出：{"message":"你好，世界"}）
echo json_encode($data, JSON_UNESCAPED_UNICODE);
?>

推荐做法：始终添加JSON_UNESCAPED_UNICODE，确保中文正常显示：

header('Content-Type: application/json; charset=utf-8');
echo json_encode($data, JSON_UNESCAPED_UNICODE);

数据类型问题：`JSON_NUMERIC_CHECK`

PHP中数字可能是字符串（如"123"）或整数（123），但JSON中数字类型统一为number，若希望PHP中的数字字符串（如数据库查询的ID）被编码为JSON数字，可使用JSON_NUMERIC_CHECK。

示例：

<?php
$data = ["id" => "100", "price" => "99.99"];
// 默认输出：{"id":"100","price":"99.99"}（字符串类型）
echo json_encode($data);
// 强制转为数字：{"id":100,"price":99.99}
echo json_encode($data, JSON_NUMERIC_CHECK);
?>

注意：仅对明确需要数字类型的字段使用，避免意外将字符串转为数字（如手机号"13800138000"不应转为数字）。

处理特殊字符：`JSON_UNESCAPED_SLASHES`与`JSON_HEX_TAG`

若数据中包含斜杠（）或HTML标签，json_encode()默认会转义斜杠（\/），通过JSON_UNESCAPED_SLASHES可保留原始斜杠；JSON_HEX_TAG可将<、>转为\u003c、\u003e，防止XSS攻击。

示例：

<?php
$data = ["path" => "/api/user/1", "html" => "<script>alert(1)</script>"];
// 保留斜杠，HTML标签转义
echo json_encode($data, JSON_UNESCAPED_SLASHES | JSON_HEX_TAG);
?>

输出：

{"path":"/api/user/1","html":"\u003cscript\u003ealert(1)\u003c/script\u003e}

PHP返回JSON的最佳实践

统一API响应格式

实际项目中,API通常需要统一的响应结构（如包含状态码、消息、数据），便于前端统一处理。

{
    "code": 200,
    "message": "success",
    "data": {"name": "张三", "age": 25}
}

封装响应函数：

<?php
function jsonResponse($data, $code = 200, $message = 'success') {
    header('Content-Type: application/json; charset=utf-8');
    $response = [
        'code' => $code,
        'message' => $message,
        'data' => $data
    ];
    echo json_encode($response, JSON_UNESCAPED_UNICODE);
    exit; // 终止脚本，避免额外输出
}
// 使用示例
jsonResponse(['name' => '李四'], 200, '获取用户成功');
?>

错误处理：返回HTTP状态码与错误信息

API调用失败时,需返回明确的错误状态码（如400、404、500）和错误信息，帮助前端定位问题。

示例：

<?php
if (empty($_GET['id'])) {
    http_response_code(400); // 设置HTTP状态码
    jsonResponse(null, 400, '参数ID不能为空');
}
// 正常逻辑
$user = getUserById($_GET['id']);
jsonResponse($user, 200, '获取用户成功');
?>

调试：`JSON_PRETTY_PRINT`格式化输出

开发阶段,使用JSON_PRETTY_PRINT可格式化JSON输出（缩进、换行），便于调试：

<?php
$data = ["name" => "王五", "hobbies" => ["reading", "coding"]];
// 格式化输出（缩进4空格）
echo json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
?>

输出：

{
    "name": "王五",
    "hobbies": [
        "reading",
        "coding"
    ]
}

注意：生产环境中移除JSON_PRETTY_PRINT，避免增加响应体积。

处理复杂对象：转换为数组或实现`JsonSerializable`

PHP对象直接通过json_encode()序列化时，只会输出公共属性，若需自定义序列化逻辑（如过滤敏感字段、关联数据），可实现JsonSerializable接口。

示例：

<?php
class User implements JsonSerializable {
    private $id;
    private $password; // 敏感字段，不希望输出
    public function __construct($id, $password) {
        $this->id = $id;
        $this->password = $password;
    }
    // 实现JsonSerializable接口的jsonSerialize方法
    public function jsonSerialize() {
        return [
            'id' => $this->id,
            'username' => 'user_' . $this->id // 自定义输出字段
        ];
    }
}
$user = new User(1, '123456');
header('Content-Type: application/json; charset=utf-8');
echo json_encode($user, JSON_UNESCAPED_UNICODE);
?>

输出：

{"id":1,"username":"user_1"}

敏感字段password被自动过滤。

前端如何接收PHP返回的JSON

JavaScript的`fetch()` API

fetch('https://example.com/api/user')
    .then(response => response.json()) // 解析JSON响应
    .then

正文

如何使用php返回的json