Yii2接收JSONPOST数据的正确方法

一分耕耘，一分收获！既然都打开这篇《Yii2 处理 JSON POST 请求方法》，就坚持看下去，学下去吧！本文主要会给大家讲到等等知识点，如果大家对本文有好的建议或者看到有不足之处，非常欢迎大家积极提出！在后续文章我会继续更新文章相关的内容，希望对大家都有所帮助！

理解 JSON POST 请求与 Yii2 的默认行为

在 Web 开发中，前端通常通过 POST 请求向后端发送数据。常见的 Content-Type 有 application/x-www-form-urlencoded 和 multipart/form-data。Web 服务器（如 Apache, Nginx）默认会将这两种类型的请求体解析，并将数据填充到 PHP 的 $_POST 全局变量中。因此，Yii2 框架默认也是从 $_POST 中读取 POST 参数。

然而，当前端使用 fetch 或 XMLHttpRequest 发送 Content-Type: application/json 类型的请求时，请求体中的 JSON 数据不会被 Web 服务器自动解析并填充到 $_POST 变量中。这意味着，即使请求成功发送到后端，Yii2 尝试通过 Yii::$app->request->post('paramName') 获取参数时，也会因为 $_POST 为空而得到 null 值。

解决方案：配置 Yii2 请求解析器

为了让 Yii2 能够正确解析 application/json 类型的请求体，你需要将 JSON 解析器添加到 yii\web\Request::$parsers 属性中。这通常在你的应用程序配置文件（例如 config/web.php 或 config/main.php）中完成。

在 components 数组中找到 request 组件的配置，并添加 parsers 属性：

// config/web.php 或 config/main.php

'components' => [
    'request' => [
        // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
        'cookieValidationKey' => 'your-secret-key', // 请替换为你的密钥
        'parsers' => [
            'application/json' => 'yii\web\JsonParser',
        ],
        // ... 其他请求组件配置
    ],
    // ... 其他组件配置
]

通过上述配置，当 Yii2 接收到 Content-Type 为 application/json 的请求时，它会自动使用 yii\web\JsonParser 来解析请求体，并将解析后的数据填充到 Yii::$app->request->post() 方法可访问的内部数据结构中。

前端 JavaScript 发送 JSON 请求示例

前端使用 fetch API 发送 JSON 数据的示例代码如下。请注意 headers 中 Content-Type: application/json 的设置，以及 body 中使用 JSON.stringify() 将 JavaScript 对象转换为 JSON 字符串。

let csrfToken = document.querySelector("meta[name='csrf-token']").content;
let csrfParam = document.querySelector("meta[name='csrf-param']").content;

// 假设 e.id 和 this.state.ChangeName 是需要发送的数据
const dataToSend = {
    'id': e.id,
    'name': this.state.ChangeName
};

fetch("http://site.se/react/save-babysitter", {
    method: "POST",
    headers: {
        "Content-Type": "application/json", // 关键：指定内容类型为 JSON
        "Accept": "application/json",
        // Yii2 CSRF 令牌，确保请求安全
        [csrfParam]: csrfToken, // 使用中括号语法，因为 csrfParam 是变量
        "X-CSRF-Token": csrfToken // 兼容性考虑，通常 Yii2 会检查其中一个
    },
    body: JSON.stringify(dataToSend) // 将 JavaScript 对象转换为 JSON 字符串
})
.then(response => {
    // 检查响应状态码，如果不是 2xx，则抛出错误
    if (!response.ok) {
        throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json(); // 解析 JSON 响应
})
.then((data) => {
    console.log("Success:", data);
})
.catch((error) => {
    console.error("Error:", error);
});

注意事项：

• CSRF 令牌： 在发送 POST 请求时，为了防止跨站请求伪造 (CSRF) 攻击，Yii2 默认会检查 CSRF 令牌。前端需要从页面中获取 CSRF 令牌并将其作为请求头或请求体参数发送。上述代码示例中，令牌通过 csrf-param 和 X-CSRF-Token 头部发送。
• 错误处理： 在 fetch 的 then 链中添加 response.ok 检查和 catch 块，可以更好地处理网络错误和服务器响应错误。

后端 PHP 控制器处理逻辑

在配置了 JsonParser 之后，Yii2 的 request 组件就能够正确解析 JSON 请求体了。你现在可以通过 Yii::$app->request->post() 方法像获取普通表单数据一样获取 JSON 数据中的参数。

request;

        // 设置响应格式为 JSON
        Yii::$app->response->format = Response::FORMAT_JSON;

        // 获取解析后的 JSON 数据
        // 如果前端发送的是 {"id": 123, "name": "Test"}
        $id = $request->post('id');
        $name = $request->post('name');

        // 也可以获取所有 POST 参数为一个数组
        // $postData = $request->post(); 

        // 生产环境中，通常需要对接收到的数据进行验证和处理
        if (empty($id) || empty($name)) {
            return [
                'status' => 'error',
                'message' => 'ID 或 Name 不能为空。',
            ];
        }

        // 假设这里进行数据保存或其他业务逻辑
        // 例如：$model = new Babysitter(['id' => $id, 'name' => $name]); $model->save();

        // 返回成功响应
        return [
            'status' => 'success',
            'message' => '数据接收成功！',
            'received_id' => $id,
            'received_name' => $name,
            // 可以在这里返回更多处理结果
        ];
    }
}

重要提示：

• CSRF 验证： 如果你的控制器或单个 action 开启了 CSRF 验证（Yii2 默认开启），请确保前端正确发送了 CSRF 令牌。如果前端无法发送令牌或你确定不需要 CSRF 保护（例如，对于仅供内部 API 调用的接口），你可以在控制器中设置 $enableCsrfValidation = false; 或在 action 中通过行为配置禁用。但请务必了解禁用 CSRF 验证可能带来的安全风险。
• getRawBody()： 如果你需要获取原始的 JSON 字符串而不是解析后的数据，可以使用 Yii::$app->request->getRawBody() 方法。这在某些需要手动解析或记录原始请求体的场景中非常有用。
• 响应格式： 在 Yii2 中，为了返回 JSON 格式的响应，建议设置 Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;，然后直接返回一个 PHP 数组或对象，Yii2 会自动将其编码为 JSON 字符串。

总结

通过在 Yii2 应用程序的 request 组件中配置 yii\web\JsonParser，我们可以轻松地解决后端无法接收 application/json 类型 POST 请求数据的问题。这一配置使得 Yii2 能够无缝地处理前端发送的 JSON 数据，极大地简化了前后端数据交互的复杂性。在实际开发中，除了正确配置解析器，还应注意 CSRF 保护、数据验证和规范的错误处理，以构建健壮和安全的 Web 应用程序。

终于介绍完啦！小伙伴们，这篇关于《Yii2接收JSONPOST数据的正确方法》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识，快来关注吧！