Skip to content

服务提供者

介绍

服务提供者是所有 Laravel 应用程序引导的核心位置。您自己的应用程序以及所有 Laravel 的核心服务都是通过服务提供者引导的。

那么,我们所说的“引导”是什么意思呢?一般来说,我们指的是注册事物,包括注册服务容器绑定、事件监听器、过滤器,甚至路由。服务提供者是配置应用程序的核心位置。

如果您打开 Laravel 附带的 config/app.php 文件,您将看到一个 providers 数组。这些是将为您的应用程序加载的所有服务提供者类。当然,其中许多是“延迟”提供者,这意味着它们不会在每个请求中加载,而仅在实际需要它们提供的服务时才加载。

在本概述中,您将学习如何编写自己的服务提供者并将其注册到您的 Laravel 应用程序中。

基本提供者示例

所有服务提供者都扩展自 Illuminate\Support\ServiceProvider 类。这个抽象类要求您在提供者中至少定义一个方法:register。在 register 方法中,您应该仅将事物绑定到服务容器。您不应尝试在 register 方法中注册任何事件监听器、路由或其他功能。

Artisan CLI 可以通过 make:provider 命令轻松生成一个新的提供者:

php
php artisan make:provider RiakServiceProvider

Register 方法

现在,让我们看看一个基本的服务提供者:

php
<?php namespace App\Providers;

use Riak\Connection;
use Illuminate\Support\ServiceProvider;

class RiakServiceProvider extends ServiceProvider {

	/**
	 * 在容器中注册绑定。
	 *
	 * @return void
	 */
	public function register()
	{
		$this->app->singleton('Riak\Contracts\Connection', function($app)
		{
			return new Connection($app['config']['riak']);
		});
	}

}

这个服务提供者仅定义了一个 register 方法,并使用该方法在服务容器中定义了 Riak\Contracts\Connection 的实现。如果您不理解服务容器的工作原理,不用担心,我们稍后会介绍

这个类在 App\Providers 命名空间下,因为这是 Laravel 中服务提供者的默认位置。不过,您可以根据需要更改此位置。您的服务提供者可以放置在 Composer 可以自动加载它们的任何地方。

Boot 方法

那么,如果我们需要在服务提供者中注册一个事件监听器怎么办?这应该在 boot 方法中完成。此方法在所有其他服务提供者注册后调用,这意味着您可以访问框架注册的所有其他服务。

php
<?php namespace App\Providers;

use Event;
use Illuminate\Support\ServiceProvider;

class EventServiceProvider extends ServiceProvider {

	/**
	 * 执行服务的后注册引导。
	 *
	 * @return void
	 */
	public function boot()
	{
		Event::listen('SomeEvent', 'SomeEventHandler');
	}

	/**
	 * 在容器中注册绑定。
	 *
	 * @return void
	 */
	public function register()
	{
		//
	}

}

我们可以为 boot 方法进行类型提示依赖项。服务容器将自动注入您需要的任何依赖项:

php
use Illuminate\Contracts\Events\Dispatcher;

public function boot(Dispatcher $events)
{
	$events->listen('SomeEvent', 'SomeEventHandler');
}

注册提供者

所有服务提供者都在 config/app.php 配置文件中注册。此文件包含一个 providers 数组,您可以在其中列出服务提供者的名称。默认情况下,此数组中列出了一组 Laravel 核心服务提供者。这些提供者引导核心 Laravel 组件,如邮件、队列、缓存等。

要注册您的提供者,只需将其添加到数组中:

php
'providers' => [
	// 其他服务提供者

	'App\Providers\AppServiceProvider',
],

延迟提供者

如果您的提供者服务容器中注册绑定,您可以选择将其注册延迟到实际需要其中一个注册绑定时。延迟加载这样的提供者将提高应用程序的性能,因为它不会在每个请求中从文件系统加载。

要延迟加载提供者,请将 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('Riak\Contracts\Connection', function($app)
		{
			return new Connection($app['config']['riak']);
		});
	}

	/**
	 * 获取提供者提供的服务。
	 *
	 * @return array
	 */
	public function provides()
	{
		return ['Riak\Contracts\Connection'];
	}

}

Laravel 编译并存储所有延迟服务提供者提供的服务列表,以及其服务提供者类的名称。然后,只有当您尝试解析这些服务之一时,Laravel 才会加载服务提供者。