Yii2 中處理 JSON POST 請求：解決數據為空問題及解析配置指南

本文旨在解決Yii2 框架在接收application/json 類型的POST 請求時，$_POST 變量為空的問題。核心在於理解Web 服務器對不同內容類型的處理方式，並指導開發者通過配置yii\web\JsonParser 來啟用Yii2 對JSON 請求體的自動解析。文章將提供詳細的配置示例、前端JSON 發送代碼以及後端數據獲取方法，確保Yii2 應用能正確處理和利用JSON 格式的傳入數據。

理解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）進行數據交互，構建功能強大的前後端分離應用。記住，在處理任何用戶輸入時，數據驗證和安全實踐始終是至關重要的。

以上是Yii2 中處理 JSON POST 請求：解決數據為空問題及解析配置指南的詳細內容。更多資訊請關注PHP中文網其他相關文章！