命名空間
命名空間
ThinkPHP1
采用命名空間方式定義和自動加載類庫文件,有效的解決了多模塊和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
。
手動注冊
也可以通過手動注冊的方式注冊新的根命名空間,例如:
在應用公共文件中添加下面的代碼:
\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',
V5.0.8+
版本的話,app_namespace
配置參數改為APP_NAMESPACE
常量在入口文件中定義。
定義后,應用類庫的命名空間改為:
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();
}
}
本手冊后續的章節,均建立在你已經了解PHP命名空間的基礎之上,如果不掌握請自行補充PHP基礎,否則你在后續的文檔和ThinkPHP5.0的學習過程中,對命名空間的缺乏理解會成為你最大的學習障礙。