天天看點

php的命名空間和自動加載實作

文章目錄

    • 類的自動加載
      • 引子
      • `spl_auto_register()`
        • 用法
      • ` __autoload()`
    • 命名空間
      • 原理
        • 命名空間分類
    • 一個使用命名空間自動加載類的小實驗
    • PSR4 自動加載規範

類的自動加載

引子

當我們在php代碼中加載類時,我們必須要include或者require 某個類檔案。

但遇到類似的情況,例如:

require "Class1.php";
require "Class2.php";
$boy = $_GET['sex'] = 0?true:false;
if($boy)
{
 $class1 = new Class1();
}else{
    $class2 = new Class2();
}
           

假如我們需要判斷一個人的性别,如果是男的就執行個體化class1這個類,如果是女的就執行個體化class2這個類

那麼問題來了,這段代碼,每次我隻需要執行一個執行個體化對象。然而我卻一直加載兩個類檔案。

這樣豈不是浪費了一定的時間去加載這一個類檔案?

php對于這種問題提出了解決方案

spl_auto_register()

這個概念在 在php5.1中提出

spl_auto_register($autoload_function = null, $throw = true, $prepend = false)

函數包含3個參數

①autoload_function  這是一個函數【方法】名稱,可以是字元串或者數組(調用類方法使用)。這個函數(方法)的功能就是,來把需要new 的類檔案包含include(requeire)進來,這樣new的時候就不會找不到檔案了。其實就是封裝整個項目的include和require功能。

② $throw 該參數指定當autoload_function無法注冊時,spl_autoload_register()是否應引發異常。 

③ 如果為true,那麼spl_autoload_register()将在自動加載到檔案前面,而不時在它後面。
           

用法

那麼有了這個函數之後向這樣寫了

function load($class)
{
    require "./{$class}.php";
}
spl_autoload_register('load');
if($boy)
{
 $class1 = new Class1();
}else{
    $class2 = new Class2();
}
           

程式執行過程如下:

// 正常的流程
new 一個對象-->找不到對象--> 報錯

// 引入spl_autoload_register 後
new 一個對象-->找不到對象--> spl_autoload_register對我們說來加載我試試--> 加載成功
           
加載之後我們執行了load這個函數,通過class的拼接,我們完成了加載函數的過程
           

__autoload()

類的自動加載在前面我們講spl_autoload_register的時候已經和大家講過了。今天我們講另一種

__autoload() 在php7中已經不建議使用了

php的__autoload函數是一個魔術函數,在這個函數出現之前,如果一個php檔案裡引用了100個對象,那麼這個檔案就需要使用include或require引進100個類檔案,這将導緻該php檔案無比龐大。于是就有了這個 __autoload函數。

__autoload函數在什麼時候調用呢?當php檔案中使用了new關鍵字執行個體化一個對象時,如果該類沒有在本php檔案中被定義,将會觸發__autoload函數,此時,就可以引進定義該類的php檔案,而後,就能執行個體化成功了。(注意:如果需要執行個體化的對象,在本檔案中已經找到該類的定義的話,就不會觸發__autoload函數)

他和spl_autoload_register的差別就在于

當檔案中同時出現__autoload和spl_autoload_register時,以spl_autoload_register為準

命名空間

我們先前講過類的自動加載,然後我就在思索。

我們用架構寫代碼的時候,每在另一個檔案中調用其他類時

我們并沒有寫

spl_autoload_register

這個方法啊?那我們時怎麼實作的呢?

原理

原來啊,我們php在5.3時引入了命名空間的概念(這也是為什麼大多數的架構不支援5.3之前的版本原因之一)

命名空間大家多少還是了解的吧:不知道的去牆角面壁思過

命名空間簡而言之就是一種辨別,它的主要目的是解決命名沖突的問題。

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

把工作機關當成辨別似乎不錯,這樣就不用擔心 “撞名” 的尴尬了。

命名空間分類

  • 完全限定命名空間
  • 限定命名空間
new 成都\徐大帥(); // 限定類名
new \成都\徐大帥(); // 完全限定類名

           

在目前命名空間沒有聲明的情況下,限定類名和完全限定類名是等價的。因為如果不指定空間,則預設為全局(\)。

namespace 美國;

new 成都\徐大帥(); // 美國\成都\徐大帥(實際結果)
new \成都\徐大帥(); // 成都\徐大帥(實際結果)


           

這個例子展示了在命名空間下,使用限定類名和完全限定類名的差別。(完全限定類名 = 目前命名空間 + 限定類名)

/* 導入命名空間 */
use 成都\徐大帥;
new 徐大帥(); // 成都\徐大帥(實際結果)

/* 設定别名 */
use 成都\徐大帥 AS CEO;
new CEO(); // 成都\徐大帥(實際結果)

/* 任何情況 */
new \成都\徐大帥();// 成都\徐大帥(實際結果)

           

使用命名空間隻是讓類名有了字首,不容易發生沖突,系統仍然不會進行自動導入。

如果不引入檔案,系統會在抛出 “Class Not Found” 錯誤之前觸發

__autoload()

或者

spl_autoload_register

函數,并将限定類名傳入作為參數。

是以上面的例子都是基于你已經将相關檔案手動引入的情況下實作的,否則系統會抛出 " Class ‘成都\徐大帥’ not found"。

是以在引入命名空間以後又引入了自動加載

接下來,我們就在用命名空間加載我們的 類

一個使用命名空間自動加載類的小實驗

首先,我們在一個新檔案中定義

//School.php
namespace top;

class School
{
    function __construct()
    {
        echo '這是'.__CLASS__.'類的實作';
    }
}
           

這當然不是重要的,重要的是我們調用他的函數。我們在同一個目錄建立一個index.php檔案(不同檔案也行,隻要你寫好映射關系)

//index.php

spl_autoload_register(function ($class){
   //從我們的 class名稱中找,有沒有對應的路徑
   $map = [
       'top\\School'=>'./School.php'
   ];

   $file = $map[$class];
	//檢視對應的檔案是否存在
   if (file_exists($file))
       include $file;
});
echo "開始<br/>";
new top\School();
           

結果

開始
這是top\School類的實作
           

我們使用了 類名和類位址的映射關系,實作了我們的自動加載。然而這也意味着我們每次添加檔案,就必須去更新我們的映射檔案。在一個大型系統中這樣數組維持的映射關系無疑很麻煩。那麼有沒有好一點的做法呢?

PSR4 自動加載規範

不知道的童鞋,可以看這裡

PSR4 中文文檔

PSR4 的具體解釋

下面摘自上面連結,我覺得上面兩篇文章已經講得很透徹了

\<NamespaceName>(\<SubNamespaceNames>)*\<ClassName>
           

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 能實作惰性加載的關鍵。

我以後可能會分析一個 一款輕量級的架構 easyphp 的自動加載的源碼部分。