Service Container

簡介
- 不需設定的解析
- 什麼時候該使用 Container
繫結 (Binding)
解析
- Make 方法
- 自動插入
叫用方法與插入
Container 事件
PSR-11

簡介

Laravel 的 Service Container 是用來管理類別依賴與進行依賴注入的一個有力工具。依賴注入只是個花俏的詞，基本上依賴注入就代表：類別的依賴是通過其建構函式來「注入」進類別的，或者，某些情況下是使用「Setter」方法。

來看看一個簡單的例子：

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use App\Repositories\UserRepository;
 7use App\Models\User;
 8use Illuminate\View\View;
 9 
10class UserController extends Controller
11{
12    /**
13     * Create a new controller instance.
14     */
15    public function __construct(
16        protected UserRepository $users,
17    ) {}
18 
19    /**
20     * Show the profile for the given user.
21     */
22    public function show(string $id): View
23    {
24        $user = $this->users->find($id);
25 
26        return view('user.profile', ['user' => $user]);
27    }
28} 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use App\Repositories\UserRepository;
 7use App\Models\User;
 8use Illuminate\View\View;
 9 
10class UserController extends Controller
11{
12    /**
13     * Create a new controller instance.
14     */
15    public function __construct(
16        protected UserRepository $users,
17    ) {}
18 
19    /**
20     * Show the profile for the given user.
21     */
22    public function show(string $id): View
23    {
24        $user = $this->users->find($id);
25 
26        return view('user.profile', ['user' => $user]);
27    }
28}

在這個例子中，UserController 需要從某個資料來源取得使用者。因此，我們會將一個能取得使用者的服務（Service）注入進去。在這個脈絡下，UserRepository 通常會使用 Eloquent 來從資料庫內取得使用者資訊。不過，由於該 Repository 是注入進去的，因此我們可以很輕鬆地將其替換成其他實作。我們也可以很輕鬆地在測試專案時「模擬 (Mock)」或是建立一個 UserRepository 的假實作。

要想建立強大的大型專案、或是參與貢獻 Laravel 核心，就必須要深入瞭解 Laravel 的 Service Container。

不需設定的解析

若某個類別沒有依賴，或是只依賴其他實體類別 (即非介面的依賴)，就不需要告訴 Container 如何解析這個類別。舉例來說，可以在 routes/web.php 檔中加上下列程式碼：

 1<?php
 2 
 3class Service
 4{
 5    // ...
 6}
 7 
 8Route::get('/', function (Service $service) {
 9    die(get_class($service));
10}); 1<?php
 2 
 3class Service
 4{
 5    // ...
 6}
 7 
 8Route::get('/', function (Service $service) {
 9    die(get_class($service));
10});

在這個例子中，打開網站的 / 路由就會自動解析 Service 類別並將其注入路由的處理程式中。這是個顛覆性的方法。因為這表示不需要肥大的設定檔，就能通過依賴注入來進行開發。

所幸，用 Laravel 撰寫專案時會寫到的許多類別都會自動通過 Container 來接收依賴，包含Controller、事件監聽程式、Middleware …等其他類別。此外，還可以在佇列任務的 handle 方法內型別提示依賴。一旦你試過自動與無需設定的依賴注入後，就很難不用依賴注入來開發了。

什麼時候要使用 Container

多虧有不需設定的解析，通常只需要在路由、Controller、事件監聽程式等地方型別提示即可，不需手動與 Container 互動。舉例來說，可以在路由定義上型別提示 Illuminate\Http\Request 物件，就可輕鬆存取目前的請求。就算我們從來沒寫過與 Container 互動的程式碼，Container 依然能自動幫我們將這些依賴注入進去：

1use Illuminate\Http\Request;
2 
3Route::get('/', function (Request $request) {
4    // ...
5});1use Illuminate\Http\Request;
2 
3Route::get('/', function (Request $request) {
4    // ...
5});

在許多情況下，多虧有自動依賴注入以及 Facades，我們完全不需要從 Container 上手動繫結或解析任何東西，就可以使用 Laravel 來進行專案開發。那麼，什麼時候才會需要手動操作 Container 呢？ 讓我們來看看兩個情況。

首先，若寫了一個實作介面的類別，而希望能在路由或類別建構函式上型別提示這個介面，就必須要告訴 Container 要如何解析該介面。再來，若是在撰寫 Laravel 套件，並希望將該套件分享給其他 Laravel 開發者，則可能會需要將套件的服務繫結到 Container 上。

繫結 (Binding)

「繫結」基礎

簡單繫結

幾乎所有的服務 Container 繫結都會註冊在 Service Provider 上。因此，這裡大多數的範例都會在這個脈絡下展示使用 Container。

在 Service Provider 中，總是能使用 $this->app 屬性來存取 Container。我們可以使用 bind 方法來註冊一個繫結，並將我們想註冊的類別或介面與用來回傳該類別實體的閉包一起傳入。

1use App\Services\Transistor;
2use App\Services\PodcastParser;
3use Illuminate\Contracts\Foundation\Application;
4 
5$this->app->bind(Transistor::class, function (Application $app) {
6    return new Transistor($app->make(PodcastParser::class));
7});1use App\Services\Transistor;
2use App\Services\PodcastParser;
3use Illuminate\Contracts\Foundation\Application;
4 
5$this->app->bind(Transistor::class, function (Application $app) {
6    return new Transistor($app->make(PodcastParser::class));
7});

請注意，我們會收到 Container 自己作為該解析程式的一個引數。我們可以接著使用該 Container 來解析我們正在建構的物件的其他子依賴。

就像之前提過的，我們通常會在 Service Provider 內操作 Container。不過，若想在 Service Provider 外操作 Container，則可以使用 App Facade：

1use App\Services\Transistor;
2use Illuminate\Contracts\Foundation\Application;
3use Illuminate\Support\Facades\App;
4 
5App::bind(Transistor::class, function (Application $app) {
6    // ...
7});1use App\Services\Transistor;
2use Illuminate\Contracts\Foundation\Application;
3use Illuminate\Support\Facades\App;
4 
5App::bind(Transistor::class, function (Application $app) {
6    // ...
7});

若類別沒有依賴任何介面，就不需要將其繫結到 Container 上。不需要告訴 Container 如何建構這些物件，因為這些物件可以通過 Reflection 自動被解析。

建構單例 (Singleton)

singleton 方法可將一些只需要解析一次的類別或介面繫結至 Container 內，解析完單例繫結後，接下來呼叫 Container 都會回傳相同的物件實體：

1use App\Services\Transistor;
2use App\Services\PodcastParser;
3use Illuminate\Contracts\Foundation\Application;
4 
5$this->app->singleton(Transistor::class, function (Application $app) {
6    return new Transistor($app->make(PodcastParser::class));
7});1use App\Services\Transistor;
2use App\Services\PodcastParser;
3use Illuminate\Contracts\Foundation\Application;
4 
5$this->app->singleton(Transistor::class, function (Application $app) {
6    return new Transistor($app->make(PodcastParser::class));
7});

繫結限定作用範圍的單例

scoped 方法用來將一些只在給定 Laravel 請求 / 任務生命週期中被解析一次的類別或介面繫結到 Container 中。雖然這個方法與 singleton 方法類似，不過使用 scoped 方法繫結的實體會在每次 Laravel 開始新「生命週期」時被清除，如：Laravel Octane 背景工作角色處理新請求時，或是 Laravel 佇列背景工作角色處理新任務時。

1use App\Services\Transistor;
2use App\Services\PodcastParser;
3use Illuminate\Contracts\Foundation\Application;
4 
5$this->app->scoped(Transistor::class, function (Application $app) {
6    return new Transistor($app->make(PodcastParser::class));
7});1use App\Services\Transistor;
2use App\Services\PodcastParser;
3use Illuminate\Contracts\Foundation\Application;
4 
5$this->app->scoped(Transistor::class, function (Application $app) {
6    return new Transistor($app->make(PodcastParser::class));
7});

繫結實體

也可以使用 instance 方法來將現有的物件實體繫結到 Container 上。接下來對 Container 的呼叫都會回傳給定的實體：

1use App\Services\Transistor;
2use App\Services\PodcastParser;
3 
4$service = new Transistor(new PodcastParser);
5 
6$this->app->instance(Transistor::class, $service);1use App\Services\Transistor;
2use App\Services\PodcastParser;
3 
4$service = new Transistor(new PodcastParser);
5 
6$this->app->instance(Transistor::class, $service);

將介面繫結至實作

Service Container 其中一個非常強大的功能就是能將介面繫結到給定的實作上。舉例來說，假設我們有一個 EventPusher 介面，以及一個 RedisEventPusher 實作。寫好這個介面的 RedisEventPusher 實作程式後，我們就像這樣將其註冊到 Service Container 上：

1use App\Contracts\EventPusher;
2use App\Services\RedisEventPusher;
3 
4$this->app->bind(EventPusher::class, RedisEventPusher::class);1use App\Contracts\EventPusher;
2use App\Services\RedisEventPusher;
3 
4$this->app->bind(EventPusher::class, RedisEventPusher::class);

這個陳述式會告訴 Container 應在有類別需要 EventPusher 的實作時將 RedisEventPusher 注入進去。接著，我們可以在某個會被 Container 解析的類別之建構函式上型別提示 EventPusher 介面。請記得，Laravel 專案中的 Controller、事件監聽程式、Middleware、以及其他多種類型的類別都是使用 Container 來解析的：

1use App\Contracts\EventPusher;
2 
3/**
4 * Create a new class instance.
5 */
6public function __construct(
7    protected EventPusher $pusher
8) {}1use App\Contracts\EventPusher;
2 
3/**
4 * Create a new class instance.
5 */
6public function __construct(
7    protected EventPusher $pusher
8) {}

基於上下文的繫結

有時候，可能會有兩個類別使用相同的介面，但又想在各個類別上注入不同的實作。舉例來說，可能有兩個 Controller 依賴不同實作的 Illuminate\Contracts\Filesystem\Filesystem Contract。Laravel 提供了一個簡單但流暢的介面來定義這種行為：

 1use App\Http\Controllers\PhotoController;
 2use App\Http\Controllers\UploadController;
 3use App\Http\Controllers\VideoController;
 4use Illuminate\Contracts\Filesystem\Filesystem;
 5use Illuminate\Support\Facades\Storage;
 6 
 7$this->app->when(PhotoController::class)
 8          ->needs(Filesystem::class)
 9          ->give(function () {
10              return Storage::disk('local');
11          });
12 
13$this->app->when([VideoController::class, UploadController::class])
14          ->needs(Filesystem::class)
15          ->give(function () {
16              return Storage::disk('s3');
17          }); 1use App\Http\Controllers\PhotoController;
 2use App\Http\Controllers\UploadController;
 3use App\Http\Controllers\VideoController;
 4use Illuminate\Contracts\Filesystem\Filesystem;
 5use Illuminate\Support\Facades\Storage;
 6 
 7$this->app->when(PhotoController::class)
 8          ->needs(Filesystem::class)
 9          ->give(function () {
10              return Storage::disk('local');
11          });
12 
13$this->app->when([VideoController::class, UploadController::class])
14          ->needs(Filesystem::class)
15          ->give(function () {
16              return Storage::disk('s3');
17          });

繫結原生型別

有時候可能會有類別要接收注入的類別，但同時也需要注入原生型別的值，如整數。可以輕鬆地使用基於上下文的繫結來注入任何類別所需的值：

1use App\Http\Controllers\UserController;
2 
3$this->app->when(UserController::class)
4          ->needs('$variableName')
5          ->give($value);1use App\Http\Controllers\UserController;
2 
3$this->app->when(UserController::class)
4          ->needs('$variableName')
5          ->give($value);

有時候，某個類別可能會依賴一個包含有標記實體的陣列。使用 giveTagged 方法，就可以輕鬆將所有有該標籤的 Container 繫結注入進去：

1$this->app->when(ReportAggregator::class)
2    ->needs('$reports')
3    ->giveTagged('reports');1$this->app->when(ReportAggregator::class)
2    ->needs('$reports')
3    ->giveTagged('reports');

若有需要注入來自專案設定檔的值，則可使用 giveConfig 方法：

1$this->app->when(ReportAggregator::class)
2    ->needs('$timezone')
3    ->giveConfig('app.timezone');1$this->app->when(ReportAggregator::class)
2    ->needs('$timezone')
3    ->giveConfig('app.timezone');

繫結有型別提示的 Variadic 參數

有時候，某個類別可能會需要使用 Variadic 建構函式引數來接收一個包含型別提示物件的陣列：

 1<?php
 2 
 3use App\Models\Filter;
 4use App\Services\Logger;
 5 
 6class Firewall
 7{
 8    /**
 9     * The filter instances.
10     *
11     * @var array
12     */
13    protected $filters;
14 
15    /**
16     * Create a new class instance.
17     */
18    public function __construct(
19        protected Logger $logger,
20        Filter ...$filters,
21    ) {
22        $this->filters = $filters;
23    }
24} 1<?php
 2 
 3use App\Models\Filter;
 4use App\Services\Logger;
 5 
 6class Firewall
 7{
 8    /**
 9     * The filter instances.
10     *
11     * @var array
12     */
13    protected $filters;
14 
15    /**
16     * Create a new class instance.
17     */
18    public function __construct(
19        protected Logger $logger,
20        Filter ...$filters,
21    ) {
22        $this->filters = $filters;
23    }
24}

若使用基於上下文的繫結，則可以提供一個閉包給 give 方法來解析這個依賴。該閉包應回傳解析好的 Filter 實體的陣列：

1$this->app->when(Firewall::class)
2          ->needs(Filter::class)
3          ->give(function (Application $app) {
4                return [
5                    $app->make(NullFilter::class),
6                    $app->make(ProfanityFilter::class),
7                    $app->make(TooLongFilter::class),
8                ];
9          });1$this->app->when(Firewall::class)
2          ->needs(Filter::class)
3          ->give(function (Application $app) {
4                return [
5                    $app->make(NullFilter::class),
6                    $app->make(ProfanityFilter::class),
7                    $app->make(TooLongFilter::class),
8                ];
9          });

為了方便起見，當 Firewall 需要 Filter 實體的時候，也可以只提供一個包含要給 Container 解析的類別名稱的陣列：

1$this->app->when(Firewall::class)
2          ->needs(Filter::class)
3          ->give([
4              NullFilter::class,
5              ProfanityFilter::class,
6              TooLongFilter::class,
7          ]);1$this->app->when(Firewall::class)
2          ->needs(Filter::class)
3          ->give([
4              NullFilter::class,
5              ProfanityFilter::class,
6              TooLongFilter::class,
7          ]);

Variadic 參數的標籤依賴

有時候，某個類別可能會有型別提示為給定類別的 Variadic 參數 (Report ...$reports)。只要使用 needs 與 giveTagged 方法，就可以輕鬆將所有該標籤的 Container 繫結注入進給定依賴：

1$this->app->when(ReportAggregator::class)
2    ->needs(Report::class)
3    ->giveTagged('reports');1$this->app->when(ReportAggregator::class)
2    ->needs(Report::class)
3    ->giveTagged('reports');

1$this->app->bind(CpuReport::class, function () {
2    // ...
3});
4 
5$this->app->bind(MemoryReport::class, function () {
6    // ...
7});
8 
9$this->app->tag([CpuReport::class, MemoryReport::class], 'reports');1$this->app->bind(CpuReport::class, function () {
2    // ...
3});
4 
5$this->app->bind(MemoryReport::class, function () {
6    // ...
7});
8 
9$this->app->tag([CpuReport::class, MemoryReport::class], 'reports');

標記好服務後就可以輕鬆地通過 Container 的 tagged 方法來解析所有的這些服務：

1$this->app->bind(ReportAnalyzer::class, function (Application $app) {
2    return new ReportAnalyzer($app->tagged('reports'));
3});1$this->app->bind(ReportAnalyzer::class, function (Application $app) {
2    return new ReportAnalyzer($app->tagged('reports'));
3});

擴充繫結

extend 方法能修改解析過的服務。舉例來說，當某個服務被解析後，可以執行額外的程式碼來修改或設定這個服務。extend 方法接受兩個引數，第一個印數為要擴充的 Service 類別，以及一個回傳經過修改服務的閉包。該閉包會接收經過解析的服務，以及 Container 實體：

1$this->app->extend(Service::class, function (Service $service, Application $app) {
2    return new DecoratedService($service);
3});1$this->app->extend(Service::class, function (Service $service, Application $app) {
2    return new DecoratedService($service);
3});

解析

`make` 方法

可以使用 make 方法來從 Container 中解析一個類別實體。make 方法接收欲解析的類別或介面名稱：

1use App\Services\Transistor;
2 
3$transistor = $this->app->make(Transistor::class);1use App\Services\Transistor;
2 
3$transistor = $this->app->make(Transistor::class);

若該類別的某些依賴無法被 Container 解析，則可能需要將這些依賴以關聯式陣列傳入 makeWith 方法內。舉例來說，可以手動傳入 Transistor 服務所需要的 $id 建構函式引數：

1use App\Services\Transistor;
2 
3$transistor = $this->app->makeWith(Transistor::class, ['id' => 1]);1use App\Services\Transistor;
2 
3$transistor = $this->app->makeWith(Transistor::class, ['id' => 1]);

若不在 Service Provider 內，而是在專案中某處無法存取 $app 變數的地方，可以使用 App Facade 或 app 輔助函式來從 Container 內解析類別實體：

1use App\Services\Transistor;
2use Illuminate\Support\Facades\App;
3 
4$transistor = App::make(Transistor::class);
5 
6$transistor = app(Transistor::class);1use App\Services\Transistor;
2use Illuminate\Support\Facades\App;
3 
4$transistor = App::make(Transistor::class);
5 
6$transistor = app(Transistor::class);

若想將 Laravel Container 實體注入值 Container 正在解析的類別，則可以在該類別的建構函式中型別提示 Illuminate\Container\Container 類別：

1use Illuminate\Container\Container;
2 
3/**
4 * Create a new class instance.
5 */
6public function __construct(
7    protected Container $container
8) {}1use Illuminate\Container\Container;
2 
3/**
4 * Create a new class instance.
5 */
6public function __construct(
7    protected Container $container
8) {}

自動注入

此外，還有一點很重要的是，也可以在會由 Container 解析的類別之建構函式內對依賴進行型別提示。這類類別包含 Controller、事件處理程式、Middleware …等。此外，也可以在佇列任務的 handle 方法內對依賴進行型別提示。實務上來說，這也是大多數由 Container 解析物件的方法。

舉例來說，可以在某個 Controller 的建構函式內對一個 Repository 定義進行型別提示。該 Repository 會被自動解析並插入到該類別內：

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Repositories\UserRepository;
 6use App\Models\User;
 7 
 8class UserController extends Controller
 9{
10    /**
11     * Create a new controller instance.
12     */
13    public function __construct(
14        protected UserRepository $users,
15    ) {}
16 
17    /**
18     * Show the user with the given ID.
19     */
20    public function show(string $id): User
21    {
22        $user = $this->users->findOrFail($id);
23 
24        return $user;
25    }
26} 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Repositories\UserRepository;
 6use App\Models\User;
 7 
 8class UserController extends Controller
 9{
10    /**
11     * Create a new controller instance.
12     */
13    public function __construct(
14        protected UserRepository $users,
15    ) {}
16 
17    /**
18     * Show the user with the given ID.
19     */
20    public function show(string $id): User
21    {
22        $user = $this->users->findOrFail($id);
23 
24        return $user;
25    }
26}

方法叫用與注入

有時候我們可能會想在某個物件實體上叫用一個方法，並讓 Container 自動將該方法的相依內容注入進去。舉例來說，假設有下列類別：

 1<?php
 2 
 3namespace App;
 4 
 5use App\Repositories\UserRepository;
 6 
 7class UserReport
 8{
 9    /**
10     * Generate a new user report.
11     */
12    public function generate(UserRepository $repository): array
13    {
14        return [
15            // ...
16        ];
17    }
18} 1<?php
 2 
 3namespace App;
 4 
 5use App\Repositories\UserRepository;
 6 
 7class UserReport
 8{
 9    /**
10     * Generate a new user report.
11     */
12    public function generate(UserRepository $repository): array
13    {
14        return [
15            // ...
16        ];
17    }
18}

可以使用 Container 來像這樣叫用 generate 方法：

1use App\UserReport;
2use Illuminate\Support\Facades\App;
3 
4$report = App::call([new UserReport, 'generate']);1use App\UserReport;
2use Illuminate\Support\Facades\App;
3 
4$report = App::call([new UserReport, 'generate']);

call 方法接受任意 PHP Callable。Container 的 call 方法也可以用來在叫用時自動注入其相依性：

1use App\Repositories\UserRepository;
2use Illuminate\Support\Facades\App;
3 
4$result = App::call(function (UserRepository $repository) {
5    // ...
6});1use App\Repositories\UserRepository;
2use Illuminate\Support\Facades\App;
3 
4$result = App::call(function (UserRepository $repository) {
5    // ...
6});

Container 事件

Service Container 會在每次解析物件後觸發一個事件。可以通過 resolving 方法來監聽這個事件：

 1use App\Services\Transistor;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4$this->app->resolving(Transistor::class, function (Transistor $transistor, Application $app) {
 5    // 當 Container 在解析型別為「Transistor」時會被呼叫...
 6});
 7 
 8$this->app->resolving(function (mixed $object, Application $app) {
 9    // 當 Container 在解析任意型別的物件時會呼叫...
10}); 1use App\Services\Transistor;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4$this->app->resolving(Transistor::class, function (Transistor $transistor, Application $app) {
 5    // 當 Container 在解析型別為「Transistor」時會被呼叫...
 6});
 7 
 8$this->app->resolving(function (mixed $object, Application $app) {
 9    // 當 Container 在解析任意型別的物件時會呼叫...
10});

如你所見，被解析的物件會被傳入該回呼內，讓你能在物件被交給要求者之前對物件設定額外的屬性。

PSR-11

Laravel 的 Service Container 實作了 PSR-11 介面。因此，可以型別提示 PSR-11 Container 介面來取得 Laravel Container 的實體：

1use App\Services\Transistor;
2use Psr\Container\ContainerInterface;
3 
4Route::get('/', function (ContainerInterface $container) {
5    $service = $container->get(Transistor::class);
6 
7    // ...
8});1use App\Services\Transistor;
2use Psr\Container\ContainerInterface;
3 
4Route::get('/', function (ContainerInterface $container) {
5    $service = $container->get(Transistor::class);
6 
7    // ...
8});

若給定的識別元無法被解析，則會擲回例外。若該識別元從未被繫結，則該例外為 Psr\Container\NotFoundExceptionInterface 的實體。若該識別元有被繫結過，但無法解析，則會擲回 Psr\Container\ContainerExceptionInterface 的實體。

Service Container

留言