TP5學習筆記一 名稱空間

weixin_33935777發表於2019-01-24

ThinkPHP5採用名稱空間方式定義和自動載入類庫檔案,有效的解決了多模組和Composer類庫之間的名稱空間衝突問題,並且實現了更加高效的類庫自動載入機制。

如果不清楚名稱空間的基本概念,可以參考PHP手冊:PHP名稱空間

特別注意的是,如果你需要呼叫PHP內建的類庫,或者第三方沒有使用名稱空間的類庫,記得在例項化類庫的時候加上 \,例如:

// 錯誤的用法
$class = new stdClass();
$xml  =  new SimpleXmlElement($xmlstr);
// 正確的用法
$class = new \stdClass();
$xml  =  new \SimpleXmlElement($xmlstr);

在ThinkPHP5.0中,只需要給類庫正確定義所在的名稱空間,並且名稱空間的路徑與類庫檔案的目錄一致,那麼就可以實現類的自動載入,從而實現真正的惰性載入。

例如,\think\cache\driver\File類的定義為:

namespace think\cache\driver;

class File 
{
}

如果我們例項化該類的話,應該是:

$class = new \think\cache\driver\File();

系統會自動載入該類對應路徑的類檔案,其所在的路徑是 thinkphp/library/think/cache/driver/File.php

5.0預設的目錄規範是小寫,類檔案命名是駝峰法,並且首字母大寫。

原則上,可以支援駝峰法命名的目錄,只要名稱空間定義和目錄一致即可,例如:

我們例項化

$class = new \Think\Cache\Driver\File();

系統則會自動載入 thinkphp/library/Think/Cache/Driver/File.php檔案。

根名稱空間(類庫包)

根名稱空間是一個關鍵的概念,以上面的\think\cache\driver\File類為例,think就是一個根名稱空間,其對應的初始名稱空間目錄就是系統的類庫目錄(thinkphp/library/think),我們可以簡單的理解一個根名稱空間對應了一個類庫包。

系統內建的幾個根名稱空間(類庫包)如下:

名稱 描述 類庫目錄
think 系統核心類庫 thinkphp/library/think
traits 系統Trait類庫 thinkphp/library/traits
app 應用類庫 application

如果需要增加新的根名稱空間,有兩種方式:註冊新的根名稱空間或者放入EXTEND_PATH目錄(自動註冊)。

請注意本手冊中的示例程式碼為了簡潔,如無指定類庫的名稱空間的話,都表示指的是think名稱空間,例如下面的程式碼:

Route::get('hello','index/hello');

請自行新增 use think\Route或者使用

\think\Route::get('hello','index/hello');

自動註冊

我們只需要把自己的類庫包目錄放入EXTEND_PATH目錄(預設為extend,可配置),就可以自動註冊對應的名稱空間,例如:

我們在extend目錄下面新增一個my目錄,然後定義一個\my\Test類( 類檔案位於extend/my/Test.php)如下:

namespace my;

class Test 
{
    public function sayHello()
    {
        echo 'hello';
    }
}

我們就可以直接例項化和呼叫:

$Test = new \my\Test();
$Test->sayHello();

如果我們在應用入口檔案中重新定義了EXTEND_PATH常量的話,還可以改變\my\Test類檔案的位置,例如:

define('EXTEND_PATH','../vendor/');

那麼\my\Test類檔案的位置就變成了/vendor/my/File.php

'..' 是應為入口在public下

手動註冊

也可以通過手動註冊的方式註冊新的根名稱空間,例如:

在應用入口檔案中新增下面的程式碼:

\think\Loader::addNamespace('my','../application/extend/my/');

如果要同時註冊多個根名稱空間,可以使用:

\think\Loader::addNamespace([
    'my'  => '../application/extend/my/',
    'org' => '../application/extend/org/',
]);

也可以直接在應用的配置檔案中新增配置,系統會在應用執行的時候自動註冊。

'root_namespace' => [
    'my'  => '../application/extend/my/',
    'org' => '../application/extend/org/',
]

應用類庫包

為了避免和Composer自動載入的類庫存在衝突 ,應用類庫的名稱空間的根都統一以app命名,例如:

namespace app\index\model;

class User extends \think\Model
{
}

其類檔案位於 application/index/model/User.php

namespace app\admin\event;

class User 
{
}

其類檔案位於 application/admin/event/User.php

如果覺得app根名稱空間不合適或者有衝突,可以在應用配置檔案中修改:

'app_namespace' =>  'application',

定義後,應用類庫的名稱空間改為:

namespace application\index\model;

class User extends \think\Model
{
}

名稱空間別名

框架允許給名稱空間定義別名,例如:

namespace app\index\model;

use think\Model;

class User extends Model
{
}

原來在控制器裡面呼叫方式為:

namespace app\index\controller;

use app\index\model\User;

class Index
{
    public function index()
    {
        $user = new User();
    }
}

如果我們在應用公共檔案中註冊名稱空間別名如下:

\think\Loader::addNamespaceAlias('model','app\index\model');

那麼,上面的控制器程式碼就可以更改為:

namespace app\index\controller;

use model\User;

class Index
{
    public function index()
    {
        $user = new User();
    }
}

相關文章