萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP require/include 載入 UTF-8 文件產生 BOM 空行問題解決

在 Windows 環境下使用記事本等編輯器將 PHP 文件保存為 UTF-8 格式時,文件頭部會自動添加 3 個字節的 BOM(Byte Order Mark,EF BB BF)。當使用 require/include 載入此類文件時,BOM 會作為輸出內容被發送到瀏覽器,導致:

  • 頁面頂部出現不可見的空白行
  • header()、session_start()、setcookie() 失效(「Headers already sent」錯誤)
  • XML/JSON 輸出解析失敗

問題根因

BOM 旨在標識 UTF-8 字節序,但 PHP 解析器不會自動忽略 它。當文件被 require 載入時,BOM 被視為腳本輸出的一部分,提前發送了 HTTP 體內容,導致後續頭部函數失效。

解決方案

方案一:使用專業編輯器保存為「UTF-8 無 BOM」(推薦)

  • VS Code:右下角編碼欄位點擊 → 「以編碼保存」→ 選「UTF-8」(非 UTF-8 with BOM)
  • PhpStorm / IntelliJ:File → File Encoding → UTF-8,取消「Add BOM」
  • Notepad++:編碼 → 轉為 UTF-8 (無 BOM)
  • Sublime Text:File → Save with Encoding → UTF-8
  • EditPlus:文件 → 另存為 → 編碼選 UTF-8(無 BOM)

方案二:Dreamweaver 設置

Ctrl+J 打開頁面屬性 → 「標題/編碼」→ 取消勾選「包含 Unicode 簽名 (BOM)」。

方案三:腳本自動清理(批量處理現有文件)

<?php
// remove_bom.php - 遞歸清理目錄下所有 PHP 文件的 BOM
$dir = __DIR__;
$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir));

foreach ($iterator as $file) {
    if ($file->isFile() && $file->getExtension() === 'php') {
        $content = file_get_contents($file->getPathname());
        if (substr($content, 0, 3) === "\xEF\xBB\xBF") {
            $content = substr($content, 3);
            file_put_contents($file->getPathname(), $content);
            echo "已清理 BOM: {$file->getPathname()}
"; } } } echo "處理完成"; ?>

方案四:運行時忽略(治標不治本)

在入口文件最開頭(<?php 之前無任何字符)添加:

<?php
// 必須是文件的絕對第一行,前面連空行都不能有
if (function_exists('zend_optimizer')) {
    // 某些優化器可能干擾
}
ob_start(); // 開啟輸出緩衝,將 BOM 暫存緩衝區
// ... 後續代碼
ob_end_flush(); // 最後輸出
?>

但這只能緩解症狀,**強烈建議從源頭(編輯器保存設置)徹底解決**。

驗證文件是否含 BOM

  • Linux/Mac:hexdump -C file.php | head -5 查看開頭是否 ef bb bf
  • Notepad++:底部狀態欄顯示「UTF-8-BOM」或「UTF-8」
  • PHP 檢測:var_dump(substr(file_get_contents('file.php'), 0, 3) === "\xEF\xBB\xBF")

最佳實踐總結

  1. 團隊統一編輯器設置:在 .editorconfig 或項目規範中強制 charset = utf-8、insert_final_newline = true、無 BOM
  2. CI/CD 集成檢查:提交鉤子或流水線掃描 BOM,阻止合入
  3. 新建文件模板:IDE 設置默認無 BOM 模板
  4. 避免使用 Windows 記事本 編輯 PHP 文件

結語

BOM 空行問題是 PHP 開發者從 Windows 遷移到 Linux 部署時的經典坑。「編輯器保存為 UTF-8 無 BOM」是唯一徹底解法。養成良好的編碼習慣,配合自動化檢查,讓「Headers already sent」成為歷史。

copyright © 萬盛學電腦網 all rights reserved