企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
# 服务提供者 ## 简介 服务提供器是所有`Laravel`应用程序的引导中心。你的应用程序,以及 通过服务器引导的`Laravel`核心服务都是通过服务提供器引导。 但是,「引导」是什么意思呢? 通常,我们的可以理解为**注册**,比如注册服务容器绑定,事件监听器,中间件,甚至是路由。服务提供器是配置应用程序的中心。 当你打开`Laravel`的`config/app.php`文件时,你会看到`providers`数组。数组中的内容是应用程序要加载的所有服务提供器的类。当然,其中有很多 「延迟」 提供器,他们并不会在每次请求的时候都加载,只有他们的服务实际被需要时才会加载 本篇你将会学到如何编写自己的服务提供器,并将其注册到你的`Laravel`应用程序中 ## 编写服务提供器 所有的服务提供器都会继承`Illuminate\Support\ServiceProvider`类。 大多服务提供器都包含一个`register`和一个`boot`方法。在`register`方法中, 你只需要**将事物绑定到[服务容器](https://laravel-china.org/docs/laravel/5.7/container)**。而不要尝试在`register`方法中注册任何监听器,路由,或者其他任何功能 使用`Artisan`命令界面,通过`make:provider`命令可以生成一个新的提供器: ~~~php php artisan make:provider RiakServiceProvider ~~~ ### 注册方法 如上所述,在`register`方法中,你只需要将服务绑定到[服务容器](https://laravel-china.org/docs/laravel/5.7/container)中。而不要尝试在`register`方法中注册任何监听器,路由,或者其他任何功能。否则,你可能会意外地使用到尚未加载的服务提供器提供的服务 让我们来看一个基础的服务提供器。在任何服务提供器方法中,你总是通过`$app`属性来访问服务容器: ~~~php <?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`接口。如果你不理解服务容器的工作原理,请查看其[文档]. #### `bindings`和`singletons`特性 如果你的服务提供器注册了许多简单的绑定,你可能想用`bindings`和`singletons`属性替代手动注册每个容器绑定。当服务提供器被框架加载时,将自动检查这些属性并注册相应的绑定 ~~~php <?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 方法 如果我们要在服务提供者中注册一个[视图 composer]该怎么做? 这就需要用到`boot`方法了。**该方法在所有服务提供者被注册以后才会被调用**, 这就是说我们可以在其中访问框架已注册的所有其它服务: ~~~php <?php namespace App\Providers; use Illuminate\Support\ServiceProvider; class ComposerServiceProvider extends ServiceProvider { /** * 启动所有的应用服务 * * @return void */ public function boot() { view()->composer('view', function () { // }); } } ~~~ #### Boot 方法的依赖注入 你可以为服务提供者的`boot`方法设置类型提示。[服务容器](https://laravel-china.org/docs/laravel/5.7/container)会自动注入你所需要的依赖。 ~~~php use Illuminate\Contracts\Routing\ResponseFactory; public function boot(ResponseFactory $response) { $response->macro('caps', function ($value) { // }); } ~~~ ## 注册服务提供者 所有服务提供者都是通过配置文件`config/app.php`进行注册。该文件包含了一个列出所有服务提供者名字的`providers`数组,默认情况下,其中列出了所有核心服务提供者,这些服务提供者启动 Laravel核心组件,比如邮件、队列、缓存等等。 要注册提供器,只需要将其添加到数组: ~~~php 'providers' => [ // 其他服务提供者 App\Providers\ComposerServiceProvider::class, ], ~~~ ## 延迟服务提供者 如果你的服务提供者**仅**在[服务容器]中注册,可以选择延迟加载该绑定直到注册绑定的服务真的需要时再加载,延迟加载这样的一个提供者将会提升应用的性能,因为它不会在每次请求时都从文件系统加载。 Laravel 编译并保存延迟服务提供者提供的所有服务的列表,以及其服务提供者类的名称。因此,只有当你在尝试解析其中一项服务时,Laravel 才会加载服务提供者。 要延迟加载一个提供者,设置`defer`属性为`true`并设置一个`provides`方法。`provides`该方法返回该提供者注册的服务容器绑定: ~~~php <?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]; } } ~~~