在PHP中,有兩種包含外部檔案的方式,分別是include和require。他們之間有什麼不同呢?
如果檔案不存在或發生了錯誤,require產生E_COMPILE_ERROR等級的錯誤,程式停止運作。而include只產生警告,腳本會繼續執行。
這就是它們最主要的區別,其他方面require基本上等同於include。
- 被包含檔案先依參數給定的路徑尋找,如果沒有給目錄(只有檔案名稱)時則依照 include_path 指定的目錄尋找。如果在include_path 下沒找到該檔案則include 最後才在呼叫腳本檔案所在的目錄和目前工作目錄下尋找
- 如果定義了路徑不管是絕對路徑還是目前目錄的相對路徑include_path 都會被完全忽略
- include_path 在php.ini中定義
- 當一個檔案被包含時,其中所包含的程式碼繼承了include 所在行的變數範圍。從該處開始,呼叫檔案在該行處可用的任何變數在被呼叫的檔案中也都可用。不過所有在包含檔案中定義的函數和類別都具有全域作用域
除了普通的require和include之外,還有require_once和include_once,他們的作用是:
- 如果該文件中已經包含過,則不會再次包含。如同此語句名字暗示的那樣,只會包含一次
- 可以用於在腳本執行期間同一個檔案有可能被包含超過一次的情況下,想確保它只被包含一次以避免函數重定義,變數重新賦值等問題
我們來看些例子:
// a.php 不存在 include "a.php"; // warning // require "a.php"; // error echo 111; // 使用include时111会输出 // file1.php 中只有一行代码echo 'file1'; require_once 'includeandrequire/file1.php'; // file1 require_once 'includeandrequire/file1.php'; // noting include_once 'includeandrequire/file1.php'; // noting include_once 'includeandrequire/file1.php'; // noting require 'includeandrequire/file1.php'; // file1 require 'includeandrequire/file1.php'; // file1 require 'includeandrequire/file1.php'; // file1 require 'includeandrequire/file1.php'; // file1
我們可以看出當第一個_once載入成功後,後面不管是require_once還是include_once,都不會再載入這個檔案了。而不帶_once的則會重複載入檔案。
file2.php <?php echo 'file2:' . $a, PHP_EOL; echo 'file2:' . $b, PHP_EOL; $b = "file2"; myFile.php <?php $a = 'myFile'; $b = 'youFile'; require_once 'includeandrequire/file2.php'; echo $a, PHP_EOL; echo $b, PHP_EOL; // 输出结果 // file2:myFile // file2:youFile // myFile // file2 file3.php <?php $c = 'file3'; myFile.php <?php function test(){ require_once 'includeandrequire/file3.php'; echo $c, PHP_EOL; // file3 } test(); echo $c, PHP_EOL; // empty
被包含檔案中可以取得到父檔案中的變量,父檔案也可以獲得包含檔案中的變量,但是,需要注意_once的一個特殊情況。
function foo(){ require_once 'includeandrequire/file3.php'; return $c; } for($a=1;$a<=5;$a++){ echo foo(), PHP_EOL; } // file3 // empty // empty // empty // empty
使用_once並且循環載入時,只有第一次會輸出file3.php中的內容,這是為什麼呢?因為現在的變數範圍作用域在方法中,第一次載入完成後,後面的檔案不會再被載入了,這時後面四次迴圈並沒有$c被定義,$c預設就是空值了。
如果兩個方法中同時用_once載入了一個文件,第二個方法還會載入嗎?
function test1(){ require_once 'includeandrequire/file1.php'; } function test2(){ require_once 'includeandrequire/file1.php'; } test1(); // file1 test2(); // empty
抱歉,只有第一個方法會載入成功,第二個方法不會再載入了。
那麼,我們在日常的開發中,使用哪個比較好呢?
- 從效率來說,_once需要驗證是否已經加載過文件,效率會低一些,但是並不是絕對的,甚至是我們肉眼不可見的降低,所以可以忽略它的效率問題。而它帶來的好處則比不帶_once的多得多
- 本著錯誤提前的原則,使用require_once更好。因為將PHP報錯等級調整為不顯示警告後,include的警告訊息會不可見,會帶來不可預測的錯誤
- 在方法中使用時,不應該用_once來載入文件,特別是這個檔案需要在多個類別或方法中使用時,使用_once可能會導致後面的方法中無法載相同的檔案
- 使用require或include時,最好不要用括號,雖然的確可以這麼使用,如include ('xxx.php'); 它們是表達式關鍵字,不是系統方法,所以直接用include 'xxx.php' 即可
include和require的檔案如果有return,可以用變數接收retun回來的數據,另外它們還可以載入非PHP檔案以及遠端檔案(遠端載入需要確定php.ini中的allow_url_include為On),如:
file4.php <?php return 'file4'; file4.txt 可以吧 myFile.php <?php $v = require 'includeandrequire/file4.php'; echo $v, PHP_EOL; // file4 include 'includeandrequire/file4.txt'; // 可以吧 include 'https://www.baidu.com/index.html'; // 百度首页的html代码
這下我們對於include和require的了解就非常深入了吧,這兩個加載文件的方式並不復雜,但也很容易出現一些坑,特別是_once在方法中使用的時候一定要特別注意。最後,給一個小福利,封裝一個一次性載入目錄中所有檔案的方法:
function include_all_once ($pattern) { foreach (glob($pattern) as $file) { require $file; } } include_all_once('includeandrequire/*');
测试代码:https://github.com/zhangyue0503/dev-blog/blob/master/php/201911/source/%E5%BD%BB%E5%BA%95%E6%90%9E%E6%98%8E%E7%99%BDPHP%E4%B8%AD%E7%9A%84include%E5%92%8Crequire.php