深入了解 Laravel 服務容器對於建立強大的大型應用程式以及為 Laravel 核心本身做出貢獻至關重要。

零配置解析

如果一個類別沒有依賴或只依賴於其他具體類別（而不是介面），則不需要指示容器如何解析該類別。例如，您可以將以下代碼放在 routes/web.php 檔案中：

<?php

class Service
{
    // ...
}

Route::get('/', function (Service $service) {
    dd($service::class);
});

在此範例中，訪問您應用程式的 / 路由將自動解析 Service 類別並將其注入到您路由的處理器中。這是改變遊戲規則的。這意味著您可以開發應用程式並利用依賴注入，而無需擔心臃腫的配置檔案。

幸運的是，您在建立 Laravel 應用程式時編寫的許多類別都會自動透過容器接收其依賴，包括控制器、事件監聽器、中介層等。此外，您可以在佇列作業的 handle 方法中鍵入提示依賴。一旦您體驗到自動化和零配置依賴注入的強大功能，感覺就不可能在沒有它的情況下開發。

何時使用容器

由於零配置解析，您通常會在路由、控制器、事件監聽器和其他地方鍵入提示依賴，而無需手動與容器互動。例如，您可能會在路由定義上鍵入提示 Illuminate\Http\Request 物件，以便輕鬆存取當前請求。即使我們從來不必與容器互動來編寫此代碼，它也在幕後管理這些依賴的注入：

use Illuminate\Http\Request;

Route::get('/', function (Request $request) {
    // ...
});

在許多情況下，由於自動依賴注入和外觀，您可以建立 Laravel 應用程式而永遠無需手動綁定或從容器中解析任何內容。那麼，您什麼時候會手動與容器互動呢？讓我們檢查兩種情況。

首先，如果您編寫一個實現介面的類別，並且希望在路由或類別構造函數上鍵入提示該介面，則必須告訴容器如何解析該介面。其次，如果您正在編寫一個 Laravel 套件，並計劃與其他 Laravel 開發者分享，則可能需要將套件的服務綁定到容器中。

綁定

綁定基礎

簡單綁定

幾乎所有服務容器綁定都將在服務提供者中註冊，因此大多數範例將在該上下文中演示容器的使用。

在服務提供者中，您始終可以透過 $this->app 屬性存取容器。我們可以使用 bind 方法註冊綁定，傳遞我們希望註冊的類別或介面名稱以及返回類別實例的閉包：

use App\Services\Transistor;
use App\Services\PodcastParser;
use Illuminate\Contracts\Foundation\Application;

$this->app->bind(Transistor::class, function (Application $app) {
    return new Transistor($app->make(PodcastParser::class));
});

請注意，我們收到容器本身作為解析器的參數。然後我們可以使用容器來解析我們正在建構的物件的子依賴。

如前所述，您通常會在服務提供者中與容器互動；但是，如果您希望在服務提供者之外與容器互動，可以透過 App外觀來執行此操作：

use App\Services\Transistor;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\App;

App::bind(Transistor::class, function (Application $app) {
    // ...
});

您可以使用 bindIf 方法僅在尚未為給定類型註冊綁定時註冊容器綁定：

$this->app->bindIf(Transistor::class, function (Application $app) {
    return new Transistor($app->make(PodcastParser::class));
});

為了方便，您可以省略將希望註冊的類別或介面名稱作為單獨參數提供，而是允許 Laravel 從您提供給 bind 方法的閉包的返回類型中推斷類型：

App::bind(function (Application $app): Transistor {
    return new Transistor($app->make(PodcastParser::class));
});

[!NOTE] 如果類別不依賴於任何介面，則無需將類別綁定到容器中。容器不需要被指示如何建構這些物件，因為它可以使用反射自動解析這些物件。

綁定單例

singleton 方法將類別或介面綁定到容器中，該容器應該只解析一次。一旦單例綁定被解析，在後續呼叫容器時將返回相同的物件實例：

use App\Services\Transistor;
use App\Services\PodcastParser;
use Illuminate\Contracts\Foundation\Application;

$this->app->singleton(Transistor::class, function (Application $app) {
    return new Transistor($app->make(PodcastParser::class));
});

您可以使用 singletonIf 方法僅在尚未為給定類型註冊綁定時註冊單例容器綁定：

$this->app->singletonIf(Transistor::class, function (Application $app) {
    return new Transistor($app->make(PodcastParser::class));
});

單例屬性

或者，您可以使用 #[Singleton] 屬性標記介面或類別，以向容器表明它應該被解析一次：

<?php

namespace App\Services;

use Illuminate\Container\Attributes\Singleton;

#[Singleton]
class Transistor
{
    // ...
}

綁定作用域單例

scoped 方法將類別或介面綁定到容器中，該容器應該在給定的 Laravel 請求/作業生命週期內只解析一次。雖然此方法與 singleton 方法類似，但使用 scoped 方法註冊的實例將在 Laravel 應用程式開始新的「生命週期」時被刷新，例如當 Laravel Octane 工作者處理新請求或當 Laravel 佇列工作者處理新作業時：

use App\Services\Transistor;
use App\Services\PodcastParser;
use Illuminate\Contracts\Foundation\Application;

$this->app->scoped(Transistor::class, function (Application $app) {
    return new Transistor($app->make(PodcastParser::class));
});

您可以使用 scopedIf 方法僅在尚未為給定類型註冊綁定時註冊作用域容器綁定：

$this->app->scopedIf(Transistor::class, function (Application $app) {
    return new Transistor($app->make(PodcastParser::class));
});

作用域屬性

或者，您可以使用 #[Scoped] 屬性標記介面或類別，以向容器表明它應該在給定的 Laravel 請求/作業生命週期內被解析一次：

<?php

namespace App\Services;

use Illuminate\Container\Attributes\Scoped;

#[Scoped]
class Transistor
{
    // ...
}

綁定實例

您還可以使用 instance 方法將現有物件實例綁定到容器中。在後續呼叫容器時，給定的實例將始終被返回：

use App\Services\Transistor;
use App\Services\PodcastParser;

$service = new Transistor(new PodcastParser);

$this->app->instance(Transistor::class, $service);

將介面綁定到實現

服務容器的一個非常強大的功能是它能夠將介面綁定到給定的實現。例如，假設我們有一個 EventPusher 介面和一個 RedisEventPusher 實現。一旦我們編寫了此介面的 RedisEventPusher 實現，我們可以像這樣將其註冊到服務容器中：

use App\Contracts\EventPusher;
use App\Services\RedisEventPusher;

$this->app->bind(EventPusher::class, RedisEventPusher::class);

此語句告訴容器，當類別需要 EventPusher 的實現時，它應該注入 RedisEventPusher。現在我們可以在由容器解析的類別的構造函數中鍵入提示 EventPusher 介面。請記住，控制器、事件監聽器、中介層和 Laravel 應用程式中的各種其他類型的類別始終使用容器解析：

use App\Contracts\EventPusher;

/**
 * 建立一個新的類別實例。
 */
public function __construct(
    protected EventPusher $pusher,
) {}

Bind 屬性

Laravel 還提供了 Bind 屬性以增加便利性。您可以將此屬性應用於任何介面，以告訴 Laravel 在請求該介面時應自動注入哪個實現。使用 Bind 時，無需在應用程式的服務提供者中執行任何額外的服務註冊。

此外，可以在介面上放置多個 Bind 屬性，以配置應為給定環境集注入的不同實現：

<?php

namespace App\Contracts;

use App\Services\FakeEventPusher;
use App\Services\RedisEventPusher;
use Illuminate\Container\Attributes\Bind;

#[Bind(RedisEventPusher::class)]
#[Bind(FakeEventPusher::class, environments: ['local', 'testing'])]
interface EventPusher
{
    // ...
}

此外，可以應用 Singleton 和 Scoped 屬性來指示容器綁定應該解析一次還是每次請求/作業生命週期解析一次：

use App\Services\RedisEventPusher;
use Illuminate\Container\Attributes\Bind;
use Illuminate\Container\Attributes\Singleton;

#[Bind(RedisEventPusher::class)]
#[Singleton]
interface EventPusher
{
    // ...
}

上下文綁定

有時您可能有兩個使用相同介面的類別，但您希望向每個類別注入不同的實現。例如，兩個控制器可能依賴於 Illuminate\Contracts\Filesystem\Filesystem合約的不同實現。Laravel 提供了一個簡單、流暢的介面來定義此行為：

use App\Http\Controllers\PhotoController;
use App\Http\Controllers\UploadController;
use App\Http\Controllers\VideoController;
use Illuminate\Contracts\Filesystem\Filesystem;
use Illuminate\Support\Facades\Storage;

$this->app->when(PhotoController::class)
    ->needs(Filesystem::class)
    ->give(function () {
        return Storage::disk('local');
    });

$this->app->when([VideoController::class, UploadController::class])
    ->needs(Filesystem::class)
    ->give(function () {
        return Storage::disk('s3');
    });

上下文屬性

由於上下文綁定通常用於注入驅動程式或配置值的實現，Laravel 提供了多種上下文綁定屬性，允許注入這些類型的值，而無需在服務提供者中手動定義上下文綁定。

例如，Storage 屬性可用於注入特定的儲存磁碟：

<?php

namespace App\Http\Controllers;

use Illuminate\Container\Attributes\Storage;
use Illuminate\Contracts\Filesystem\Filesystem;

class PhotoController extends Controller
{
    public function __construct(
        #[Storage('local')] protected Filesystem $filesystem
    ) {
        // ...
    }
}

除了 Storage 屬性外，Laravel 還提供了 Auth、Cache、Config、Context、DB、Give、Log、RouteParameter 和 Tag 屬性：

<?php

namespace App\Http\Controllers;

use App\Contracts\UserRepository;
use App\Models\Photo;
use App\Repositories\DatabaseRepository;
use Illuminate\Container\Attributes\Auth;
use Illuminate\Container\Attributes\Cache;
use Illuminate\Container\Attributes\Config;
use Illuminate\Container\Attributes\Context;
use Illuminate\Container\Attributes\DB;
use Illuminate\Container\Attributes\Give;
use Illuminate\Container\Attributes\Log;
use Illuminate\Container\Attributes\RouteParameter;
use Illuminate\Container\Attributes\Tag;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Database\Connection;
use Psr\Log\LoggerInterface;

class PhotoController extends Controller
{
    public function __construct(
        #[Auth('web')] protected Guard $auth,
        #[Cache('redis')] protected Repository $cache,
        #[Config('app.timezone')] protected string $timezone,
        #[Context('uuid')] protected string $uuid,
        #[Context('ulid', hidden: true)] protected string $ulid,
        #[DB('mysql')] protected Connection $connection,
        #[Give(DatabaseRepository::class)] protected UserRepository $users,
        #[Log('daily')] protected LoggerInterface $log,
        #[RouteParameter] protected Photo $photo,
        #[Tag('reports')] protected iterable $reports,
    ) {
        // ...
    }
}

RouteParameter 屬性將解析與變數名稱匹配的路由參數。如果需要，您可以明確指定路由參數名稱：#[RouteParameter('photo')]。

此外，Laravel 還提供了 CurrentUser 屬性，用於將當前已認證的使用者注入到給定的路由或類別中：

use App\Models\User;
use Illuminate\Container\Attributes\CurrentUser;

Route::get('/user', function (#[CurrentUser] User $user) {
    return $user;
})->middleware('auth');

定義自訂屬性

您可以透過實現 Illuminate\Contracts\Container\ContextualAttribute 合約來建立自己的上下文屬性。容器將呼叫您屬性的 resolve 方法，該方法應該解析應注入到使用該屬性的類別中的值。在下面的範例中，我們將重新實現 Laravel 的內建 Config 屬性：

<?php

namespace App\Attributes;

use Attribute;
use Illuminate\Contracts\Container\Container;
use Illuminate\Contracts\Container\ContextualAttribute;
use ReflectionParameter;

#[Attribute(Attribute::TARGET_PARAMETER)]
class Config implements ContextualAttribute
{
    /**
     * 建立一個新的屬性實例。
     */
    public function __construct(public string $key, public mixed $default = null)
    {
    }

    /**
     * 解析配置值。
     *
     * @param  self  $attribute
     * @param  \Illuminate\Contracts\Container\Container  $container
     * @param  \ReflectionParameter  $parameter
     * @return mixed
     */
    public static function resolve(self $attribute, Container $container, ReflectionParameter $parameter)
    {
        return $container->make('config')->get($attribute->key, $attribute->default);
    }
}

綁定原語

有時您可能有一個接收一些注入類別的類別，但也需要注入原語值，例如整數。您可以輕鬆使用上下文綁定來注入類別可能需要的任何值：

use App\Http\Controllers\UserController;

$this->app->when(UserController::class)
    ->needs('$variableName')
    ->give($value);

有時類別可能依賴於標籤實例的陣列。使用 giveTagged 方法，您可以輕鬆地將所有具有該標籤的容器綁定注入：

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

如果您需要從應用程式的配置檔案中注入值，可以使用 giveConfig 方法：

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

綁定類型化可變參數

有時您可能有一個使用可變參數構造函數參數接收類型化物件陣列的類別：

<?php

use App\Models\Filter;
use App\Services\Logger;

class Firewall
{
    /**
     * 過濾器實例。
     *
     * @var array
     */
    protected $filters;

    /**
     * 建立一個新的類別實例。
     */
    public function __construct(
        protected Logger $logger,
        Filter ...$filters,
    ) {
        $this->filters = $filters;
    }
}

使用上下文綁定，您可以透過向 give 方法提供一個返回已解析 Filter 實例陣列的閉包來解析此依賴：

$this->app->when(Firewall::class)
    ->needs(Filter::class)
    ->give(function (Application $app) {
          return [
              $app->make(NullFilter::class),
              $app->make(ProfanityFilter::class),
              $app->make(TooLongFilter::class),
          ];
    });

為了方便，您也可以只提供一個類別名稱陣列，當 Firewall 需要 Filter 實例時由容器解析：

$this->app->when(Firewall::class)
    ->needs(Filter::class)
    ->give([
        NullFilter::class,
        ProfanityFilter::class,
        TooLongFilter::class,
    ]);

可變參數標籤依賴

有時類別可能有一個鍵入提示為給定類別（Report ...$reports）的可變參數依賴。使用 needs 和 giveTagged 方法，您可以輕鬆地將所有具有該標籤的容器綁定注入到給定的依賴中：

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

標籤

有時您可能需要解析某個「類別」的所有綁定。例如，也許您正在建立一個報告分析器，該分析器接收一個包含許多不同 Report 介面實現的陣列。註冊 Report 實現後，您可以使用 tag 方法為它們分配一個標籤：

$this->app->bind(CpuReport::class, function () {
    // ...
});

$this->app->bind(MemoryReport::class, function () {
    // ...
});

$this->app->tag([CpuReport::class, MemoryReport::class], 'reports');

服務被標記後，您可以透過容器的 tagged 方法輕鬆解析它們：

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

擴展綁定

extend 方法允許修改已解析的服務。例如，當服務被解析時，您可以運行額外的代碼來裝飾或配置服務。extend 方法接受兩個參數：您正在擴展的服務類別和一個應返回修改後服務的閉包。閉包接收正在解析的服務和容器實例：

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

解析

make 方法

您可以使用 make 方法從容器中解析類別實例。make 方法接受您希望解析的類別或介面的名稱：

use App\Services\Transistor;

$transistor = $this->app->make(Transistor::class);

如果您的類別的一些依賴無法透過容器解析，您可以透過將它們作為關聯陣列傳遞到 makeWith 方法中來注入它們。例如，我們可以手動傳遞 Transistor 服務所需的 $id 構造函數參數：

use App\Services\Transistor;

$transistor = $this->app->makeWith(Transistor::class, ['id' => 1]);

bound 方法可用於判斷類別或介面是否已明確綁定到容器中：

if ($this->app->bound(Transistor::class)) {
    // ...
}

如果您在服務提供者之外，並且在程式碼中無法存取 $app 變數的位置，可以使用 App外觀或 app輔助函數從容器中解析類別實例：

use App\Services\Transistor;
use Illuminate\Support\Facades\App;

$transistor = App::make(Transistor::class);

$transistor = app(Transistor::class);

如果您希望將 Laravel 容器實例本身注入到正在由容器解析的類別中，可以在類別的構造函數上鍵入提示 Illuminate\Container\Container 類別：

use Illuminate\Container\Container;

/**
 * 建立一個新的類別實例。
 */
public function __construct(
    protected Container $container,
) {}

自動注入

或者，重要的是，您可以在由容器解析的類別的構造函數中鍵入提示依賴，包括控制器、事件監聽器、中介層等。此外，您可以在佇列作業的 handle 方法中鍵入提示依賴。在實踐中，這就是大多數物件應該由容器解析的方式。

例如，您可以在控制器的構造函數中鍵入提示應用程式定義的服務。該服務將自動被解析並注入到類別中：

<?php

namespace App\Http\Controllers;

use App\Services\AppleMusic;

class PodcastController extends Controller
{
    /**
     * 建立一個新的控制器實例。
     */
    public function __construct(
        protected AppleMusic $apple,
    ) {}

    /**
     * 顯示給定播客的資訊。
     */
    public function show(string $id): Podcast
    {
        return $this->apple->findPodcast($id);
    }
}

方法調用和注入

有時您可能希望在物件實例上调用一個方法，同時允許容器自動注入該方法的依賴。例如，給定以下類別：

<?php

namespace App;

use App\Services\AppleMusic;

class PodcastStats
{
    /**
     * 生成一個新的播客統計報告。
     */
    public function generate(AppleMusic $apple): array
    {
        return [
            // ...
        ];
    }
}

您可以像這樣透過容器調用 generate 方法：

use App\PodcastStats;
use Illuminate\Support\Facades\App;

$stats = App::call([new PodcastStats, 'generate']);

call 方法接受任何 PHP 可呼叫物件。容器的 call 方法甚至可以用於調用閉包，同時自動注入其依賴：

use App\Services\AppleMusic;
use Illuminate\Support\Facades\App;

$result = App::call(function (AppleMusic $apple) {
    // ...
});

容器事件

服務容器每次解析物件時都會觸發一個事件。您可以使用 resolving 方法監聽此事件：

use App\Services\Transistor;
use Illuminate\Contracts\Foundation\Application;

$this->app->resolving(Transistor::class, function (Transistor $transistor, Application $app) {
    // 當容器解析「Transistor」類型的物件時呼叫...
});

$this->app->resolving(function (mixed $object, Application $app) {
    // 當容器解析任何類型的物件時呼叫...
});

如您所見，正在解析的物件將被傳遞給回呼，允許您在將其提供給消費者之前在物件上設置任何額外的屬性。

重新綁定

rebinding 方法允許您監聽服務何時被重新綁定到容器，這意味著它在初始綁定後被重新註冊或覆蓋。當您需要在每次更新特定綁定時更新依賴或修改行為時，這可能很有用：

use App\Contracts\PodcastPublisher;
use App\Services\SpotifyPublisher;
use App\Services\TransistorPublisher;
use Illuminate\Contracts\Foundation\Application;

$this->app->bind(PodcastPublisher::class, SpotifyPublisher::class);

$this->app->rebinding(
    PodcastPublisher::class,
    function (Application $app, PodcastPublisher $newInstance) {
        //
    },
);

// 新的綁定將觸發重新綁定閉包...
$this->app->bind(PodcastPublisher::class, TransistorPublisher::class);

PSR-11

Laravel 的服務容器實現了 PSR-11 介面。因此，您可以在類別的構造函數上鍵入提示 PSR-11 容器介面以取得 Laravel 容器的實例：

use App\Services\Transistor;
use Psr\Container\ContainerInterface;

Route::get('/', function (ContainerInterface $container) {
    $service = $container->get(Transistor::class);

    // ...
});

如果給定的標識符無法解析，則會拋出異常。如果標識符從未被綁定，異常將是 Psr\Container\NotFoundExceptionInterface 的實例。如果標識符已綁定但無法解析，則會拋出 Psr\Container\ContainerExceptionInterface 的實例。