PHP 命名空間與spl_autoload_register() 自動加載機制，講的比較詳細！

PHP 命名空間與spl_autoload_register() 自動加載機制

include 和 require 是PHP中引入文件的兩個基本方法。在小規模開發中直接使用 include 和 require 但在大型項目中會造成大量的 include 和 require 堆積。這樣的代碼既不優雅，執行效率也很低，而且維護起來也相當困難。

爲了解決這個問題，部分框架會給出一個引入文件的配置清單，在對象初始化的時候把需要的文件引入。但這只是讓代碼變得更簡潔了一些，引入的效果仍然是差強人意。PHP5 之後，隨着 PHP 面向對象支持的完善，__autoload 函數才真正使得自動加載成爲可能。

 

* include 和 require 功能是一樣的，它們的不同在於 include 出錯時只會產生警告，而 require 會拋出錯誤終止腳本。

* include_once 和 include 唯一的區別在於 include_once 會檢查文件是否已經引入，如果是則不會重複引入。

 

=================自動加載==================

實現自動加載最簡單的方式就是使用 __autoload 魔術方法。當需要使用的類沒有被引入時，這個函數會在PHP報錯前被觸發，未定義的類名會被當作參數傳入。至於函數具體的邏輯，這需要用戶自己去實現。

首先創建一個 autoload.php 來做一個簡單的測試：

// 類未定義時，系統自動調用
function __autoload($class)
{
    /* 具體處理邏輯 */
    echo $class;// 簡單的輸出未定義的類名
}

new HelloWorld();

/**
 * 輸出 HelloWorld 與報錯信息
 * Fatal error: Class 'HelloWorld' not found
 */

通過這個簡單的例子可以發現，在類的實例化過程中，系統所做的工作大致是這樣的：

/* 模擬系統實例化過程 */
function instance($class)
{
    // 如果類存在則返回其實例
    if (class_exists($class, false)) {
        return new $class();
    }
    // 查看 autoload 函數是否被用戶定義
    if (function_exists('__autoload')) {
        __autoload($class); // 最後一次引入的機會
    }
    // 再次檢查類是否存在
    if (class_exists($class, false)) {
        return new $class();
    } else { // 系統：我實在沒轍了
        throw new Exception('Class Not Found');
    }
}

明白了 __autoload 函數的工作原理之後，那就讓我們來用它去實現自動加載。

首先創建一個類文件（建議文件名與類名一致），代碼如下：

class [ClassName] 
{
    // 對象實例化時輸出當前類名
    function __construct()
    {
        echo '<h1>' . __CLASS__ . '</h1>';
    }
}

（我這裏創建了一個 HelloWorld 類用作演示）接下來我們就要定義 __autoload 的具體邏輯，使它能夠實現自動加載：

function __autoload($class)
{
    // 根據類名確定文件名
    $file = $class . '.php';

    if (file_exists($file)) {
        include $file; // 引入PHP文件
    }
}

new HelloWorld();

/**
 * 輸出 <h1>HelloWorld</h1>
 */

 

=================命名空間==================

其實命名空間並不是什麼新生事物，很多語言（例如C++）早都支持這個特性了。只不過 PHP 起步比較晚，直到 PHP 5.3 之後才支持。

命名空間簡而言之就是一種標識，它的主要目的是解決命名衝突的問題。

就像在日常生活中，有很多姓名相同的人，如何區分這些人呢？那就需要加上一些額外的標識。

把工作單位當成標識似乎不錯，這樣就不用擔心 “撞名” 的尷尬了。

這裏我們來做一個小任務，去介紹百度的CEO李彥宏：

namespace 百度;

class 李彥宏
{
    function __construct()
    {
        echo '百度創始人';
    }
}

↑ 這就是李彥宏的基本資料了，namespace 是他的單位標識，class 是他的姓名。

命名空間通過關鍵字 namespace 來聲明。如果一個文件中包含命名空間，它必須在其它所有代碼之前聲明命名空間。

new 百度\李彥宏(); // 限定類名
new \百度\李彥宏(); // 完全限定類名

↑ 在一般情況下，無論是向別人介紹 "百度 李彥宏" 還是 "百度公司 李彥宏"，他們都能夠明白。

在當前命名空間沒有聲明的情況下，限定類名和完全限定類名是等價的。因爲如果不指定空間，則默認爲全局（\）。

namespace 谷歌;

new 百度\李彥宏(); // 谷歌\百度\李彥宏（實際結果）
new \百度\李彥宏(); // 百度\李彥宏（實際結果）

↑ 如果你在谷歌公司向他們的員工介紹李彥宏，一定要指明是 "百度公司的李彥宏"。否則他會認爲百度是谷歌的一個部門，而李彥宏只是其中的一位員工而已。

這個例子展示了在命名空間下，使用限定類名和完全限定類名的區別。（完全限定類名 = 當前命名空間 + 限定類名）

/* 導入命名空間 */
use 百度\李彥宏;
new 李彥宏(); // 百度\李彥宏（實際結果）

/* 設置別名 */
use 百度\李彥宏 AS CEO;
new CEO(); // 百度\李彥宏（實際結果）

/* 任何情況 */
new \百度\李彥宏();// 百度\李彥宏（實際結果）

↑ 第一種情況是別人已經認識李彥宏了，你只需要直接說名字，他就能知道你指的是誰。第二種情況是李彥宏就是他們的CEO，你直接說CEO，他可以立刻反應過來。

使用命名空間只是讓類名有了前綴，不容易發生衝突，系統仍然不會進行自動導入。

如果不引入文件，系統會在拋出 "Class Not Found" 錯誤之前觸發 __autoload 函數，並將限定類名傳入作爲參數。

所以上面的例子都是基於你已經將相關文件手動引入的情況下實現的，否則系統會拋出 " Class '百度\李彥宏' not found"。

 

=================spl_autoload==================

接下來讓我們要在含有命名空間的情況下去實現自動加載。這裏我們使用 spl_autoload_register() 函數來實現，這需要你的 PHP 版本號大於 5.12。

spl_autoload_register 函數的功能就是把傳入的函數（參數可以爲回調函數或函數名稱形式）註冊到 SPL __autoload 函數隊列中，並移除系統默認的 __autoload() 函數。

一旦調用 spl_autoload_register() 函數，當調用未定義類時，系統就會按順序調用註冊到 spl_autoload_register() 函數的所有函數，而不是自動調用 __autoload() 函數。

現在，我們來創建一個 Linux 類，它使用 os 作爲它的命名空間（建議文件名與類名保持一致）：

namespace os; // 命名空間

class Linux // 類名
{
    function __construct()
    {
        echo '<h1>' . __CLASS__ . '</h1>';
    }
}

接着，在同一個目錄下新建一個 PHP 文件，使用 spl_autoload_register 以函數回調的方式實現自動加載：

spl_autoload_register(function ($class) { // class = os\Linux

    /* 限定類名路徑映射 */
    $class_map = array(
        // 限定類名 => 文件路徑
        'os\\Linux' => './Linux.php',
    );

    /* 根據類名確定文件名 */
    $file = $class_map[$class];

    /* 引入相關文件 */
    if (file_exists($file)) {
        include $file;
    }
});

new \os\Linux();

這裏我們使用了一個數組去保存類名與文件路徑的關係，這樣當類名傳入時，自動加載器就知道該引入哪個文件去加載這個類了。

但是一旦文件多起來的話，映射數組會變得很長，這樣的話維護起來會相當麻煩。如果命名能遵守統一的約定，就可以讓自動加載器自動解析判斷類文件所在的路徑。接下來要介紹的PSR-4 就是一種被廣泛採用的約定方式。

 

=================PSR-4規範==================

PSR-4 是關於由文件路徑自動載入對應類的相關規範，規範規定了一個完全限定類名需要具有以下結構：

\<頂級命名空間>(\<子命名空間>)*\<類名>

如果繼續拿上面的例子打比方的話，頂級命名空間相當於公司，子命名空間相當於職位，類名相當於人名。那麼李彥宏標準的稱呼爲 "百度公司 CEO 李彥宏"。

PSR-4 規範中必須要有一個頂級命名空間，它的意義在於表示某一個特殊的目錄（文件基目錄）。子命名空間代表的是類文件相對於文件基目錄的這一段路徑（相對路徑），類名則與文件名保持一致（注意大小寫的區別）。

舉個例子：在全限定類名 \app\view\news\Index 中，如果 app 代表 C:\Baidu，那麼這個類的路徑則是 C:\Baidu\view\news\Index.php

我們就以解析 \app\view\news\Index 爲例，編寫一個簡單的 Demo：

$class = 'app\view\news\Index';

/* 頂級命名空間路徑映射 */
$vendor_map = array(
    'app' => 'C:\Baidu',
);

/* 解析類名爲文件路徑 */
$vendor = substr($class, 0, strpos($class, '\\')); // 取出頂級命名空間[app]
$vendor_dir = $vendor_map[$vendor]; // 文件基目錄[C:\Baidu]
$rel_path = dirname(substr($class, strlen($vendor))); // 相對路徑[/view/news]
$file_name = basename($class) . '.php'; // 文件名[Index.php]

/* 輸出文件所在路徑 */
echo $vendor_dir . $rel_path . DIRECTORY_SEPARATOR . $file_name;

通過這個 Demo 可以看出限定類名轉換爲路徑的過程。那麼現在就讓我們用規範的面向對象方式去實現自動加載器吧。

首先我們創建一個文件 Index.php，它處於 \app\mvc\view\home 目錄中：

namespace app\mvc\view\home;

class Index
{
    function __construct()
    {
        echo '<h1> Welcome To Home </h1>';
    }
}

接着我們在創建一個加載類（不需要命名空間），它處於 \ 目錄中：

class Loader
{
    /* 路徑映射 */
    public static $vendorMap = array(
        'app' => __DIR__ . DIRECTORY_SEPARATOR . 'app',
    );

    /**
     * 自動加載器
     */
    public static function autoload($class)
    {
        $file = self::findFile($class);
        if (file_exists($file)) {
            self::includeFile($file);
        }
    }

    /**
     * 解析文件路徑
     */
    private static function findFile($class)
    {
        $vendor = substr($class, 0, strpos($class, '\\')); // 頂級命名空間
        $vendorDir = self::$vendorMap[$vendor]; // 文件基目錄
        $filePath = substr($class, strlen($vendor)) . '.php'; // 文件相對路徑
        return strtr($vendorDir . $filePath, '\\', DIRECTORY_SEPARATOR); // 文件標準路徑
    }

    /**
     * 引入文件
     */
    private static function includeFile($file)
    {
        if (is_file($file)) {
            include $file;
        }
    }
}

最後，將 Loader 類中的 autoload 註冊到 spl_autoload_register 函數中：

include 'Loader.php'; // 引入加載器
spl_autoload_register('Loader::autoload'); // 註冊自動加載

new \app\mvc\view\home\Index(); // 實例化未引用的類

/**
 * 輸出: <h1> Welcome To Home </h1>
 */

示例中的代碼其實就是 ThinkPHP 自動加載器源碼的精簡版，它是 ThinkPHP 5 能實現惰性加載的關鍵。