【PHP高級特性】自動加載

時間 2019-12-12

原文原文鏈接

前言：

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

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

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

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

一、自動加載__autoload（廢棄）
框架

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

首先建立一個 autoload.php 來作一個簡單的測試：測試

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

new HelloWorld();

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

經過這個簡單的例子能夠發現，在類的實例化過程當中，系統所作的工做大體是這樣的：ui

/* 模擬系統實例化過程 */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 函數的工做原理以後，那就讓咱們來用它去實現自動加載。this

首先建立一個類文件（建議文件名與類名一致），代碼以下：spa

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>
 */

二、spl_autoload_register（推薦）

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

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

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

注意：實例化一個類時，須要先引用這個類文件，才能被正確實例化成對象。

 
     <?php
//用法一：自動捕捉到類名
​
//spl_autoload_register([$this,'my_autoloader']);   //my_autoloader是一個類中的方法時
spl_autoload_register('my_autoloader');  //my_autoloader是一個函數時
​
function my_autoloader($class) {   //自動捕捉到報錯的類名
    include 'classes/' . $class . '.class.php';
}
​
​
// 用法二：自 PHP 5.3.0 起可使用一個匿名函數
spl_autoload_register(function ($class) {    //自動捕捉到報錯的類名
    include 'classes/' . $class . '.class.php';
});
​
?> 
    

這裏咱們使用了一個數組去保存類名與文件路徑的關係，這樣當類名傳入時，自動加載器就知道該引入哪一個文件去加載這個類了。可是一旦文件多起來的話，映射數組會變得很長，這樣的話維護起來會至關麻煩。若是命名能遵照統一的約定，就可讓自動加載器自動解析判斷類文件所在的路徑。接下來要介紹的PSR-4 就是一種被普遍採用的約定方式。

三、PSR-4規範（推薦）

PSR-4 是關於由文件路徑自動載入對應類的相關規範，規範規定了一個徹底限定類名須要具備如下結構：

*****命名空間和文件名的對應關係*****

\頂級命名空間\子命名空間\類名     <=======>   \文件基目錄\相對路徑\文件名

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',
);
​
/* 解析類名爲文件路徑 */
//substr(string,start,length)截取字符並返回
//strpos() 函數查找字符串在另外一字符串中第一次出現的位置。
$vendor = substr($class, 0, strpos($class, '\\')); // 取出頂級命名空間[app]
$vendor_dir = $vendor_map[$vendor]; // 文件基目錄[C:\Baidu]
// 相對路徑[/view/news] 。dirname返回路徑的目錄部分。strlen獲取字符串長度
$rel_path = dirname(substr($class, strlen($vendor))); 
//basename() 函數返回路徑中的文件名部分。
$file_name = basename($class) . '.php'; // 文件名[Index.php]
​
/* 輸出文件所在路徑 */
// DIRECTORY_SEPARATOR兼容的目錄分隔符
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>
 */ 
    