Yii2接收JSON格式POST请求的正确方法

在现代Web开发中，前后端分离架构日益普及，前端通过异步JavaScript（如fetch或axios）以JSON格式发送数据到后端API接口已成为标准实践。然而，在使用Yii2框架作为后端时，开发者可能会遇到一个常见问题：即使前端成功发送了Content-Type: application/json类型的POST请求，后端通过Yii::$app->request->post()方法却无法获取到任何数据，返回结果为null或空。

问题现象与根源分析

当前端使用fetch API并设置Content-Type为application/json时，请求体中的数据会以原始JSON字符串的形式发送。例如：

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

fetch("http://site.se/react/save-babysitter", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "csrf-param": csrfParam, // Yii2 CSRF参数
    "X-CSRF-Token": csrfToken // Yii2 CSRF令牌
  },
  body: JSON.stringify({
    'id': 123,
    'name': 'Test Name'
  })
}).then(response => response.json())
  .then((data) => console.log(data));

在Yii2后端，如果尝试直接通过Yii::$app->request->post('name')或Yii::$app->request->post()来获取数据，可能会发现结果为空：

public function actionSaveBabysitter()
{
    $request = Yii::$app->request;
    $postData = $request->post('name'); // 此时 $postData 将为 null

    // 如果尝试获取所有POST数据
    // $allPostData = $request->post(); // 此时 $allPostData 将为空数组

    echo json_encode(['received_data' => $postData]);
    Yii::$app->end();
}

出现此问题的原因在于，Web服务器（如Apache或Nginx）默认只会解析application/x-www-form-urlencoded或multipart/form-data这两种内容类型的请求体，并将解析后的数据填充到PHP的$_POST全局变量中。对于application/json类型的请求，请求体内容不会被自动解析到$_POST。Yii2的request组件在默认情况下，其post()方法主要依赖于$_POST或其内部配置的解析器。由于没有默认的JSON解析器，因此无法从原始请求体中提取JSON数据。

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

为了让Yii2能够自动解析application/json类型的请求体，并使其数据可以通过Yii::$app->request->post()方法访问，我们需要在Yii2应用的配置中（通常是config/web.php或config/main.php）为request组件添加一个JSON解析器。

在components配置项下，找到或添加request组件的配置，并在其内部添加parsers属性：

// config/web.php 或 config/main.php
return [
    'components' => [
        'request' => [
            // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
            'cookieValidationKey' => 'your-secret-key',
            'enableCsrfValidation' => true, // 确保CSRF验证开启
            'parsers' => [
                'application/json' => 'yii\web\JsonParser',
                // 如果还需要处理XML或其他类型，也可以在此处添加
                // 'application/xml' => 'yii\web\XmlParser',
            ],
            // ... 其他 request 组件的配置
        ],
        // ... 其他组件配置
    ],
    // ... 其他顶级配置
];

通过以上配置，Yii2的request组件在接收到Content-Type为application/json的请求时，会自动调用yii\web\JsonParser来解析请求体中的JSON字符串。解析后的数据将可以直接通过Yii::$app->request->post()方法访问。

后端正确获取JSON数据

配置JsonParser后，您的控制器代码可以像处理普通POST请求一样，通过Yii::$app->request->post()方法来获取JSON数据：

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

    // 获取所有解析后的POST数据
    $allPostData = $request->post();

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

    // 可以在此处对 $allPostData, $name, $id 进行业务逻辑处理
    // 例如：保存到数据库，验证数据等

    // 返回响应
    if ($name && $id) {
        return $this->asJson([
            'status' => 'success',
            'message' => 'Data received successfully!',
            'received_id' => $id,
            'received_name' => $name
        ]);
    } else {
        return $this->asJson([
            'status' => 'error',
            'message' => 'Missing required data.'
        ]);
    }
}

注意事项

1. CSRF 令牌: 前端发送JSON数据时，如果Yii2开启了CSRF验证（enableCsrfValidation设置为true），务必确保在请求头中包含CSRF令牌。通常通过X-CSRF-Token和csrf-param头来传递，如前端代码示例所示。
2. 数据访问方式: 配置JsonParser后，Yii::$app->request->post()方法会自动返回解析后的JSON数据。无需再手动使用file_get_contents('php://input')和json_decode()来获取原始请求体。
3. 错误处理与数据验证: 即使数据被成功解析，仍需在控制器中对接收到的数据进行必要的验证和过滤，以确保数据的有效性和安全性。
4. Content-Type 的准确性: 前端发送请求时，Content-Type头必须准确设置为application/json，否则JsonParser将不会被触发。

总结

通过在Yii2应用配置中为request组件添加yii\web\JsonParser，可以优雅地解决前端以application/json格式发送POST请求时后端无法获取数据的问题。这使得Yii2能够无缝地与现代前端框架和API交互，提升开发效率和代码的可维护性。正确配置解析器并结合适当的CSRF处理，是构建健壮Yii2 API接口的关键一步。