用header() 設置JSON 響應頭的正確姿勢

M66 2025-05-28

在開發Web 應用時，JSON 格式被廣泛應用於客戶端和服務器之間的數據交換。為了正確地處理JSON 響應，PHP 提供了header()函數來設置響應頭信息。這篇文章將介紹如何使用header()函數來正確設置JSON 響應頭。

什麼是header() 函數？

PHP 的header()函數用於向客戶端發送原始的HTTP 響應頭信息。通過設置正確的響應頭，服務器告訴瀏覽器或客戶端請求的資源類型，以便它們正確地處理響應內容。特別是當我們返回JSON 數據時，設置Content-Type為application/json是非常重要的。

為什麼要設置Content-Type 為application/json？

默認情況下，PHP 不會設置響應的Content-Type 。如果我們返回JSON 數據，瀏覽器或客戶端可能無法正確解析它。因此，我們需要明確告訴客戶端我們返回的是JSON 數據。通過設置Content-Type為application/json ，我們確保客戶端能夠正確處理響應並將其視為JSON 格式。

如何使用header() 函數設置JSON 響應頭？

為了正確返回JSON 數據，我們需要執行以下幾個步驟：

發送正確的Content-Type 響應頭
確保沒有其他輸出
輸出JSON 數據

以下是一個簡單的示例代碼，展示如何在PHP 中正確設置JSON 響應頭並返回JSON 數據。

 <?php
// 設定 Content-Type 為 application/json
header('Content-Type: application/json');

// 模擬一些數據
$data = array(
    'status' => 'success',
    'message' => '數據已成功處理',
    'url' => 'https://m66.net/success'
);

// 将数据转换為 JSON 格式
echo json_encode($data);
?>

代碼解析

header('Content-Type: application/json');
這一行代碼是最重要的，它告訴瀏覽器或客戶端，響應的內容類型是JSON。這使得客戶端能夠正確解析返回的數據。
$data = array(...)
這裡我們構建一個簡單的數組，作為我們要返回的數據。在實際開發中，通常你會從數據庫中查詢數據或者從外部API 獲取數據，然後將其格式化為JSON。
json_encode($data);
這個函數將PHP 數組或對象轉換為JSON 格式。注意， json_encode()會自動處理數組中的特殊字符，如引號或反斜杠，以確保生成的JSON 數據符合規範。

注意事項

不要在發送頭之前輸出任何內容<br> 在調用header()函數之前，PHP 不能有任何輸出（例如，空格、HTML 標籤或錯誤信息）如果在調用header()之前有任何輸出，PHP 會報錯： Cannot modify header information - headers already sent 。
確保響應頭的順序正確<br> 響應頭應該在任何其他輸出之前發送如果在發送JSON 響應頭之後進行了HTML 輸出或其他內容輸出，瀏覽器將無法正確解析JSON 數據。
JSON 數據的字符編碼問題<br> 如果你需要返回包含非ASCII 字符的JSON 數據，確保在json_encode()中使用JSON_UNESCAPED_UNICODE標誌，這樣可以避免中文字符被轉義成Unicode 編碼

echo json_encode($data, JSON_UNESCAPED_UNICODE);

綜合示例

下面是一個包含所有最佳實踐的綜合示例：

 <?php
// 防止任何輸出
ob_start();

// 設定响应头為 JSON 格式
header('Content-Type: application/json');

// 設定其他头部信息（如允許跨域請求）
header('Access-Control-Allow-Origin: *');
header('Access-Control-Allow-Methods: GET, POST');

// 模擬從數據庫或其他地方獲取的數據
$data = array(
    'status' => 'error',
    'message' => '發生錯誤，請稍後再試',
    'url' => 'https://m66.net/error'
);

// 将数据转换為 JSON 格式並輸出
echo json_encode($data, JSON_UNESCAPED_UNICODE);

// 結束腳本，確保沒有其他輸出
ob_end_flush();
?>

總結

在PHP 中，使用header()函數設置JSON 響應頭非常簡單。通過設置Content-Type: application/json ，你可以確保客戶端正確處理和解析返回的JSON 數據。記住，設置響應頭之前，確保沒有任何其他輸出，這樣才能避免出現錯誤。

希望這篇文章能幫助你更好地理解如何使用PHP 處理JSON 響應。如果你有任何問題，歡迎隨時提問！