核心概念 · laravel 5.4

<article><h1>Laravel 服務容器解析</h1><ul><li><a href="#introduction">簡介</a></li><li><a href="#binding">綁定</a><ul><li><a href="#binding-basics">綁定基礎</a></li><li><a href="#binding-interfaces-to-implementations">綁定接口至實現</a></li><li><a href="#contextual-binding">情境綁定</a></li><li><a href="#tagging">標記</a></li></ul></li><li><a href="#resolving">解析</a><ul><li><a href="#the-make-method">Make 方法</a></li><li><a href="#automatic-injection">自動注入</a></li></ul></li><li><a href="#container-events">容器事件</a></li></ul><a name="introduction"></a><h2><a href="#introduction">簡介</a></h2>Laravel 服務容器是管理類依賴和運行依賴注入的有力工具。依賴注入是一個花俏的名詞，它實質上是指：類的依賴通過構造器或在某些情況下通過「setter」方法進行「注入」。來看一個簡單的例子：<pre class=" language-php"><code class=" language-php"><?php namespace App\Http\Controllers; use App\User; use App\Repositories\UserRepository; use App\Http\Controllers\Controller; class UserController extends Controller { /** * User Repository 的實現。 * * @var UserRepository */ protected $users; /** * 創建新的控制器實例。 * * @param UserRepository $users * @return void */ public function __construct(UserRepository $users) { $this->users = $users; } /** * 顯示指定用戶的詳細信息。 * * @param int $id * @return Response */ public function show($id) { $user = $this->users->find($id); return view('user.profile', ['user' => $user]); } }</code></pre>在這個例子中，控制器 <code class=" language-php">UserController</code> 需要從數據源中獲取 users 。因此，我們要 注入 可以獲取 users 的服務。在這種情況下， <code class=" language-php">UserRepository</code> 可能是通過使用 <a href="/docs/5.4/eloquent">Eloquent</a> 來從數據庫中獲取 user 信息。因為 <code class=" language-php">UserRepository</code> 是通過注入獲取，所以我們可以容易地切換為其他實現。當測試應用程序時，我們還可以輕松地「mock」，或創建假的 <code class=" language-php">UserRepository</code> 實例。在構建強大的應用程序，和為 Laravel 核心貢獻代碼時，必須深入理解 Laravel 的服務容器。<a name="binding"></a><h2><a href="#binding">綁定</a></h2><a name="binding-basics"></a><h3>綁定基礎</h3>幾乎所有服務容器的綁定都是在 <a href="/docs/5.4/providers">服務提供者</a> 中進行的，所以下面的例子將示范在該情景中使用容器。<blockquote class="has-icon tip"><div class="flag"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:a="http://ns.adobe.com/AdobeSVGViewerExtensions/3.0/" version="1.1" x="0px" y="0px" width="56.6px" height="87.5px" viewBox="0 0 56.6 87.5" enable-background="new 0 0 56.6 87.5" xml:space="preserve"><path fill="#FFFFFF" d="M28.7 64.5c-1.4 0-2.5-1.1-2.5-2.5v-5.7 -5V41c0-1.4 1.1-2.5 2.5-2.5s2.5 1.1 2.5 2.5v10.1 5 5.8C31.2 63.4 30.1 64.5 28.7 64.5zM26.4 0.1C11.9 1 0.3 13.1 0 27.7c-0.1 7.9 3 15.2 8.2 20.4 0.5 0.5 0.8 1 1 1.7l3.1 13.1c0.3 1.1 1.3 1.9 2.4 1.9 0.3 0 0.7-0.1 1.1-0.2 1.1-0.5 1.6-1.8 1.4-3l-2-8.4 -0.4-1.8c-0.7-2.9-2-5.7-4-8 -1-1.2-2-2.5-2.7-3.9C5.8 35.3 4.7 30.3 5.4 25 6.7 14.5 15.2 6.3 25.6 5.1c13.9-1.5 25.8 9.4 25.8 23 0 4.1-1.1 7.9-2.9 11.2 -0.8 1.4-1.7 2.7-2.7 3.9 -2 2.3-3.3 5-4 8L41.4 53l-2 8.4c-0.3 1.2 0.3 2.5 1.4 3 0.3 0.2 0.7 0.2 1.1 0.2 1.1 0 2.2-0.8 2.4-1.9l3.1-13.1c0.2-0.6 0.5-1.2 1-1.7 5-5.1 8.2-12.1 8.2-19.8C56.4 12 42.8-1 26.4 0.1zM43.7 69.6c0 0.5-0.1 0.9-0.3 1.3 -0.4 0.8-0.7 1.6-0.9 2.5 -0.7 3-2 8.6-2 8.6 -1.3 3.2-4.4 5.5-7.9 5.5h-4.1H28h-0.5 -3.6c-3.5 0-6.7-2.4-7.9-5.7l-0.1-0.4 -1.8-7.8c-0.4-1.1-0.8-2.1-1.2-3.1 -0.1-0.3-0.2-0.5-0.2-0.9 0.1-1.3 1.3-2.1 2.6-2.1H41C42.4 67.5 43.6 68.2 43.7 69.6zM37.7 72.5H26.9c-4.2 0-7.2 3.9-6.3 7.9 0.6 1.3 1.8 2.1 3.2 2.1h4.1 0.5 0.5 3.6c1.4 0 2.7-0.8 3.2-2.1L37.7 72.5z"></path></svg></div> 但是，如果類沒有依賴任何接口，那么就沒有必要將類綁定到容器中了。容器綁定時，并不需要指定如何構建這些類，因為容器中會通過 PHP 的反射自動解析對象。</blockquote><h4>簡單綁定</h4>在服務提供者中，你經常可以通過 <code class=" language-php">$this->app</code> 屬性訪問容器。我們可以通過 <code class=" language-php">bind</code> 方法注冊一個綁定，通過傳遞注冊類或接口的名稱、及返回該實例的 <code class=" language-php">Closure</code> 作為參數：<pre class=" language-php"><code class=" language-php">$this->app->bind('HelpSpot\API', function ($app) { return new HelpSpot\API($app->make('HttpClient')); });</code></pre>注意，我們將獲得的容器本身作為參數傳遞到解析器中，這樣就可以使用容器來解決綁定對象對容器的子依賴。<h4>綁定一個單例</h4>通過 <code class=" language-php">singleton</code> 方法可以綁定一個只會被解析一次的類或接口到容器中。且后面的調用都會從容器中返回相同的實例：<pre class=" language-php"><code class=" language-php">$this->app->singleton('HelpSpot\API', function ($app) { return new HelpSpot\API($app->make('HttpClient')); });</code></pre><h4>綁定實例</h4>你也可以使用 <code class=" language-php">instance</code> 方法綁定一個已經存在的對象至容器中。后面的調用都會從容器中返回指定的實例：<pre class=" language-php"><code class=" language-php">$api = new HelpSpot\API(new HttpClient); $this->app->instance('HelpSpot\Api', $api);</code></pre><h4>綁定初始數據</h4>有時，你的類不僅需要注入類，還需要注入一些原始數據，如一個整數。此時，你可以容易地通過情景綁定注入需要的任何值：<pre class=" language-php"><code class=" language-php">$this->app->when('App\Http\Controllers\UserController') ->needs('$variableName') ->give($value);</code></pre><a name="binding-interfaces-to-implementations"></a><h3>綁定接口至實現</h3>服務容器有一個強大的功能，就是將一個指定接口的實現綁定到接口上。例如，如果我們有一個 <code class=" language-php">EventPusher</code> 接口和一個它的實現類 <code class=" language-php">RedisEventPusher</code> 。編寫完接口的 <code class=" language-php">RedisEventPusher</code> 實現類后，我們就可以在服務容器中像下面例子一樣注冊它：<pre class=" language-php"><code class=" language-php">$this->app->bind( 'App\Contracts\EventPusher', 'App\Services\RedisEventPusher' );</code></pre>這么做會告訴容器當一個類需要 <code class=" language-php">EventPusher</code> 接口的實例時， <code class=" language-php">RedisEventPusher</code> 的實例將會被容器注入。現在我們就可以在構造函數中，或者任何其他需要通過容器注入依賴的地方，使用 <code class=" language-php">EventPusher</code> 接口的類型提示：<pre class=" language-php"><code class=" language-php">use App\Contracts\EventPusher; /** * Create a new class instance. * * @param EventPusher $pusher * @return void */ public function __construct(EventPusher $pusher) { $this->pusher = $pusher; }</code></pre><a name="contextual-binding"></a><h3>情境綁定</h3>有時候，你可能有兩個類使用到相同的接口，但你希望每個類都能注入不同的實現。例如，兩個控制器可能需要依賴不同的 <code class=" language-php">Illuminate\Contracts\Filesystem\Filesystem</code> <a href="/docs/5.4/contracts">契約</a> 的實現類。 Laravel 為此定義了一種簡單、平滑的接口：<pre class=" language-php"><code class=" language-php">use Illuminate\Support\Facades\Storage; use App\Http\Controllers\PhotoController; use App\Http\Controllers\VideoController; 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'); });</code></pre><a name="tagging"></a><h3>標記</h3>有時候，你可能需要解析某個「分類」下的所有綁定。例如，你正在構建一個報表的聚合器，它需要接受不同 <code class=" language-php">Report</code> 接口的實例。分別注冊了 <code class=" language-php">Report</code> 實例后，你可以使用 <code class=" language-php">tag</code> 方法為他們賦予一個標簽：<pre class=" language-php"><code class=" language-php">$this->app->bind('SpeedReport', function () { // }); $this->app->bind('MemoryReport', function () { // }); $this->app->tag(['SpeedReport', 'MemoryReport'], 'reports');</code></pre>一旦服務被標記后，你可以通過 <code class=" language-php">tagged</code> 方法輕松地將它們全部解析：<pre class=" language-php"><code class=" language-php">$this->app->bind('ReportAggregator', function ($app) { return new ReportAggregator($app->tagged('reports')); });</code></pre><a name="resolving"></a><h2><a href="#resolving">解析</a></h2><a name="the-make-method"></a><h4><code class=" language-php">make</code> 方法</h4>你可以在服務容器外使用 <code class=" language-php">make</code> 方法來獲得一個實例化的類。它接受你希望解析的類或是接口名稱作為參數：<pre class=" language-php"><code class=" language-php">$api = $this->app->make('HelpSpot\API');</code></pre>如果你的代碼不能直接使用 <code class=" language-php">$app</code> 變量，你可以使用全局的 <code class=" language-php">resolve</code> 助手：<pre class=" language-php"><code class=" language-php">$api = resolve('HelpSpot\API');</code></pre><a name="automatic-injection"></a><h4>自動注入</h4>另外，并且也是重要的，你可以在類的構造函數中對依賴使用「類型提示」，依賴的類將會被容器自動進行解析，包括在 <a href="/docs/5.4/controllers">控制器</a> ， <a href="/docs/5.4/events">事件監聽器</a> ， <a href="/docs/5.4/queues">隊列任務</a> ， <a href="/docs/5.4/middleware">中間件</a> 等地方。事實上，這也是大部分類被容器解析的方式。例如，你可以在控制器的構造函數中對應用程序定義的 <code class=" language-php">Repository</code> 使用類型提示。這樣 <code class=" language-php">Repository</code> 實例會被自動解析并注入到類中：<pre class=" language-php"><code class=" language-php"><?php namespace App\Http\Controllers; use App\Users\Repository as UserRepository; class UserController extends Controller { /** * user repository 實例。 */ protected $users; /** * 控制器構造方法。 * * @param UserRepository $users * @return void */ public function __construct(UserRepository $users) { $this->users = $users; } /** * 顯示指定 ID 的用戶信息。 * * @param int $id * @return Response */ public function show($id) { // } }</code></pre><a name="container-events"></a><h2><a href="#container-events">容器事件</a></h2>每當服務容器解析一個對象時就會觸發一個事件。你可以使用 <code class=" language-php">resolving</code> 方法監聽這個事件：<pre class=" language-php"><code class=" language-php">$this->app->resolving(function ($object, $app) { // 解析任何類型的對象時都會調用該方法... }); $this->app->resolving(HelpSpot\API::class, function ($api, $app) { // 解析「HelpSpot\API」類型的對象時調用... });</code></pre>如你所見，被解析的對象會被傳遞至回調中，讓你在對象被傳遞到消費者前可以設置任何額外屬性到對象上。</article>