laravel 服务提供者

服务提供者，在laravel里面，其实就是一个工厂类。它最大的作用就是用来进行服务绑定。当我们需要绑定一个或多个服务的时候，可以自定义一个服务提供者，然后把服务绑定的逻辑都放在该类的实现中。在larave里面，要自定一个服务提供者非常容易，只要继承Illuminate\Support\ServiceProvider这个类即可。下面通过一个简单的自定义服务提供者来说明服务提供者的一些要点：

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    protected $defer = true;

    public function boot()
    {
        //
    }

    public function register()
    {
        $this->app->singleton('service1', function(){
            return 'service1';
        });
        $this->app->singleton('service2', function(){
            return 'service2';
        });
        $this->app->singleton('service3', function(){
            return 'service3';
        });
    }

    public  function provides()
    {
        return ['service1','service2','service3'];
    }
}

1）. 首先，自定义的服务提供者都是放在下面这个目录的：

其实你放在哪都可以，不过得告诉laravel你的服务提供者在哪，laravel才会帮你注册。怎么告诉它，后面还有介绍。

2）在这个举例里面，可以看到有一个register方法，这个方法是ServiceProvider里面定义的。自定义的时候，需要重写它。这个方法就是用来绑定服务的。你可以在这个服务里面，根据需要加入任意数量的服务绑定。前面要介绍过，在服务提供者里面，始终能通过$this->app拿到容器实例，所以上面的举例中，我们直接用这种方式来完成服务绑定。这个方法是怎么完成服务绑定的呢？因为当laravel找到这个服务提供者的类以后，就会初始化这个服务提供者类，得到一个服务提供者的对象，然后调用它的register方法，自然它里面的所有服务绑定代码就都会执行了。

laravel初始化自定义服务提供者的源码是：

public function registerConfiguredProviders()
    {
        $manifestPath = $this->getCachedServicesPath();

        (new ProviderRepository($this, new Filesystem, $manifestPath))
                    ->load($this->config['app.providers']);
    }

这个代码是在Illuminate\Foundation\Application的源码里面拿出来的，从中你能看到laravel会把所有的自定义服务提供者都注册进来。这个注册的过程其实就是前面说的实例化服务提供者的类，并调用register方法的过程。

3）. 从上一步的源码也能看到，laravel加载自定义服务提供者的时候，实际是从config/app.php这个配置文件里面的providers配置节找到所有要注册的服务提供者的。

'providers' => [

    /*
     * Laravel Framework Service Providers...
     */
    Illuminate\Auth\AuthServiceProvider::class,
    Illuminate\Broadcasting\BroadcastServiceProvider::class,
    Illuminate\Bus\BusServiceProvider::class,
    Illuminate\Cache\CacheServiceProvider::class,
    Illuminate\Foundation\Providers\ConsoleSupportServiceProvider::class,
    Illuminate\Cookie\CookieServiceProvider::class,
    Illuminate\Database\DatabaseServiceProvider::class,
    Illuminate\Encryption\EncryptionServiceProvider::class,
    Illuminate\Filesystem\FilesystemServiceProvider::class,
    Illuminate\Foundation\Providers\FoundationServiceProvider::class,
    Illuminate\Hashing\HashServiceProvider::class,
    Illuminate\Mail\MailServiceProvider::class,
    Illuminate\Notifications\NotificationServiceProvider::class,
    Illuminate\Pagination\PaginationServiceProvider::class,
    Illuminate\Pipeline\PipelineServiceProvider::class,
    Illuminate\Queue\QueueServiceProvider::class,
    Illuminate\Redis\RedisServiceProvider::class,
    Illuminate\Auth\Passwords\PasswordResetServiceProvider::class,
    Illuminate\Session\SessionServiceProvider::class,
    Illuminate\Translation\TranslationServiceProvider::class,
    Illuminate\Validation\ValidationServiceProvider::class,
    Illuminate\View\ViewServiceProvider::class,

    /*
     * Package Service Providers...
     */

    //

    /*
     * Application Service Providers...
     */
    App\Providers\AppServiceProvider::class,
    App\Providers\AuthServiceProvider::class,
    // App\Providers\BroadcastServiceProvider::class,
    App\Providers\EventServiceProvider::class,
    App\Providers\RouteServiceProvider::class,
    Xavrsl\Cas\CasServiceProvider::class,
    ThirdProviders\CasServer\CasServerProvider::class
],

所以你如果自己写了一个服务提供者，那么只要配置到这里面，laravel就会自动帮你注册它了。

4）除了register方法，服务提供者里面还有一个boot方法，这个boot方法，会在所有的服务提供者都注册完成之后才会执行，所以当你想在服务绑定完成之后，通过容器解析出其它服务，做一些初始化工作的时候，那么就可以这些逻辑写在boot方法里面。因为boot方法执行的时候，所有服务提供者都已经被注册完毕了，所以在boot方法里面能够确保其它服务都能被解析出来。

5）前面说的服务提供者的情况，在laravel应用程序初始化的时候，就会去注册服务提供者，调用register方法。但是还有一种需求，你可能需要在真正用到这个服务提供者绑定的服务的时候，才会去注册这个服务提供者，以减少不必要的注册处理，提高性能。这也是延迟处理的一种方式。那么这种服务提供者该怎么定义呢？

其实最前面的这个举例已经告诉你了，只要定义一个$defer的实例属性，并把这个实例属性设置为true，然后添加一个provides的实例方法即可。这两个成员都是ServiceProvider基类里面定义好的，自定义的时候，只是覆盖而已。

在基类中，$defer的默认值是false，表示这个服务提供者不需要延迟注册。provides方法，只要简单的返回这个服务提供register方法里面，注册的所有服务绑定名称即可。

延迟注册的服务提供者的机制是：

• 当laravel初始化服务提供者的实例后，如果发现这个服务提供者的$defer属性为true，那么就不会去调用它的register方法
• 当laravel解析一个服务的时候，如果发现这个服务是由一个延迟服务提供的(它怎么知道这个服务是延迟服务提供的，是provides方法告诉它的)，那么就会先把这个延迟服务提供者先注册，再去解析。这个可以看看Illuminate\Foundation\Application的make方法就清楚了：

• public function make($abstract, array $parameters = [])
  {
      $abstract = $this->getAlias($abstract);
  
      if (isset($this->deferredServices[$abstract])) {
          $this->loadDeferredProvider($abstract);
      }
  
      return parent::make($abstract, $parameters);
  }

6）还记得容器实例结构上几个带有providers名称的属性数组吧：

在了解以上provider的机制后，这几个数组的作用也就比较清晰了。其中serviceProviders用来存放所有已经注册完毕的服务提供者：

loadedProviders跟serviceProviders的作用类似，只是存储的记录形式不同：

deferredProviders用来存储所有的延迟注册的服务提供者：

跟前面两个不同的是，deferredProviders存储的记录的key值并不是服务提供者的类型名称，而是服务提供者的provides返回数组里面的名称。并且如果一个服务提供者的provides里面返回了多个服务绑定名称的话，那么deferredProviders里面就会存多条记录：

这样是方便根据服务绑定名称，找到对应的服务提供者，并完成注册。当服务的解析的时候，会先完成延迟类型的服务提供者的注册，注册完毕，这个服务绑定名称在deferredProviders对应的那条记录就会删除掉。不过如果一个服务提供者provides了多个服务绑定名称，解析其中一个服务的时候，只移除该名称对应的deferredProviders记录，而不是所有。

7）服务提供者还有一个小问题值的注意，由于php是一门基本语言，在处理请求的时候，都会从入口文件把所有php都执行一遍。为了性能考虑，laravel会在第一次初始化的时候，把所有的服务提供者都缓存到bootstrap/cache/services.php文件里面，所以有时候当你改了一个服务提供者的代码以后，再刷新不一定能看到期望的效果，这有可能就是因为缓存所致。这时把services.php删掉就能看到你要的效果了。