本教程旨在解決Yii2應用中通過Content-Type: application/json發(fā)送POST請求時，後端無法正確接收數(shù)據(jù)的問題。默認情況下，Yii2的請求組件僅解析application/x-www-form-urlencoded等傳統(tǒng)表單數(shù)據(jù)。為確保JSON數(shù)據(jù)被正確識別和處理，開發(fā)者需在Yii2配置文件中為request組件添加yii\web\JsonParser，從而使框架能夠自動解析JSON請求體，並在控制器中順利獲取到提交的數(shù)據(jù)。

問題描述：JSON POST數(shù)據(jù)接收為空

在開發(fā)Web應用時，前後端分離架構中常通過JavaScript的fetch或XMLHttpRequest發(fā)送JSON格式的數(shù)據(jù)。然而，在Yii2框架中，即使前端請求狀態(tài)碼為200，後端控制器中的Yii::$app->request->post()方法也可能無法獲取到預期的JSON數(shù)據(jù)，而是返回空值。

以下是一個典型的JavaScript前端發(fā)送JSON數(shù)據(jù)的示例：

 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, // CSRF 參數(shù)"X-CSRF-Token": csrfToken // CSRF Token
  },
  body: JSON.stringify({
    'id': e.id, // 示例數(shù)據(jù)：id
    'name': this.state.ChangeName // 示例數(shù)據(jù)：name
  })
}).then(response => response.json())
  .then((data) => console.log(data));

對應的Yii2後端控制器代碼可能如下所示：

 public function actionSaveBabysitter() {
    $request = Yii::$app->request;
    $name = $request->post('name'); // 此時$name 變量可能為空// 原始問題中嘗試對空值進行json_decode，導致錯誤// echo json_decode($name); 

    // 實際應是檢查$name 是否已正確接收if (empty($name)) {
        return $this->asJson(['status' => 'error', 'message' => 'Name is empty']);
    } else {
        return $this->asJson(['status' => 'success', 'received_name' => $name]);
    }
}

在這種情況下，儘管HTTP狀態(tài)碼是200，但$request->post('name')卻無法獲取到前端發(fā)送的name值。

根本原因分析

Yii2框架的請求組件yii\web\Request默認情況下，只會解析$_POST全局變量中的數(shù)據(jù)。而Web服務器（如Apache或Nginx）通常只將Content-Type為application/x-www-form-urlencoded或multipart/form-data的請求體數(shù)據(jù)解析到$_POST全局變量中。

當前端使用Content-Type: application/json發(fā)送數(shù)據(jù)時，請求體內(nèi)容是原始的JSON字符串，Web服務器並不會將其自動解析並填充到$_POST中。因此，$_POST保持為空，Yii2的$request->post()方法自然也無法獲取到任何數(shù)據(jù)。

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

為了讓Yii2能夠正確識別並解析application/json類型的請求體，我們需要在Yii2的應用程序配置文件（通常是config/web.php）中，為request組件添加一個JSON解析器。

具體操作是在components數(shù)組下的request配置中，添加parsers屬性，並指定application/json對應的解析器為yii\web\JsonParser。

 // config/web.php
return [
    'id' => 'your-app-id',
    // ... 其他配置...
    'components' => [
        'request' => [
            'cookieValidationKey' => 'your-secret-key', // 請務必設置一個安全的key
            'parsers' => [
                'application/json' => 'yii\web\JsonParser',
                // 如果需要支持其他Content-Type，也可以在此處添加// 'application/xml' => 'yii\web\XmlParser',
            ],
            // ... request 組件的其他配置...
        ],
        // ... 其他組件...
    ],
    // ... 其他配置...
];

通過以上配置，當Yii2接收到Content-Type為application/json的請求時，yii\web\JsonParser會自動介入，將請求體中的JSON字符串解析成PHP數(shù)組或?qū)ο螅瑏K將其填充到Yii::$app->request->bodyParams屬性中。

正確訪問JSON數(shù)據(jù)

配置完成後，在控制器中，您可以像訪問普通POST數(shù)據(jù)一樣，通過Yii::$app->request->post()或Yii::$app->request->getBodyParam()來獲取解析後的JSON數(shù)據(jù)。

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

    // 此時，Yii2已經(jīng)自動解析了JSON請求體// 可以直接通過post() 方法獲取特定參數(shù)$id = $request->post('id'); 
    $name = $request->post('name');

    // 或者通過getBodyParams() 獲取所有解析後的參數(shù)數(shù)組// $data = $request->getBodyParams();
    // $id = $data['id'] ?? null;
    // $name = $data['name'] ?? null;

    if (empty($id) || empty($name)) {
        Yii::error("Received empty data: ID={$id}, Name={$name}", __METHOD__);
        return $this->asJson(['status' => 'error', 'message' => 'ID or Name cannot be empty.']);
    }

    // 示例：處理數(shù)據(jù)並返迴響應// 比如保存到數(shù)據(jù)庫等操作// ...

    return $this->asJson(['status' => 'success', 'received_id' => $id, 'received_name' => $name]);
}

注意事項與總結

1. Content-Type的重要性：前端發(fā)送請求時，務必確保headers中Content-Type設置為application/json，這是後端解析器能夠正確識別和處理JSON數(shù)據(jù)的關鍵。
2. CSRF防護：即使是JSON請求，Yii2的CSRF防護機制依然有效。前端JS代碼中通過csrf-param和X-CSRF-Token發(fā)送CSRF令牌是正確的做法。 Yii2會根據(jù)配置自動驗證這些令牌。
3. 數(shù)據(jù)驗證：即使數(shù)據(jù)成功接收，也務必在後端對接收到的數(shù)據(jù)進行嚴格的驗證和過濾，以防止惡意輸入和安全漏洞。
4. getBodyParams()與post()： Yii::$app->request->post()方法在配置了JSON解析器後，會自動從解析後的bodyParams中查找對應鍵的值。因此，通常情況下直接使用post()方法即可。如果需要獲取所有解析後的參數(shù)數(shù)組，可以使用getBodyParams()。
5. 其他解析器：如果您的應用還需要處理其他非標準表單類型的請求體（如XML），也可以在parsers中配置相應的解析器。

通過上述配置，Yii2應用將能夠無縫地處理前端發(fā)送的JSON格式POST請求，確保數(shù)據(jù)的正確傳輸和處理，從而提升前後端協(xié)作的效率和應用的健壯性。

以上是解決Yii2中JSON POST數(shù)據(jù)接收為空的問題的詳細內(nèi)容。更多資訊請關注PHP中文網(wǎng)其他相關文章！