類自動加載(Autoloading)


類自動加載(Autoloading)

Yii 依靠類自動加載機制來定位和包含所需的類文件。它提供一個高性能且完美支持PSR-4 標準(中文漢化)的自動加載器。該自動加載器會在引入框架文件 Yii.php 時安裝好。

注意:爲了簡化敘述,本篇文檔中我們只會提及類的自動加載。不過,要記得文中的描述同樣也適用於接口和Trait(特質)的自動加載哦。

使用 Yii 自動加載器

要使用 Yii 的類自動加載器,你需要在創建和命名類的時候遵循兩個簡單的規則:

  • 每個類都必須置於命名空間之下 (比如 foo\bar\MyClass)。
  • 每個類都必須保存爲單獨文件,且其完整路徑能用以下算法取得:
  1. // $className 是一個開頭包含反斜槓的完整類名(譯者注:請自行谷歌:fully qualified class name) 
  2. $classFile = Yii::getAlias('@' . str_replace('\\\\', '/', $className) . '.php');

舉例來說,若某個類名爲 foo\bar\MyClass,對應類的文件路徑別名會是 @foo/bar/MyClass.php。爲了讓該別名能被正確解析爲文件路徑,@foo 或 @foo/bar 中的一個必須是根別名

當我們使用基本應用模版時,可以把你的類放置在頂級命名空間 app 下,這樣它們就可以被 Yii 自動加載,而無需定義一個新的別名。這是因爲 @app 本身是一個預定義別名,且類似於 app\components\MyClass 這樣的類名,基於我們剛纔所提到的算法,可以正確解析出 AppBasePath/components/MyClass.php 路徑。

高級應用模版裏,每一邏輯層級會使用他自己的根別名。比如,前端層會使用 @frontend 而後端層會使用@backend。因此,你可以把前端的類放在 frontend 命名空間,而後端的類放在 backend。 這樣這些類就可以被 Yii 自動加載了。

類映射表(Class Map)

Yii 類自動加載器支持類映射表功能,該功能會建立一個從類的名字到類文件路徑的映射。當自動加載器加載一個文件時,他首先檢查映射表裏有沒有該類。如果有,對應的文件路徑就直接加載了,省掉了進一步的檢查。這讓類的自動加載變得超級快。事實上所有的 Yii 核心類都是這樣加載的。

你可以用 Yii::$classMap 方法向映射表中添加類,

  1. Yii::$classMap['foo\\bar\\MyClass'] = 'path/to/MyClass.php';

別名可以被用於指定類文件的路徑。你應該在引導啓動的過程中設置類映射表,這樣映射表就可以在你使用具體類之前就準備好。

用其他自動加載器

因爲 Yii 完全支持 Composer 管理依賴包,所以推薦你也同時安裝 Composer 的自動加載器,如果你用了一些自帶自動加載器的第三方類庫,你應該也安裝下它們。

當你同時使用其他自動加載器和 Yii 自動加載器時,應該在其他自動加載器安裝成功之後,再包含 Yii.php 文件。這將使 Yii 成爲第一個響應任何類自動加載請求的自動加載器。舉例來說,以下代碼提取自基本應用模版入口腳本 。第一行安裝了 Composer 的自動加載器,第二行纔是 Yii 的自動加載器:

  1. require(__DIR__ . '/../vendor/autoload.php'); 
  2. require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');

你也可以只使用 Composer 的自動加載,而不用 Yii 的自動加載。不過這樣做的話,類的加載效率會下降,且你必須遵循 Composer 所設定的規則,從而讓你的類滿足可以被自動加載的要求。

補充:若你不想要使用 Yii 的自動加載器,你必須創建一個你自己版本的 Yii.php 文件,並把它包含進你的入口腳本裏。

自動加載擴展類

Yii 自動加載器支持自動加載擴展的類。唯一的要求是它需要在 composer.json 文件里正確地定義 autoload部分。請參考 Composer 文檔(英文)(中文漢化),來了解如何正確描述 autoload 的更多細節。

在你不使用 Yii 的自動加載器時,Composer 的自動加載器仍然可以幫你自動加載擴展內的類。