本文深入探討了Yii2 應用在接收application/json 類型POST 請求時數據為空的問題，並提供了詳細的解決方案。通過配置yii\web\Request::$parsers，Yii2 能夠正確解析JSON 請求體，確保後端能順利獲取前端發(fā)送的JSON 數據。文章涵蓋了前端JavaScript 發(fā)送JSON 的示例及後端PHP 處理邏輯。

理解JSON POST 請求與Yii2 的默認行為

在Web 開發(fā)中，前端通常通過POST 請求向後端發(fā)送數據。常見的Content-Type 有application/x-www-form-urlencoded 和multipart/form-data。 Web 服務器（如Apache, Nginx）默認會將這兩種類型的請求體解析，並將數據填充到PHP 的$_POST 全局變量中。因此，Yii2 框架默認也是從$_POST 中讀取POST 參數。

然而，當前端使用fetch 或XMLHttpRequest 發(fā)送Content-Type: application/json 類型的請求時，請求體中的JSON 數據不會被Web 服務器自動解析並填充到$_POST 變量中。這意味著，即使請求成功發(fā)送到後端，Yii2 嘗試通過Yii::$app->request->post('paramName') 獲取參數時，也會因為$_POST 為空而得到null 值。

解決方案：配置Yii2 請求解析器

為了讓Yii2 能夠正確解析application/json 類型的請求體，你需要將JSON 解析器添加到y(tǒng)ii\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', // 請?zhí)鎿Q為你的密鑰'parsers' => [
            'application/json' => 'yii\web\JsonParser',
        ],
        // ... 其他請求組件配置],
    // ... 其他組件配置]

通過上述配置，當Yii2 接收到Content-Type 為application/json 的請求時，它會自動使用yii\web\JsonParser 來解析請求體，並將解析後的數據填充到Yii::$app->request->post() 方法可訪問的內部數據結構中。

前端JavaScript 發(fā)送JSON 請求示例

前端使用fetch API 發(fā)送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 是需要發(fā)送的數據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 => {
    // 檢查響應狀態(tài)碼，如果不是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 令牌：在發(fā)送POST 請求時，為了防止跨站請求偽造(CSRF) 攻擊，Yii2 默認會檢查CSRF 令牌。前端需要從頁面中獲取CSRF 令牌並將其作為請求頭或請求體參數發(fā)送。上述代碼示例中，令牌通過csrf-param 和X-CSRF-Token 頭部發(fā)送。
• 錯誤處理：在fetch 的then 鏈中添加response.ok 檢查和catch 塊，可以更好地處理網絡錯誤和服務器響應錯誤。

後端PHP 控制器處理邏輯

在配置了JsonParser 之後，Yii2 的request 組件就能夠正確解析JSON 請求體了。你現在可以通過Yii::$app->request->post() 方法像獲取普通表單數據一樣獲取JSON 數據中的參數。

 <?php namespace app\controllers;

use Yii;
use yii\web\Controller;
use yii\web\Response; // 引入Response 類class ReactController extends Controller
{
    // 禁用CSRF 驗證（僅用於演示，生產環(huán)境請謹慎）
    // public $enableCsrfValidation = false; 

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

        // 設置響應格式為JSON
        Yii::$app->response->format = Response::FORMAT_JSON;

        // 獲取解析後的JSON 數據// 如果前端發(fā)送的是{"id": 123, "name": "Test"}
        $id = $request->post('id');
        $name = $request->post('name');

        // 也可以獲取所有POST 參數為一個數組// $postData = $request->post(); 

        // 生產環(huán)境中，通常需要對接收到的數據進行驗證和處理if (empty($id) || empty($name)) {
            return [
                'status' => 'error',
                'message' => 'ID 或Name 不能為空。 ',
            ];
        }

        // 假設這裡進行數據保存或其他業(yè)務邏輯// 例如：$model = new Babysitter(['id' => $id, 'name' => $name]); $model->save();

        // 返回成功響應return [
            'status' => 'success',
            'message' => '數據接收成功！ ',
            'received_id' => $id,
            'received_name' => $name,
            // 可以在這裡返回更多處理結果];
    }
}

重要提示：

• CSRF 驗證：如果你的控制器或單個action 開啟了CSRF 驗證（Yii2 默認開啟），請確保前端正確發(fā)送了CSRF 令牌。如果前端無法發(fā)送令牌或你確定不需要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 能夠無縫地處理前端發(fā)送的JSON 數據，極大地簡化了前後端數據交互的複雜性。在實際開發(fā)中，除了正確配置解析器，還應注意CSRF 保護、數據驗證和規(guī)範的錯誤處理，以構建健壯和安全的Web 應用程序。

以上是Yii2 中處理 JSON POST 請求：配置與實踐的詳細內容。更多資訊請關注PHP中文網其他相關文章！