命名空间

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

手动注册

也可以通过手动注册的方式注册新的根命名空间,例如:

在应用公共文件中添加下面的代码:

\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的学习过程中,对命名空间的缺乏理解会成为你最大的学习障碍。