PHP中require和include路徑問題總結

Rain Man發表於2014-12-21
PHPUI

1 絕對路徑、相對路徑和未確定路徑

相對路徑

相對路徑指以.開頭的路徑，例如

./a/a.php (相對當前目錄)    
../common.inc.php (相對上級目錄)，

絕對路徑

絕對路徑是以 / 開頭或者windows下的 C:/ 類似的碟符開頭的路徑，全路徑不用任何參考路徑就可以唯一確定檔案的最終地址。 例如

/apache/wwwroot/site/a/a.php
c:/wwwroot/site/a/a.php

未確定路徑

凡是不以 . 或者 / 開頭、也不是windows下 碟符:/ 開頭的路徑，例如

a/a.php  
common.inc.php，

開始以為這也是相對路徑，但在php的include/require包含機制中，這種型別的路徑跟以 . 開頭的相對路徑處理是完全不同的。require './a.php' 和 require 'a.php' 是不同的！

下面分析這三種型別包含路徑的處理方式：首先記住一個結論：如果包含路徑為相對路徑或者絕對徑，則不會到include_path（php.ini中定義的include_path環境變數，或者在程式中使用set_include_path(...)設定）中去查詢該檔案。

測試環境說明

注意：下面的討論和結論基於這樣的環境： 假設 A=http://www.xxx.com/app/test/a.php，再次強調下面的討論是針對直接訪問A的情況。

2. 相對路徑：

相對路徑需要一個參考目錄才能確定檔案的最終路徑，在包含解析中，不管包含巢狀多少層，這個參考目錄是程式執行入口檔案所在目錄。

示例1

A中定義  require './b/b.php';  // 則B=[SITE]/app/test/b/b.php
B中定義  require './c.php';    // 則C=[SITE]/app/test/c.php 不是[SITE]/app/test/b/c.php

示例2

A中定義  require './b/b.php';  // 則B=[SITE]/app/test/b/b.php 
B中定義  require '../c.php';   // 則C=[SITE]/app/c.php  不是 [SITE]/app/test/c.php

示例3

A中定義  require '../b.php';   //則B=[SITE]/app/b.php 
B中定義  require '../c.php';   //則C=[SITE]/app/c.php  不是 [SITE]/c.php

示例4:

A中定義  require '../b.php';   // 則B=[SITE]/app/b.php 
B中定義  require './c/c.php';  / /則C=[SITE]/app/test/c/c.php  不是 [SITE]/app/c/c.php

示例5

A中定義  require '../inc/b.php';  // 則B=[SITE]/app/inc/b.php 
B中定義  require './c/c.php';     // 則C還是=[SITE]/app/test/c/c.php  不是 [SITE]/app/inc/c/c.php

示例6

A中定義  require '../inc/b.php';  // 則B=[SITE]/app/inc/b.php 
B中定義  require './c.php';       // 則C=[SITE]/app/test/c.php  不是 [SITE]/app/inc/c.php

3. 絕對路徑

絕對路徑的比較簡單，不容易混淆出錯，require|inclue 的就是對應磁碟中的檔案。

require '/wwwroot/xxx.com/app/test/b.php';    // Linux中
require 'c:/wwwroot/xxx.com/app/test/b.php';  // windows中

dirname(__FILE__)計算出來的也是一個絕對路徑形式的目錄，但是要注意__FILE__是一個Magic constants，不管在什麼時候都等於寫這條語句的php檔案所在的絕對路徑，因此dirname(__FILE__)也總是指向寫這條語句的php檔案所在的絕對路徑，跟這個檔案是否被其他檔案包含使用沒有任何關係。

示例1

A中定義  require '../b.php';                  // 則B=[SITE]/app/b.php
B中定義  require dirname(__FILE__).'/c.php';  // 則B=[SITE]/app/c.php

示例2

A中定義  require '../inc/b.php';              // 則B=[SITE]/app/inc/b.php
B中定義  require dirname(__FILE__).'/c.php';  // 則B=[SITE]/app/inc/c.php 始終跟B在同一個目錄

結論：不管B是被A包含使用，還是直接被訪問

B如果 require dirname(__FILE__).'/c.php';    // 則始終引用到跟B在同一個目錄中的 c.php檔案; 
B如果 require dirname(__FILE__).'/../c.php'; // 則始終引用到B檔案所在目錄的父目錄中的 c.php檔案; 
B如果 require dirname(__FILE__).'/c/c.php';  // 則始終引用到B檔案所在目錄的c子目錄中的 c.php檔案;

4. 未確定路徑

首先在逐一用include_path中定義的包含目錄來拼接[未確定路徑]，找到存在的檔案則包含成功退出，如果沒有找到，則用執行require語句的php檔案所在目錄來拼接[未確定路徑]組成的全路徑去查詢該檔案，如果檔案存在則包含成功退出，否則表示包含檔案不存在，出錯。 未確定路徑比較容易搞混不建議使用。

5. 解決方案

由於“相對路徑”中的“參照目錄”是執行入口檔案所在目錄，“未確定”路徑也比較容易混淆，因此最好的解決方法是使用“絕對路徑”; 例如b.php的內容如下，無論在哪裡require b.php都是以b.php的路徑為參照來require c.php的

$dir = dirname(__FILE__);
require($dir . '../c.php');

或者定義一個通用函式 import.php，將其設定為“自動提前引入檔案”，在php.ini做如下配置

更改配置項（必須）auto_prepend_file = "C:\xampp\htdocs\auto_prepend_file.php"
更改配置項（可選）allow_url_include = On

import.php內容如下

function import($path) {    
    $old_dir = getcwd();        // 儲存原“參照目錄”
    chdir(dirname(__FILE__));    // 將“參照目錄”更改為當前指令碼的絕對路徑
    require_once($path);
    chdir($old_dir);            // 改回原“參照目錄”
}

這樣就可以使用import()函式來require檔案了，無論包含多少級“參照目錄”都是當前檔案

參考文章：PHP的require和include路徑問題經驗總結

相關文章