命名空间
最后更新于:2022-04-02 01:48:16
## 命名空间
`ThinkPHP5.1`符合`PSR-4`的自动加载规范,内置不再提供类库文件的导入方法,采用命名空间方式定义和自动加载类库文件,有效的解决了多模块和`Composer`类库之间的命名空间冲突问题,并且实现了更加高效的类库自动加载机制。
>[danger] 如果不清楚命名空间的基本概念,可以参考PHP手册:[PHP命名空间](http://www.php.net/manual/zh/language.namespaces.php)
>[danger] 特别注意的是,如果你需要调用PHP内置的类库,或者第三方没有使用命名空间的类库,记得在实例化类库的时候加上 `\`,例如:
> ~~~
> // 错误的用法
> $class = new stdClass();
> $xml = new SimpleXmlElement($xmlstr);
> // 正确的用法
> $class = new \stdClass();
> $xml = new \SimpleXmlElement($xmlstr);
> ~~~
从ThinkPHP`5.0`开始,遵循`PSR-4`自动加载规范,只需要给类库正确定义所在的命名空间,并且命名空间的路径与类库文件的目录一致,那么就可以实现类的自动加载,从而实现真正的惰性加载。
例如,`\think\cache\driver\File`类的定义为:
~~~
namespace think\cache\driver;
class File
{
}
~~~
如果我们实例化该类的话,应该是:
~~~
$class = new \think\cache\driver\File();
~~~
系统会自动加载该类对应路径的类文件,其所在的路径是 `thinkphp/library/think/cache/driver/File.php`。
>[danger] `5.1`版本默认的目录规范是小写,类文件命名是驼峰法,并且首字母大写。
## 根命名空间(类库包)
根命名空间是一个关键的概念,以上面的`\think\cache\driver\File`类为例,`think`就是一个根命名空间,其对应的初始命名空间目录就是系统的类库目录(`thinkphp/library/think`),我们可以简单的理解一个根命名空间对应了一个类库包。
系统内置的几个根命名空间(类库包)如下:
|名称|描述|类库目录|
|---|---|---|
|think|系统核心类库|thinkphp/library/think|
|traits|系统Trait类库|thinkphp/library/traits|
|app|应用类库|application|
如果需要增加新的根命名空间,我们只需要把自己的类库包目录放入`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`目录,就需要在应用配置文件中设置`root_namespace`注册根命名空间,例如下面注册了`my`和`org`两个根命名空间到`application/extend`目录下面。
~~~
'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`,如果你定义了`.env`文件的话,可以在里面添加:
~~~
APP_NAMESPACE = application
~~~
定义后,应用类库的命名空间改为:
~~~
[danger]#### 本手册后续的章节,均建立在你已经了解PHP命名空间的基础之上,如果不掌握请自行补充PHP基础,对命名空间的缺乏理解会成为你学习ThinkPHP的最大障碍。
';