Yii2处理空JSON数据解析方法

对于一个文章开发者来说，牢固扎实的基础是十分重要的，golang学习网就来带大家一点点的掌握基础知识点。今天本篇文章带大家了解《Yii2 处理 JSON POST 请求：数据为空解决与解析配置》，主要介绍了，希望对大家的知识积累有所帮助，快点收藏起来吧，否则需要时就找不到了！

理解 POST 数据为空的根源

在使用 JavaScript 的 fetch API 或其他前端技术发送 POST 请求时，如果请求头 Content-Type 被设置为 application/json，后端 Yii2 应用默认情况下可能无法通过 Yii::$app->request->post() 或 $_POST 超全局变量获取到数据。

这是因为 Web 服务器（如 Apache, Nginx）在处理 HTTP 请求时，只会自动解析 application/x-www-form-urlencoded 或 multipart/form-data 类型的请求体，并将其填充到 $_POST 变量中。对于 application/json 类型的请求，服务器会将其视为原始请求体（raw body），并不会自动解析为键值对形式。因此，Yii2 默认从 $_POST 获取数据时，自然会发现数据为空。

解决方案：配置 Yii2 的 JSON 解析器

为了让 Yii2 能够正确解析 application/json 类型的请求体，我们需要在应用程序的请求组件中配置 yii\web\JsonParser。这个解析器会读取原始请求体，并将其解析为 PHP 数组或对象，然后 Yii2 就可以通过标准方法（如 Yii::$app->request->post() 或 Yii::$app->request->getBodyParams()）访问这些数据。

1. 配置 web.php

在 Yii2 应用程序的配置文件（通常是 config/web.php）中，找到 components 部分，并修改 request 组件的配置，添加 parsers 属性：

// config/web.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',
            // 如果你的前端也可能发送其他JSON类型，例如 'text/json'，也可以在此添加
            // 'text/json' => 'yii\web\JsonParser',
        ],
        // ... 其他请求组件的配置
    ],
    // ... 其他组件
]

通过上述配置，当 Yii2 接收到 Content-Type 为 application/json 的请求时，它会自动使用 yii\web\JsonParser 来解析请求体。

2. 前端发送 JSON 数据示例

以下是一个使用 JavaScript fetch API 发送 JSON 数据的示例。请注意，这里包含了 Yii2 CSRF 令牌的获取和设置，以确保请求的安全性。

// 获取 CSRF 令牌和参数名
const csrfToken = document.querySelector("meta[name='csrf-token']").content;
const 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",
        [csrfParam]: csrfToken,           // 将 CSRF 参数名作为键，CSRF 令牌作为值
        // "X-CSRF-Token": csrfToken       // 另一种常见的 CSRF 令牌传递方式，Yii2 也支持
    },
    body: JSON.stringify(dataToSend) // 将 JavaScript 对象转换为 JSON 字符串
})
.then(response => {
    if (!response.ok) {
        // 处理 HTTP 错误，例如 404, 500
        throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json(); // 解析 JSON 响应
})
.then((data) => {
    console.log("Success:", data);
})
.catch((error) => {
    console.error("Error during fetch operation:", error);
});

注意：

• headers 中设置 Content-Type: application/json 是关键。
• body 必须是 JSON.stringify() 后的字符串。
• CSRF 令牌的传递方式可能因 Yii2 版本或配置而异，上述示例展示了两种常见方式。

3. 后端控制器中获取数据

配置 JsonParser 后，在 Yii2 控制器中，你可以像获取普通 POST 数据一样，使用 Yii::$app->request->post() 方法来获取解析后的 JSON 数据。如果需要获取所有 POST 参数，不指定键名即可。

// controllers/ReactController.php (假设你的控制器名为 ReactController)

namespace app\controllers;

use Yii;
use yii\web\Controller;
use yii\filters\VerbFilter; // 如果需要限制请求方法

class ReactController extends Controller
{
    // 如果需要禁用 CSRF 验证（不推荐在生产环境禁用，除非你理解风险并有其他安全措施）
    public $enableCsrfValidation = false;

    public function behaviors()
    {
        return [
            'verbs' => [
                'class' => VerbFilter::class,
                'actions' => [
                    'save-babysitter' => ['POST'], // 确保只允许 POST 请求
                ],
            ],
        ];
    }

    public function actionSaveBabysitter()
    {
        $request = Yii::$app->request;

        // 获取整个解析后的 JSON 数据（作为关联数组）
        $data = $request->post();

        // 获取特定字段，例如 'name'
        $name = $request->post('name');
        $id = $request->post('id');

        // 验证数据（重要步骤！）
        if (empty($name) || empty($id)) {
            Yii::$app->response->statusCode = 400; // Bad Request
            return $this->asJson(['success' => false, 'message' => '缺少必要的参数']);
        }

        // 假设这里进行数据处理和保存到数据库
        // ...

        // 返回 JSON 响应
        return $this->asJson([
            'success' => true,
            'message' => '数据接收成功',
            'received_data' => [
                'id' => $id,
                'name' => $name
            ]
        ]);
    }
}

注意事项：

• CSRF 验证： 默认情况下，Yii2 对所有 POST 请求都会进行 CSRF 验证。如果你通过 fetch API 发送 JSON 数据，需要确保在请求头或请求体中正确传递 CSRF 令牌。在上述前端代码中，我们通过 [csrfParam]: csrfToken 在请求头中传递了 CSRF 令牌。如果你的 API 是无状态的或不依赖于会话，并且你理解风险，可以在控制器或模块级别禁用 CSRF 验证（如示例中的 $enableCsrfValidation = false;），但这通常不推荐。
• 数据获取： 配置 JsonParser 后，Yii::$app->request->post() 会自动返回解析后的 JSON 数据。你也可以使用 Yii::$app->request->getBodyParams() 来获取所有请求体参数，或者 Yii::$app->request->getRawBody() 来获取未经解析的原始请求体字符串。
• 数据验证与安全： 即使数据成功接收，也务必在后端进行严格的数据验证、过滤和净化，以防止 SQL 注入、XSS 等安全漏洞。不要直接使用接收到的数据进行数据库操作。
• 错误处理： 在前端和后端都应该有健壮的错误处理机制，以便在请求失败或数据不符合预期时能够及时反馈和调试。

总结

通过在 Yii2 应用程序的 request 组件中配置 yii\web\JsonParser，我们可以轻松解决 application/json 类型 POST 请求数据为空的问题。这使得 Yii2 能够无缝地与现代前端框架（如 React, Vue, Angular）进行数据交互，构建功能强大的前后端分离应用。记住，在处理任何用户输入时，数据验证和安全实践始终是至关重要的。

今天带大家了解了的相关知识，希望对你有所帮助；关于文章的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~