簡(jiǎn)介
服務(wù)容器就是一個(gè)普通的容器点寥,用來封裝類的實(shí)例,然后在需要的時(shí)候再取出來。用更專業(yè)的術(shù)語來說是服務(wù)容器實(shí)現(xiàn)了控制反轉(zhuǎn)(Inversion of Control,縮寫為IoC)贮配,
意思是正常情況下類A需要一個(gè)類B的時(shí)候,我們需要自己去new類B塞赂,意味著我們必須知道類B的更多細(xì)節(jié),比如構(gòu)造函數(shù)昼蛀,隨著項(xiàng)目的復(fù)雜性增大宴猾,這種依賴是毀滅性的〉鹦控制反轉(zhuǎn)的意思就是仇哆,將類A主動(dòng)獲取類B的過程顛倒過來變成被動(dòng),類A只需要聲明它需要什么夫植,然后由容器提供讹剔。
樣做的好處是油讯,類A不依賴于類B的實(shí)現(xiàn),這樣在一定程度上解決了耦合問題延欠。
在Laravel的服務(wù)容器中陌兑,為了實(shí)現(xiàn)控制反轉(zhuǎn),可以有以下兩種:
- 依賴注入(Dependency Injection)由捎。
- 綁定兔综。
依賴注入
依賴注入是一種類型提示,舉官網(wǎng)的例子
<?php
namespace App\Http\Controllers;
use App\User;
use App\Repositories\UserRepository;
use App\Http\Controllers\Controller;
class UserController extends Controller
{
/**
* 用于獲取用戶數(shù)據(jù)
*
* @var UserRepository
*/
protected $users;
/**
* 構(gòu)造方法狞玛,聲明所需要的類型
*
* @param UserRepository $users
* @return void
*/
public function __construct(UserRepository $users)
{
$this->users = $users;
}
/**
* Show the profile for the given user.
*
* @param int $id
* @return Response
*/
public function show($id)
{
$user = $this->users->find($id);
return view('user.profile', ['user' => $user]);
}
}
在本例中软驰,UserController 需要從數(shù)據(jù)源獲取用戶,所以心肪,我們注入了一個(gè)可以獲取用戶的服務(wù) UserRepository锭亏,其扮演的角色類似使用 Eloquent 從數(shù)據(jù)庫獲取用戶信息。
這里UserController
需要一個(gè)UserRepository
實(shí)例硬鞍,我們只需在構(gòu)造方法中聲明我們需要的類型慧瘤,容器在實(shí)例化UserController
時(shí)會(huì)自動(dòng)生成UserRepository
的實(shí)例(或者實(shí)現(xiàn)類,因?yàn)?code>UserRepository可以為接口)膳凝,而不用主動(dòng)去獲取UserRepository
的實(shí)例碑隆,這樣也就避免了了解UserRepository
的更多細(xì)節(jié),也不用解決UserRepository
所產(chǎn)生的依賴蹬音,我們所做的僅僅是聲明我們所需要的類型上煤,所有的依賴問題都交給容器去解決。
綁定
幾乎所有的服務(wù)容器綁定都是在服務(wù)提供者中完成著淆。
注:如果一個(gè)類沒有基于任何接口那么就沒有必要將其綁定到容器劫狠。容器并不需要被告知如何構(gòu)建對(duì)象,因?yàn)樗鼤?huì)使用 PHP 的反射服務(wù)自動(dòng)解析出具體的對(duì)象永部。
綁定操作一般在 服務(wù)提供者 ServiceProviders
中的register
方法中独泞,最基本的綁定是容器的bind
方法,它接受一個(gè)類的別名或者全名和一個(gè)閉包來獲取實(shí)例:
簡(jiǎn)單的綁定
在一個(gè)服務(wù)提供者中苔埋,可以通過 $this->app 變量訪問容器懦砂,然后使用 bind 方法注冊(cè)一個(gè)綁定,該方法需要兩個(gè)參數(shù)组橄,第一個(gè)參數(shù)是我們想要注冊(cè)的類名或接口名稱荞膘,第二個(gè)參數(shù)是返回類的實(shí)例的閉包:
$this->app->bind('blogConfig', function ($app) {
return new MapRepository();
});
$this->app->bind('HelpSpot\API', function ($app) {
return new HelpSpot\API($app->make('HttpClient'));
});
綁定一個(gè)單例
singleton
方法和bind
寫法沒什么區(qū)別,singleton
方法綁定一個(gè)只需要解析一次的類或接口到容器,然后接下來對(duì)容器的調(diào)用將會(huì)返回同一個(gè)實(shí)例:
$this->app->singleton('HelpSpot\API', function ($app) {
return new HelpSpot\API($app->make('HttpClient'));
});
綁定實(shí)例
你還可以使用 instance 方法綁定一個(gè)已存在的對(duì)象實(shí)例到容器,隨后調(diào)用容器將總是返回給定的實(shí)例:
$api = new HelpSpot\API(new HttpClient);
$this->app->instance('HelpSpot\Api', $api);
上文中提到的request實(shí)例就是通過這種方法綁定到容器的:
$this->app->instance('request', $request);
綁定原始值
你可能有一個(gè)接收注入類的類玉工,同時(shí)需要注入一個(gè)原生的數(shù)值比如整型羽资,可以結(jié)合上下文輕松注入這個(gè)類需要的任何值:
$this->app->when('App\Http\Controllers\UserController')
->needs('$variableName')
->give($value);
綁定接口到實(shí)現(xiàn)
服務(wù)容器的一個(gè)非常強(qiáng)大的功能是其綁定接口到實(shí)現(xiàn)。我們假設(shè)有一個(gè) EventPusher
接口及其實(shí)現(xiàn)類RedisEventPusher
遵班,編寫完該接口的 RedisEventPusher
實(shí)現(xiàn)后屠升,就可以將其注冊(cè)到服務(wù)容器:
$this->app->bind(
'App\Contracts\EventPusher',
'App\Services\RedisEventPusher'
);
這段代碼告訴容器當(dāng)一個(gè)類需要 EventPusher
的實(shí)現(xiàn)時(shí)將會(huì)注入RedisEventPusher
潮改,現(xiàn)在我們可以在構(gòu)造器或者任何其它通過服務(wù)容器注入依賴的地方進(jìn)行 EventPusher 接口的依賴注入:
use App\Contracts\EventPusher;
/**
* 創(chuàng)建一個(gè)新的類實(shí)例
*
* @param EventPusher $pusher
* @return void
*/
public function __construct(EventPusher $pusher){
$this->pusher = $pusher;
}
上下文綁定
有時(shí)侯我們可能有兩個(gè)類使用同一個(gè)接口,但我們希望在每個(gè)類中注入不同實(shí)現(xiàn)腹暖,例如汇在,兩個(gè)控制器依賴 Illuminate\Contracts\Filesystem\Filesystem
契約 的不同實(shí)現(xiàn)。Laravel 為此定義了簡(jiǎn)單微服、平滑的接口:
use Illuminate\Support\Facades\Storage;
use App\Http\Controllers\VideoController;
use App\Http\Controllers\PhotoControllers;
use Illuminate\Contracts\Filesystem\Filesystem;
$this->app->when(PhotoController::class)
->needs(Filesystem::class)
->give(function () {
return Storage::disk('local');
});
$this->app->when(VideoController::class)
->needs(Filesystem::class)
->give(function () {
return Storage::disk('s3');
});
標(biāo)簽
少數(shù)情況下趾疚,我們需要解析特定分類下的所有綁定,例如以蕴,你正在構(gòu)建一個(gè)接收多個(gè)不同 Report
接口實(shí)現(xiàn)的報(bào)告聚合器糙麦,在注冊(cè)完 Report
實(shí)現(xiàn)之后,可以通過 tag 方法給它們分配一個(gè)標(biāo)簽:
$this->app->bind('SpeedReport', function () {
//
});
$this->app->bind('MemoryReport', function () {
//
});
$this->app->tag(['SpeedReport', 'MemoryReport'], 'reports');
這些服務(wù)被打上標(biāo)簽后丛肮,可以通過 tagged
方法來輕松解析它們:
$this->app->bind('ReportAggregator', function ($app) {
return new ReportAggregator($app->tagged('reports'));
});
解析
也就是獲取綁定的實(shí)例:
獲取方法
1. app('HelpSpot\API');
2. app()->make('HelpSpot\API');
3. app()['HelpSpot\API'];
4. resolve('HelpSpot\API');
以上四種方法均會(huì)返回獲得HelpSpot\API
的實(shí)例赡磅。
區(qū)別是在一次請(qǐng)求的生命周期中:
bind方法的閉包會(huì)在每一次調(diào)用以上四種方法時(shí)執(zhí)行,
singleton方法的閉包只會(huì)執(zhí)行一次宝与。
在使用中焚廊,如果每一個(gè)類要獲的不同的實(shí)例,或者需要“個(gè)性化”的實(shí)例時(shí)习劫,這時(shí)我們需要用bind方法以免這次的使用對(duì)下次的使用造成影響咆瘟;
如果實(shí)例化一個(gè)類比較耗時(shí)或者類的方法不依賴該生成的上下文,那么我們可以使用singleton方法綁定诽里。singleton方法綁定的好處就是袒餐,如果在一次請(qǐng)求中我們多次使用某個(gè)類,那么只生成該類的一個(gè)實(shí)例將節(jié)省時(shí)間和空間谤狡。
自動(dòng)注入
最后灸眼,也是最常用的,你可以簡(jiǎn)單的通過在類的構(gòu)造函數(shù)中對(duì)依賴進(jìn)行類型提示來從容器中解析對(duì)象墓懂,控制器焰宣、事件監(jiān)聽器、隊(duì)列任務(wù)捕仔、中間件等都是通過這種方式匕积。在實(shí)踐中,這是大多數(shù)對(duì)象從容器中解析的方式榜跌。
容器會(huì)自動(dòng)為其解析類注入依賴闸天,例如,你可以在控制器的構(gòu)造函數(shù)中為應(yīng)用定義的倉庫進(jìn)行類型提示斜做,該倉庫會(huì)自動(dòng)解析并注入該類:
<?php
namespace App\Http\Controllers;
use App\Users\Repository as UserRepository;
class UserController extends Controller{
/**
* 用戶倉庫實(shí)例
*/
protected $users;
/**
* 創(chuàng)建一個(gè)控制器實(shí)例
*
* @param UserRepository $users
* @return void
*/
public function __construct(UserRepository $users)
{
$this->users = $users;
}
/**
* 通過指定ID顯示用戶
*
* @param int $id
* @return Response
*/
public function show($id)
{
//
}
}
容器事件
服務(wù)容器在每一次解析對(duì)象時(shí)都會(huì)觸發(fā)一個(gè)事件,可以使用 resolving
方法監(jiān)聽該事件:
$this->app->resolving(function ($object, $app) {
// Called when container resolves object of any type...
});
$this->app->resolving(HelpSpot\API::class, function ($api, $app) {
// Called when container resolves objects of type "HelpSpot\API"...
});
正如你所看到的湾揽,被解析的對(duì)象將會(huì)傳遞給回調(diào)函數(shù)瓤逼,從而允許你在對(duì)象被傳遞給消費(fèi)者之前為其設(shè)置額外屬性笼吟。