服務提供者 · Laravel 5.6 中文文檔

* * * * * [TOC] ## 簡介服務提供器是所有 Laravel 應用程序引導中心。你的應用程序以及 Laravel 的所有核心服務都是通過服務提供器進行引導。在這里，我們說的「引導」其實是指**注冊**，比如注冊服務容器綁定、事件監聽器、中間件，甚至是路由的注冊。服務提供器是配置你的應用程序的中心。 Laravel 的?`config/app.php`?文件中有一個?`providers`?數組。數組中的內容是應用程序要加載的所有服務提供器類。這其中有許多提供器并不會在每次請求時都被加載，只有當它們提供的服務實際需要時才會加載。這種我們稱之為「延遲」提供器。本篇將帶你學習如何編寫自己的服務提供器，并將其注冊到 Laravel 應用程序中。 ## 編寫服務提供器所有服務提供器都會繼承?`Illuminate\Support\ServiceProvider`?類。大多數服務提供器都包含?`register`?和?`boot`?方法。在?`register`?方法中，你**只需要綁定類到?[服務容器](http://www.hmoore.net/tonyyu/laravel_5_6/786056)**?。而不需要嘗試在?`register`?方法中注冊任何事件監聽器、路由或任何其他功能。使用 Artisan 命令行界面，通過?`make:provider`?命令生成一個新的提供器： ~~~ php artisan make:provider RiakServiceProvider ~~~ ### 注冊方法在?`register`?方法中，你只需要將類綁定到?[服務容器](http://www.hmoore.net/tonyyu/laravel_5_6/786056)?中。而不需要嘗試在?`register`?方法中注冊任何事件監聽器、路由或者任何其他功能。否則，你可能會意外使用到尚未加載的服務提供器提供的服務。讓我們來看一個基本的服務提供器。在你的任何服務提供器方法中，你可以通過?`$app`?屬性來訪問服務容器： ~~~ <?php namespace App\Providers; use Riak\Connection; use Illuminate\Support\ServiceProvider; class RiakServiceProvider extends ServiceProvider { /** * 在服務容器里注冊 * * @return void */ public function register() { $this->app->singleton(Connection::class, function ($app) { return new Connection(config('riak')); }); } } ~~~ 這個服務提供器只定義了一個?`register`?方法，并使用該方法在服務容器中定義了一個?`Riak\Connection`?實現。如果你不了解服務容器的工作原理，請查看其?[文檔](http://www.hmoore.net/tonyyu/laravel_5_6/786056)。 #### `bindings`?和?`singletons`?特性如果你的服務提供商注冊許多簡單的綁定，你可能想使用?`bindings`?和?`singletons`?屬性而不是手動注冊每個容器綁定。當服務提供者被框架加載時，它將自動檢查這些屬性并注冊它們的綁定： ~~~ <?php namespace App\Providers; use App\Contracts\ServerProvider; use App\Contracts\DowntimeNotifier; use Illuminate\Support\ServiceProvider; use App\Services\PingdomDowntimeNotifier; use App\Services\DigitalOceanServerProvider; class AppServiceProvider extends ServiceProvider { /** * 設定容器綁定的對應關系 * * @var array */ public $bindings = [ ServerProvider::class => DigitalOceanServerProvider::class, ]; /** * 設定單例模式的容器綁定對應關系 * * @var array */ public $singletons = [ DowntimeNotifier::class => PingdomDowntimeNotifier::class, ]; } ~~~ ### 引導方法那么，如果我們需要在我們的服務提供器中注冊一個視圖組件呢？這應該在?`boot`?方法中完成。?**此方法在所有其他服務提供器都注冊之后才能調用**，這意味著你可以訪問已經被框架注冊的所有服務： ~~~ <?php namespace App\Providers; use Illuminate\Support\ServiceProvider; class ComposerServiceProvider extends ServiceProvider { /** * 啟動所有的應用服務 * * @return void */ public function boot() { view()->composer('view', function () { // }); } } ~~~ #### 引導方法依賴注入你可以為服務提供器的?`boot`?方法設置類型提示。[服務容器](http://www.hmoore.net/tonyyu/laravel_5_6/786056)?會自動注入你需要的任何依賴項： ~~~ use Illuminate\Contracts\Routing\ResponseFactory; public function boot(ResponseFactory $response) { $response->macro('caps', function ($value) { // }); } ~~~ ## 注冊提供器所有服務提供器都在?`config/app.php`?配置文件中注冊。該文件中有一個?`providers`?數組，用于存放服務提供器的類名。默認情況下，這個數組列出了一系列 Laravel 核心服務提供器。這些服務提供器引導 Laravel 核心組件，例如郵件、隊列、緩存等。要注冊提供器，只需要將其添加到數組： ~~~ 'providers' => [ // 其他服務提供器 App\Providers\ComposerServiceProvider::class, ], ~~~ ## 延遲提供器如果你的提供器?**僅**?在?[服務容器](http://www.hmoore.net/tonyyu/laravel_5_6/786056)?中注冊綁定，就可以選擇推遲其注冊，直到當它真正需要注冊綁定。推遲加載這種提供器會提高應用程序的性能，因為它不會在每次請求時都從文件系統中加載。 Laravel 編譯并保存延遲服務提供器提供的所有服務的列表，以及其服務提供器類的名稱。因此，只有當你在嘗試解析其中一項服務時，Laravel 才會加載服務提供器。要延遲提供器的加載，請將?`defer`?屬性設置為?`true`?，并定義?`provides`?方法。`provides`?方法應該返回由提供器注冊的服務容器綁定： ~~~ <?php namespace App\Providers; use Riak\Connection; use Illuminate\Support\ServiceProvider; class RiakServiceProvider extends ServiceProvider { /** * 標記著提供器是延遲加載的 * * @var bool */ protected $defer = true; /** * 注冊服務提供者 * * @return void */ public function register() { $this->app->singleton(Connection::class, function ($app) { return new Connection($app['config']['riak']); }); } /** * 取得提供者提供的服務 * * @return array */ public function provides() { return [Connection::class]; } } ~~~