萬盛學電腦網

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

PHP 取得相對網域根目錄路徑:baseUrl 生成最佳實踐

在 Web 應用中,正確產生站內連結、資源路徑 (CSS/JS/圖片)、AJAX 端點 URL,都需要可靠的「基礎 URL」 (baseUrl)。本文分析 $_SERVER 相關變數,提供健壯的 baseUrl 取得方案,並對比 Zend Framework 的實作差異。

關鍵 $_SERVER 變數解析

變數含義範例 (https://example.com/dev/app/index.php/api/user)
SCRIPT_NAME當前執行腳本相對文檔根目錄路徑/dev/app/index.php
SCRIPT_FILENAME當前執行腳本絕對檔案路徑/var/www/html/dev/app/index.php
REQUEST_URI完整請求 URI (含查詢字串)/dev/app/index.php/api/user?foo=bar
PHP_SELF同 SCRIPT_NAME (但可能被竄改)/dev/app/index.php
DOCUMENT_ROOTWeb 伺服器文檔根目錄/var/www/html

標準 baseUrl 取得函數

<?php
/**
 * 取得相對網域根目錄的基礎路徑 (不含尾端斜線)
 * 例:/dev/app 或 / (若安裝於根目錄)
 */
function getBaseUrl(): string {
    $scriptName = $_SERVER['SCRIPT_NAME'] ?? '';
    if ($scriptName === '') return '/';
    
    // 取得目錄部分:/dev/app/index.php → /dev/app
    $dir = dirname($scriptName);
    
    // 統一斜線方向 (Windows dirname 可能回傳 \)
    $dir = str_replace('\\', '/', $dir);
    
    // 正規化:空字串→根目錄、移除首尾斜線後加回首斜線
    $baseUrl = '/' . trim($dir, '/');
    
    return $baseUrl === '//' ? '/' : $baseUrl; // 處理根目錄情況
}

/** 取得完整基礎 URL (含協定與域名) */
function getFullBaseUrl(): string {
    $scheme = (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off') ? 'https' : 'http';
    $host = $_SERVER['HTTP_HOST'] ?? 'localhost';
    return $scheme . '://' . $host . getBaseUrl();
}

// 使用範例
$baseUrl = getBaseUrl();        // /dev/app
$fullBase = getFullBaseUrl();   // https://example.com/dev/app

// 產生資源連結
echo "";
echo "";
echo "";

// AJAX 端點
echo "fetch('{$baseUrl}/api/users')";

進階:支援子目錄安裝與反向代理

<?php
class UrlGenerator {
    private string $baseUrl;
    private string $basePath; // 實際文檔根目錄對應的 URL 路徑前綴
    
    public function __construct(array $server = []) {
        $server = $server ?: $_SERVER;
        $this->basePath = $this->detectBasePath($server);
        $this->baseUrl = $this->normalizeBaseUrl($this->basePath);
    }
    
    private function detectBasePath(array $server): string {
        // 標準情況
        $scriptName = $server['SCRIPT_NAME'] ?? '';
        if ($scriptName) return dirname($scriptName);
        
        // 反向代理/負載平衡器情況 (X-Forwarded-Prefix)
        if (!empty($server['HTTP_X_FORWARDED_PREFIX'])) {
            return rtrim($server['HTTP_X_FORWARDED_PREFIX'], '/');
        }
        
        // Apache mod_rewrite 環境
        if (!empty($server['REDIRECT_URL'])) {
            return dirname($server['REDIRECT_URL']);
        }
        
        return '/';
    }
    
    private function normalizeBaseUrl(string $path): string {
        $path = str_replace('\\', '/', $path);
        $path = '/' . trim($path, '/');
        return $path === '//' ? '/' : $path;
    }
    
    public function baseUrl(string $path = ''): string {
        $path = ltrim($path, '/');
        return $this->baseUrl . ($path ? '/' . $path : '');
    }
    
    public function asset(string $path): string {
        // 可加入版本號 ?v=hash 防快取
        return $this->baseUrl('assets/' . ltrim($path, '/'));
    }
    
    public function route(string $name, array $params = []): string {
        // 整合路由系統 (如 FastRoute, Laravel Router)
        return $this->baseUrl('index.php/' . $name); // 簡化範例
    }
}

// 使用
$url = new UrlGenerator();
echo $url->asset('css/app.css');        // /dev/app/assets/css/app.css
echo $url->route('api.users');          // /dev/app/index.php/api/users

Zend Framework 1.x baseUrl() 實作分析 (原文吐槽)

原文提到 ZF1 的 baseUrl() 經過多層類別委派 (Zend_Controller_Request_Http → Zend_Controller_Front → Zend_Controller_Request_Abstract),涉及 getBaseUrl(), getBasePath(), getScriptName() 等方法,原文作者認為過度設計。

現代觀點:ZF1 時代 (2006-2013) 需支援 CGI、mod_php、FastCGI、IIS ISAPI 等多種 SAPI,且無標準 $_SERVER['SCRIPT_NAME'] 行為保證,複雜度是為了相容性。現代 PHP (FPM + Nginx/Apache) 環境標準化,簡單方案足夠 99% 場景。

常見陷阱與解決方案

1. 部署在子目錄 (例:/myapp/)
SCRIPT_NAME 為 /myapp/index.php,dirname() 正確回傳 /myapp。
2. 使用 URL 重寫 (隱藏 index.php)
Nginx try_files $uri $uri/ /index.php$is_args$args 時,SCRIPT_NAME 仍為 /index.php,baseUrl 正確為 / 或子目錄路徑。
3. 反向代理下游路徑前綴不同
上游 /app/ 代理到下游 /,需讀取 X-Forwarded-Prefix 或設定固定 basePath。
4. Windows IIS SCRIPT_NAME 含反斜線
str_replace('\\', '/', ...) 統一處理。
5. CLI 模式執行 (Cron/Queue Worker)
$_SERVER['SCRIPT_NAME'] 不存在,需提供 fallback 或設定環境變數 APP_BASE_URL。

最佳實踐總結

  1. 單一入口點:專案只定義一次 getBaseUrl(),全域共用 (註冊到容器/服務定位器)。
  2. 區分 baseUrl vs basePath:baseUrl 給前端用 (含域名或相對根),basePath 給檔案系統用 (實體路徑前綴)。
  3. 資源連結統一:所有 CSS/JS/圖片/AJAX URL 皆透過 $url->asset()、$url->route() 產生。
  4. 測試覆蓋:編寫單元測試覆蓋子目錄、根目錄、反向代理、CLI 等場景。

正確的 baseUrl 是 Web 應用可攜性的關鍵。拒絕硬編碼 / 或 /myapp,讓你的專案能無縫部署到任何子目錄、任何域名、任何代理架構下!

copyright © 萬盛學電腦網 all rights reserved