命名空間
命名空間
ThinkPHP1采用命名空間方式定義和自動加載類庫文件,有效的解決了多模塊和Composer類庫之(zhi)間的命名空間沖突(tu)問題,并(bing)且實現了更加高效(xiao)的類庫自動加載(zai)機(ji)制。
如(ru)果不清(qing)楚命名空(kong)間的基本概念,可以參考PHP手冊(ce):
特別注意的是,如果你需要調用PHP內置的類庫,或者第三方沒有使用命名空間的類庫,記得在實例化類庫的時候加上
\,例如:// 錯誤的用(yong)法 $class = new stdClass(); $xml = new SimpleXmlElement($xmlstr); // 正確的用(yong)法 $class = new \stdClass(); $xml = new \SimpleXmlElement($xmlstr);
在ThinkPHP5.0中,只需要(yao)給類(lei)(lei)庫(ku)(ku)正確定義所在的命名空(kong)間,并且命名空(kong)間的路徑與類(lei)(lei)庫(ku)(ku)文件的目錄一(yi)致,那么就可(ke)以(yi)實(shi)現類(lei)(lei)的自動加(jia)載(zai),從(cong)而實(shi)現真正的惰性(xing)加(jia)載(zai)。
例如,\think\cache\driver\File類的定義為:
namespace think\cache\driver;
class File
{
}
如果(guo)我們實(shi)例化該(gai)(gai)類的話,應該(gai)(gai)是:
$class = new \think\cache\driver\File();
系統會自動加載該類對應路徑的類文件,其所在的路徑是 ThinkPHP/library/think/cache/driver/File.php。
5.0默認(ren)的目錄(lu)規范是小(xiao)寫(xie),類文件(jian)命名是駝峰法,并且首字(zi)母大寫(xie)。
原則上,可以支持(chi)駝峰法命名(ming)(ming)的目錄,只要命名(ming)(ming)空間定義和目錄一致即可,例如(ru):
我們實例化
$class = new \Think\Cache\Driver\File();
系統則會自動加載 ThinkPHP/library/Think/Cache/Driver/File.php文件。
根命名空間(類庫包)
根命名空間是一個關鍵的概念,以上面的\think\cache\driver\File類為例,think就是一個根命名空間,其對應的初始命名空間目錄就是系統的類庫目錄(ThinkPHP/library/think),我們可以簡單的(de)理解一個根命名空間對應了(le)一個類庫(ku)包。
系統(tong)內(nei)置的幾(ji)個根命名空間(jian)(類庫包)如下(xia):
| 名稱 | 描述 | 類庫目錄 |
|---|---|---|
| think | 系統核心類庫 | ThinkPHP/library/think |
| traits | 系統Trait類庫 | ThinkPHP/library/traits |
| app | 應用類庫 | application |
如果需要增加新的根命名空間,有兩種方式:注冊新的根命名空間或者放入EXTEND_PATH目錄(自動注冊)。
請注意本手冊中的示例代碼為了簡潔,如無指定類庫的命名空間的話,都表示指的是
think命名空間,例如下面的(de)代碼(ma):
Route::get('hello','index/hello');
請自行添加 use think\Route或者使用
\think\Route::get('hello','index/hello');
自動注冊
我們只需要把自己的類庫包目錄放入EXTEND_PATH目錄(默認為extend,可配置),就可以自動注冊對(dui)應(ying)的命名空間,例如:
我們在extend目錄下面新增一個my目錄,然后定義一個\my\Test類( 類文件位于extend/my/Test.php)如下:
namespace my;
class Test
{
public function sayHello()
{
echo 'hello';
}
}
我們就可以直接實例(li)化和調用:
$Test = new \my\Test();
$Test->sayHello();
如果我們在應用入口文件中重新定義了EXTEND_PATH常量的話,還可以改變\my\Test類文件的位置,例如(ru):
define('EXTEND_PATH','../vendor/');
那么\my\Test類文件的位置就變成了/vendor/my/File.php。
手動注冊
也(ye)可以通過手動注冊(ce)的(de)方式注冊(ce)新的(de)根命(ming)名空間,例如(ru):
在(zai)應用公共文件中添加下面的(de)代碼(ma):
\think\Loader::addNamespace('my','../application/extend/my/');
如果要同時(shi)注冊多(duo)個根命名空(kong)間(jian),可以(yi)使用:
\think\Loader::addNamespace([
'my' => '../application/extend/my/',
'org' => '../application/extend/org/',
]);
也可以直接在(zai)應用(yong)的配(pei)置文件中添加配(pei)置,系統會在(zai)應用(yong)執(zhi)行(xing)的時候自(zi)動注冊。
'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根命名空間不合適(shi)或者有沖(chong)突,可以(yi)在應(ying)用配置文件中修改:
'app_namespace' => 'application',
V5.0.8+版本的話,app_namespace配置參數改為APP_NAMESPACE常(chang)量在入口文件(jian)中定義。
定(ding)義后,應用類庫(ku)的命名空間(jian)改為:
namespace application\index\model;
class User extends \think\Model
{
}
命名空間別名
框架(jia)允許給命名(ming)空間(jian)定義別名(ming),例如(ru):
namespace app\index\model;
use think\Model;
class User extends Model
{
}
原(yuan)來在控制器里(li)面調用方(fang)式(shi)為(wei):
namespace app\index\controller;
use app\index\model\User;
class Index
{
public function index()
{
$user = new User();
}
}
如(ru)果我們在應用公共文件中注冊命名空間別名如(ru)下:
\think\Loader::addNamespaceAlias('model','app\index\model');
那么(me),上面的控制器代(dai)碼就可以更(geng)改為:
namespace app\index\controller;
use model\User;
class Index
{
public function index()
{
$user = new User();
}
}
本手冊后續的章節,均建立在你已經了解PHP命名空間的基礎之上,如果不掌握請自行補充PHP基礎,否則你在后續的文檔和ThinkPHP5.0的學習過程中,對命名空間的缺乏理解會成為你最大的學習障礙。
