命名空間
命名空間
ThinkPHP1
采用命名空間方式定義和自動(dòng)加載類庫文件,有效的解決了多模塊和Composer
類庫之間的命名空間沖突問題,并且實(shí)現(xiàn)了更加高效的類庫自動(dòng)加載機(jī)制。
如果不清楚命名空間的基本概念,可以參考PHP手冊(cè):PHP命名空間
特別注意的是,如果你需要調(diào)用PHP內(nèi)置的類庫,或者第三方?jīng)]有使用命名空間的類庫,記得在實(shí)例化類庫的時(shí)候加上
\
,例如:
// 錯(cuò)誤的用法 $class = new stdClass(); $xml = new SimpleXmlElement($xmlstr); // 正確的用法 $class = new \stdClass(); $xml = new \SimpleXmlElement($xmlstr);
在ThinkPHP5.0
中,只需要給類庫正確定義所在的命名空間,并且命名空間的路徑與類庫文件的目錄一致,那么就可以實(shí)現(xiàn)類的自動(dòng)加載,從而實(shí)現(xiàn)真正的惰性加載。
例如,\think\cache\driver\File
類的定義為:
namespace think\cache\driver;
class File
{
}
如果我們實(shí)例化該類的話,應(yīng)該是:
$class = new \think\cache\driver\File();
系統(tǒng)會(huì)自動(dòng)加載該類對(duì)應(yīng)路徑的類文件,其所在的路徑是 ThinkPHP/library/think/cache/driver/File.php
。
5.0默認(rèn)的目錄規(guī)范是小寫,類文件命名是駝峰法,并且首字母大寫。
原則上,可以支持駝峰法命名的目錄,只要命名空間定義和目錄一致即可,例如:
我們實(shí)例化
$class = new \Think\Cache\Driver\File();
系統(tǒng)則會(huì)自動(dòng)加載 ThinkPHP/library/Think/Cache/Driver/File.php
文件。
根命名空間(類庫包)
根命名空間是一個(gè)關(guān)鍵的概念,以上面的\think\cache\driver\File
類為例,think
就是一個(gè)根命名空間,其對(duì)應(yīng)的初始命名空間目錄就是系統(tǒng)的類庫目錄(ThinkPHP/library/think
),我們可以簡(jiǎn)單的理解一個(gè)根命名空間對(duì)應(yīng)了一個(gè)類庫包。
系統(tǒng)內(nèi)置的幾個(gè)根命名空間(類庫包)如下:
名稱 | 描述 | 類庫目錄 |
---|---|---|
think | 系統(tǒng)核心類庫 | ThinkPHP/library/think |
traits | 系統(tǒng)Trait類庫 | ThinkPHP/library/traits |
app | 應(yīng)用類庫 | application |
如果需要增加新的根命名空間,有兩種方式:注冊(cè)新的根命名空間或者放入EXTEND_PATH
目錄(自動(dòng)注冊(cè))。
請(qǐng)注意本手冊(cè)中的示例代碼為了簡(jiǎn)潔,如無指定類庫的命名空間的話,都表示指的是
think
命名空間,例如下面的代碼:
Route::get('hello','index/hello');
請(qǐng)自行添加 use think\Route
或者使用
\think\Route::get('hello','index/hello');
自動(dòng)注冊(cè)
我們只需要把自己的類庫包目錄放入EXTEND_PATH
目錄(默認(rèn)為extend
,可配置),就可以自動(dòng)注冊(cè)對(duì)應(yīng)的命名空間,例如:
我們?cè)?code style="box-sizing: inherit; -webkit-tap-highlight-color: transparent; text-size-adjust: none; -webkit-font-smoothing: antialiased; font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; font-size: 1em; display: inline-block; border-radius: 4px; padding: 2px 6px; background: rgb(249, 250, 250); word-break: break-all; white-space: pre; line-height: 1.3; border: 1px solid rgb(222, 217, 217); margin: 0px 5px;">extend目錄下面新增一個(gè)my
目錄,然后定義一個(gè)\my\Test
類( 類文件位于extend/my/Test.php
)如下:
namespace my;
class Test
{
public function sayHello()
{
echo 'hello';
}
}
我們就可以直接實(shí)例化和調(diào)用:
$Test = new \my\Test();
$Test->sayHello();
如果我們?cè)趹?yīng)用入口文件中重新定義了EXTEND_PATH
常量的話,還可以改變\my\Test
類文件的位置,例如:
define('EXTEND_PATH','../vendor/');
那么\my\Test
類文件的位置就變成了/vendor/my/File.php
。
手動(dòng)注冊(cè)
也可以通過手動(dòng)注冊(cè)的方式注冊(cè)新的根命名空間,例如:
在應(yīng)用公共文件中添加下面的代碼:
\think\Loader::addNamespace('my','../application/extend/my/');
如果要同時(shí)注冊(cè)多個(gè)根命名空間,可以使用:
\think\Loader::addNamespace([
'my' => '../application/extend/my/',
'org' => '../application/extend/org/',
]);
也可以直接在應(yīng)用的配置文件中添加配置,系統(tǒng)會(huì)在應(yīng)用執(zhí)行的時(shí)候自動(dòng)注冊(cè)。
'root_namespace' => [
'my' => '../application/extend/my/',
'org' => '../application/extend/org/',
]
應(yīng)用類庫包
為了避免和Composer
自動(dòng)加載的類庫存在沖突 ,應(yīng)用類庫的命名空間的根都統(tǒng)一以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
根命名空間不合適或者有沖突,可以在應(yīng)用配置文件中修改:
'app_namespace' => 'application',
V5.0.8+
版本的話,app_namespace
配置參數(shù)改為APP_NAMESPACE
常量在入口文件中定義。
定義后,應(yīng)用類庫的命名空間改為:
namespace application\index\model;
class User extends \think\Model
{
}
命名空間別名
框架允許給命名空間定義別名,例如:
namespace app\index\model;
use think\Model;
class User extends Model
{
}
原來在控制器里面調(diào)用方式為:
namespace app\index\controller;
use app\index\model\User;
class Index
{
public function index()
{
$user = new User();
}
}
如果我們?cè)趹?yīng)用公共文件中注冊(cè)命名空間別名如下:
\think\Loader::addNamespaceAlias('model','app\index\model');
那么,上面的控制器代碼就可以更改為:
namespace app\index\controller;
use model\User;
class Index
{
public function index()
{
$user = new User();
}
}
本手冊(cè)后續(xù)的章節(jié),均建立在你已經(jīng)了解PHP命名空間的基礎(chǔ)之上,如果不掌握請(qǐng)自行補(bǔ)充PHP基礎(chǔ),否則你在后續(xù)的文檔和ThinkPHP5.0的學(xué)習(xí)過程中,對(duì)命名空間的缺乏理解會(huì)成為你最大的學(xué)習(xí)障礙。