容器和依赖注入 · ThinkPHP5.1完全开发手册

## 容器和依赖注入 `5.1`版本正式引入了容器的概念，用来更方便的管理类依赖及运行依赖注入。 >[danger] 5.0版本已经支持依赖注入的，依赖注入和容器没有必然关系容器类的工作由`think\Container`类完成，但大多数情况我们只需要通过`app`助手函数即可完成大部分操作。依赖注入其实本质上是指对类的依赖通过构造器完成自动注入，例如在控制器架构方法和操作方法中一旦对参数进行对象类型约束则会自动触发依赖注入，由于访问控制器的参数都来自于URL请求，普通变量就是通过参数绑定自动获取，对象变量则是通过依赖注入生成。 ~~~ <?php namespace app\index\controller; use app\index\model\User; class Index { protected $user; public function __construct(User $user) { $this->user = $user; } public function hello() { return 'Hello,' . $this->user->name . '！'; } } ~~~ >[danger] 依赖注入的对象参数支持多个，并且和顺序无关。支持使用依赖注入的场景包括（但不限于）： * 控制器架构方法； * 控制器操作方法； * 数据库和模型事件方法； * 路由的闭包定义； * 行为类的方法； >[danger] 在ThinkPHP的设计中，`think\App`类虽然自身不是容器，但却是一个容器管理类，可以完成容器的所有操作。 >`V5.1.14+`版本开始，应用类自身就是一个容器实例。 ## 绑定依赖注入的类统一由容器进行管理，**大多数情况下是在自动绑定并且实例化的**。不过你可以随时进行手动绑定类到容器中，支持多种绑定方式。 ### 绑定类标识可以对已有的类库绑定一个标识（唯一），便于快速调用。 ~~~php // 绑定类库标识 bind('cache','think\Cache'); // 快速调用（自动实例化） $cache = app('cache'); ~~~ >[danger] 调用和绑定的标识必须保持一致（包括大小写）容器中已经调用过的类会自动使用单例，除非你使用下面的方式强制重新实例化。 ~~~ // 每次调用都会重新实例化 $cache = app('cache',true); ~~~ 你可以绑定一个类到容器中（第一个参数直接传入类名）： ~~~ bind('app\common\Test'); ~~~ 但实际上这个操作是多余的，因为只要调用过一次后就会自动绑定 ~~~ app('app\common\Test'); ~~~ > 绑定的类标识可以自己定义（只要不冲突）。 ### 绑定闭包可以把一个闭包方法绑定到容器中 ~~~ bind('sayHello', function ($name) { return 'hello,' . $name; }); echo app('sayHello',['thinkphp']); ~~~ ### 绑定类的实例也可以直接绑定一个类的实例 ~~~ $cache = new think\Cache; // 绑定类实例 bind('cache',$cache); // 快速调用类的实例 $cache = app('cache'); ~~~ ### 绑定至接口实现对于依赖注入使用接口类的情况，我们需要告诉系统使用哪个具体的接口实现类来进行注入，这个使用可以把某个类绑定到接口 ~~~ // 绑定think\LoggerInterface接口实现到think\Log bind('think\LoggerInterface','think\Log'); ~~~ 使用接口作为依赖注入的类型 ~~~ <?php namespace app\index\controller; use think\LoggerInterface; class Index { public function hello(LoggerInterface $log) { $log->record('hello,world!'); } } ~~~ ### 批量绑定如果传入一个数组的话，就表示进行批量绑定，例如： ~~~ bind([ 'route' => \think\Route::class, 'session' => \think\Session::class, 'url' => \think\Url::class, ]); ~~~ 可以在应用或者模块目录下面定义`provider.php`文件（返回一个数组），系统会自动批量绑定类库到容器中。 ~~~ return [ 'route' => \think\Route::class, 'session' => \think\Session::class, 'url' => \think\Url::class, ]; ~~~ >[danger] 绑定标识调用的时候区分大小写，系统已经内置绑定了核心常用类库，无需重复绑定系统内置绑定到容器中的类库包括系统类库|容器绑定标识 ---|--- think\Build|build think\Cache|cache think\Config|config think\Cookie|cookie think\Debug|debug think\Env|env think\Hook|hook think\Lang|lang think\Log|log think\Request|request think\Response|response think\Route|route think\Session|session think\Url|url think\Validate|validate think\View|view ## 解析 ### 助手函数方式使用`app`助手函数进行容器中的类解析调用，对于已经绑定的类标识，会自动快速实例化 ~~~ app('cache'); ~~~ 上面的app助手函数相当于调用了 ~~~ Container::get('cache'); ~~~ 带参数实例化调用 ~~~ app('cache',['file']); ~~~ 对于没有绑定的类，也可以直接解析 ~~~ app('org\utils\ArrayItem'); ~~~ ### 对象化调用使用`app`助手函数获取容器中的对象实例（支持依赖注入）。 ~~~ $app = app(); // 判断对象实例是否存在 isset($app->cache); // 注册容器对象实例 $app->cache = think\Cache::class; // 获取容器中的对象实例 $cache = $app->cache; ~~~ 不带任何参数调用`app`助手函数其实是实例化`think\App`类，可以方便的操作容器、绑定和调用对象实例。 ~~~ // 绑定类到容器 app()->test = new Test; // 实例调用 $test = app()->test; ~~~ 也就是说，你可以在任何地方使用`app()`方法调用容器中的任何类。 ~~~ // 调用配置类 app()->config->get('app_name'); // 调用session类 app()->session->get('user_name'); ~~~ ### 自动注入容器的更多使用主要用于依赖注入，和5.0自动注入的方式有所区别，类的绑定操作不再使用`Request`对象而是直接注册到容器中，并且支持模型事件和数据库事件的依赖注入，依赖注入会首先检查容器中是否注册过该对象实例，如果有的话就会自动注入，例如：我们可以给路由绑定模型对象实例 ~~~ Route::get('user/:id','index/Index/hello') ->model('\app\index\model\User'); ~~~ 然后在操作方法中自动注入User模型 ~~~ <?php namespace app\index\controller; use app\index\model\User; use think\Controller; class Index extends Controller { public function hello(User $user) { return 'Hello,'.$user->name; } } ~~~ ## 自定义实例化 `V5.1.13+`版本开始，容器中的对象实例化支持自定义，可以在你的容器中需要依赖注入的对象中增加`__make`方法定义，例如：如果你希望`User`模型类在依赖注入的时候使用自定义实例化的方式，可以用下面的方法。 ~~~ <?php namespace app\index\model; use think\Model; use think\db\Query; class User extends Model { public static function __make(Query $query) { return (new self())->setQuery($query); } } ~~~