首页 > 后端开发 > php教程 > 正文

Laravel服务提供器(ServiceProvider)的解读

不言
发布： 2018-07-06 15:03:12
原创
2723人浏览过

这篇文章主要介绍了关于laravel服务提供器(serviceprovider)的解读，有着一定的参考价值，现在分享给大家，有需要的朋友可以参考一下

服务提供器是所有 Laravel 应用程序引导中心。你的应用程序自定义的服务、第三方资源包提供的服务以及 Laravel 的所有核心服务都是通过服务提供器进行注册(register)和引导(boot)的。

拿一个Laravel框架自带的服务提供器来举例子

class BroadcastServiceProvider extends ServiceProvider
{
    protected $defer = true;
    public function register()
    {
        $this->app->singleton(BroadcastManager::class, function ($app) {
            return new BroadcastManager($app);
        });
        $this->app->singleton(BroadcasterContract::class, function ($app) {
            return $app->make(BroadcastManager::class)->connection();
        });
        //将BroadcastingFactory::class设置为BroadcastManager::class的别名
        $this->app->alias(
            BroadcastManager::class, BroadcastingFactory::class
        );
    }
    public function provides()
    {
        return [
            BroadcastManager::class,
            BroadcastingFactory::class,
            BroadcasterContract::class,
        ];
    }
}
登录后复制

在服务提供器BroadcastServiceProvider的register中， 为BroadcastingFactory的类名绑定了类实现BroadcastManager，这样就能通过服务容器来make出通过BroadcastingFactory::class绑定的服务BroadcastManger对象供应用程序使用了。

本文主要时来梳理一下laravel是如何注册、和初始化这些服务的，关于如何编写自己的服务提供器，可以参考官方文档

BootStrap

首先laravel注册和引导应用需要的服务是发生在寻找路由处理客户端请求之前的Bootstrap阶段的，在框架的入口文件里我们可以看到，框架在实例化了Application对象后从服务容器中解析出了HTTP Kernel对象

$kernel = $app->make(IlluminateContractsHttpKernel::class);

$response = $kernel->handle(
    $request = IlluminateHttpRequest::capture()
);
登录后复制

在Kernel处理请求时会先让请求通过中间件然后在发送请求给路由对应的控制器方法， 在这之前有一个BootStrap阶段来引导启动Laravel应用程序，如下面代码所示。

public function handle($request)
{
    ......
    $response = $this->sendRequestThroughRouter($request);
    ......
            
    return $response;
}
登录后复制
protected function sendRequestThroughRouter($request)
{
    $this->app->instance('request', $request);

    Facade::clearResolvedInstance('request');

    $this->bootstrap();

    return (new Pipeline($this->app))
                    ->send($request)
                    ->through($this->app->shouldSkipMiddleware() ? [] : $this->middleware)
                    ->then($this->dispatchToRouter());
}
    
//引导启动Laravel应用程序
public function bootstrap()
{
    if (! $this->app->hasBeenBootstrapped()) {
        /**依次执行$bootstrappers中每一个bootstrapper的bootstrap()函数
         $bootstrappers = [
             'IlluminateFoundationBootstrapDetectEnvironment',
             'IlluminateFoundationBootstrapLoadConfiguration',
             'IlluminateFoundationBootstrapConfigureLogging',
             'IlluminateFoundationBootstrapHandleExceptions',
             'IlluminateFoundationBootstrapRegisterFacades',
             'IlluminateFoundationBootstrapRegisterProviders',
             'IlluminateFoundationBootstrapBootProviders',
            ];*/
            $this->app->bootstrapWith($this->bootstrappers());
        }
    }
登录后复制

上面bootstrap中会分别执行每一个bootstrapper的bootstrap方法来引导启动应用程序的各个部分

    1. DetectEnvironment  检查环境
    2. LoadConfiguration  加载应用配置
    3. ConfigureLogging   配置日至
    4. HandleException    注册异常处理的Handler
    5. RegisterFacades    注册Facades 
    6. RegisterProviders  注册Providers 
    7. BootProviders      启动Providers
登录后复制

启动应用程序的最后两部就是注册服务提供这和启动提供者，如果对前面几个阶段具体时怎么实现的可以参考这篇文章。在这里我们主要关注服务提供器的注册和启动。

先来看注册服务提供器，服务提供器的注册由类 IlluminateFoundationBootstrapRegisterProviders::class 负责，该类用于加载所有服务提供器的 register 函数，并保存延迟加载的服务的信息，以便实现延迟加载。

class RegisterProviders
{
    public function bootstrap(Application $app)
    {
        //调用了Application的registerConfiguredProviders()
        $app->registerConfiguredProviders();
    }
}
    
class Application extends Container implements ApplicationContract, HttpKernelInterface
{
    public function registerConfiguredProviders()
    {
        (new ProviderRepository($this, new Filesystem, $this->getCachedServicesPath()))
                    ->load($this->config['app.providers']);
    }
    
    public function getCachedServicesPath()
    {
        return $this->bootstrapPath().'/cache/services.php';
    }
}
登录后复制

可以看出，所有服务提供器都在配置文件 app.php 文件的 providers 数组中。类 ProviderRepository 负责所有的服务加载功能：

class ProviderRepository
{
    public function load(array $providers)
    {
        $manifest = $this->loadManifest();
        if ($this->shouldRecompile($manifest, $providers)) {
            $manifest = $this->compileManifest($providers);
        }
        foreach ($manifest['when'] as $provider => $events) {
            $this->registerLoadEvents($provider, $events);
        }
        foreach ($manifest['eager'] as $provider) {
            $this->app->register($provider);
        }
        $this->app->addDeferredServices($manifest['deferred']);
    }
}
登录后复制

loadManifest()会加载服务提供器缓存文件services.php，如果框架是第一次启动时没有这个文件的，或者是缓存文件中的providers数组项与config/app.php里的providers数组项不一致都会编译生成services.php。

//判断是否需要编译生成services文件
public function shouldRecompile($manifest, $providers)
{
    return is_null($manifest) || $manifest['providers'] != $providers;
}

//编译生成文件的具体过程
protected function compileManifest($providers)
{
    $manifest = $this->freshManifest($providers);
    foreach ($providers as $provider) {
        $instance = $this->createProvider($provider);
        if ($instance->isDeferred()) {
            foreach ($instance->provides() as $service) {
                $manifest['deferred'][$service] = $provider;
            }
            $manifest['when'][$provider] = $instance->when();
        }
        else {
            $manifest['eager'][] = $provider;
        }
    }
    return $this->writeManifest($manifest);
}


protected function freshManifest(array $providers)
{
    return ['providers' => $providers, 'eager' => [], 'deferred' => []];
}
登录后复制

  • 缓存文件中 providers 放入了所有自定义和框架核心的服务。

  • 如果服务提供器是需要立即注册的，那么将会放入缓存文件中 eager 数组中。

  • 如果服务提供器是延迟加载的，那么其函数 provides() 通常会提供服务别名，这个服务别名通常是向服务容器中注册的别名，别名将会放入缓存文件的 deferred 数组中，与真正要注册的服务提供器组成一个键值对。

  • 延迟加载若由 event 事件激活，那么可以在 when 函数中写入事件类，并写入缓存文件的 when 数组中。

生成的缓存文件内容如下：

array (
    'providers' => 
    array (
      0 => 'Illuminate\Auth\AuthServiceProvider',
      1 => 'Illuminate\Broadcasting\BroadcastServiceProvider',
      ...
    ),

    'eager' => 
    array (
      0 => 'Illuminate\Auth\AuthServiceProvider',
      1 => 'Illuminate\Cookie\CookieServiceProvider',
      ...
    ),

    'deferred' => 
    array (
      'Illuminate\Broadcasting\BroadcastManager' => 'Illuminate\Broadcasting\BroadcastServiceProvider',
      'Illuminate\Contracts\Broadcasting\Factory' => 'Illuminate\Broadcasting\BroadcastServiceProvider',
      ...
    ),

    'when' => 
    array (
      'Illuminate\Broadcasting\BroadcastServiceProvider' => 
      array (
      ),
      ...
)
登录后复制

事件触发时注册延迟服务提供器

延迟服务提供器除了利用 IOC 容器解析服务方式激活，还可以利用 Event 事件来激活：

protected function registerLoadEvents($provider, array $events)
{
    if (count($events) < 1) {
        return;
    }
    $this->app->make('events')->listen($events, function () use ($provider) {
        $this->app->register($provider);
    });
}
登录后复制

即时注册服务提供器

需要即时注册的服务提供器的register方法由Application的register方法里来调用：

class Application extends Container implements ApplicationContract, HttpKernelInterface
{
    public function register($provider, $options = [], $force = false)
    {
        if (($registered = $this->getProvider($provider)) && ! $force) {
            return $registered;
        }
        if (is_string($provider)) {
            $provider = $this->resolveProvider($provider);
        }
        if (method_exists($provider, 'register')) {
            $provider->register();
        }
        $this->markAsRegistered($provider);
        if ($this->booted) {
            $this->bootProvider($provider);
        }
        return $provider;
    }

    public function getProvider($provider)
    {
        $name = is_string($provider) ? $provider : get_class($provider);
        return Arr::first($this->serviceProviders, function ($value) use ($name) {
            return $value instanceof $name;
        });
    }

       public function resolveProvider($provider)
    {
        return new $provider($this);
    }

    protected function markAsRegistered($provider)
    {
        //这个属性在稍后booting服务时会用到
        $this->serviceProviders[] = $provider;
        $this->loadedProviders[get_class($provider)] = true;
       }

    protected function bootProvider(ServiceProvider $provider)
    {
        if (method_exists($provider, 'boot')) {
            return $this->call([$provider, 'boot']);
        }
    }
}
登录后复制

可以看出，服务提供器的注册过程：

小绿鲸英文文献阅读器
小绿鲸英文文献阅读器

英文文献阅读器，专注提高SCI阅读效率

小绿鲸英文文献阅读器 199
查看详情 小绿鲸英文文献阅读器

  • 判断当前服务提供器是否被注册过，如注册过直接返回对象

  • 解析服务提供器

  • 调用服务提供器的 register 函数

  • 标记当前服务提供器已经注册完毕

  • 若框架已经加载注册完毕所有的服务容器，那么就启动服务提供器的 boot 函数，该函数由于是 call 调用，所以支持依赖注入。

服务解析时注册延迟服务提供器

延迟服务提供器首先需要添加到 Application 中

public function addDeferredServices(array $services)
{
    $this->deferredServices = array_merge($this->deferredServices, $services);
}
登录后复制

我们之前说过，延迟服务提供器的激活注册有两种方法：事件与服务解析。

当特定的事件被激发后，就会调用 Application 的 register 函数，进而调用服务提供器的 register 函数，实现服务的注册。

当利用 Ioc 容器解析服务名时，例如解析服务名 BroadcastingFactory：

class BroadcastServiceProvider extends ServiceProvider
{
    protected $defer = true;
    
    public function provides()
    {
        return [
            BroadcastManager::class,
            BroadcastingFactory::class,
            BroadcasterContract::class,
        ];
    }
}
登录后复制

在Application的make方法里会通过别名BroadcastingFactory查找是否有对应的延迟注册的服务提供器，如果有的话那么
就先通过registerDeferredProvider方法注册服务提供器。

class Application extends Container implements ApplicationContract, HttpKernelInterface
{
    public function make($abstract)
    {
        $abstract = $this->getAlias($abstract);
        if (isset($this->deferredServices[$abstract])) {
            $this->loadDeferredProvider($abstract);
        }
        return parent::make($abstract);
    }

    public function loadDeferredProvider($service)
    {
        if (! isset($this->deferredServices[$service])) {
            return;
        }
        $provider = $this->deferredServices[$service];
        if (! isset($this->loadedProviders[$provider])) {
            $this->registerDeferredProvider($provider, $service);
        }
    }
}
登录后复制

由 deferredServices 数组可以得知，BroadcastingFactory 为延迟服务，接着程序会利用函数 loadDeferredProvider 来加载延迟服务提供器，调用服务提供器的 register 函数，若当前的框架还未注册完全部服务。那么将会放入服务启动的回调函数中，以待服务启动时调用：

public function registerDeferredProvider($provider, $service = null)
{
    if ($service) {
        unset($this->deferredServices[$service]);
    }
    $this->register($instance = new $provider($this));
    if (! $this->booted) {
        $this->booting(function () use ($instance) {
            $this->bootProvider($instance);
        });
    }
}
登录后复制

还是拿服务提供器BroadcastServiceProvider来举例：

class BroadcastServiceProvider extends ServiceProvider
{
    protected $defer = true;
    public function register()
    {
        $this->app->singleton(BroadcastManager::class, function ($app) {
            return new BroadcastManager($app);
        });
        $this->app->singleton(BroadcasterContract::class, function ($app) {
            return $app->make(BroadcastManager::class)->connection();
        });
        //将BroadcastingFactory::class设置为BroadcastManager::class的别名
        $this->app->alias(
            BroadcastManager::class, BroadcastingFactory::class
        );
    }
    public function provides()
    {
        return [
            BroadcastManager::class,
            BroadcastingFactory::class,
            BroadcasterContract::class,
        ];
    }
}
登录后复制

函数 register 为类 BroadcastingFactory 向 服务容器绑定了特定的实现类 BroadcastManager，Application中的 make 函数里执行parent::make($abstract) 通过服务容器的make就会正确的解析出服务 BroadcastingFactory。

因此函数 provides() 返回的元素一定都是 register() 向 服务容器中绑定的类名或者别名。这样当我们利用App::make() 解析这些类名的时候，服务容器才会根据服务提供器的 register() 函数中绑定的实现类，正确解析出服务功能。

启动Application

Application的启动由类 IlluminateFoundationBootstrapBootProviders 负责：

class BootProviders
{
    public function bootstrap(Application $app)
    {
        $app->boot();
    }
}
class Application extends Container implements ApplicationContract, HttpKernelInterface
{
    public function boot()
    {
        if ($this->booted) {
            return;
        }
        $this->fireAppCallbacks($this->bootingCallbacks);
        array_walk($this->serviceProviders, function ($p) {
            $this->bootProvider($p);
        });
        $this->booted = true;
        $this->fireAppCallbacks($this->bootedCallbacks);
    }
    
    protected function bootProvider(ServiceProvider $provider)
    {
        if (method_exists($provider, 'boot')) {
            return $this->call([$provider, 'boot']);
        }
    }
}
登录后复制

引导应用Application的serviceProviders属性中记录的所有服务提供器，就是依次调用这些服务提供器的boot方法，引导完成后$this->booted = true 就代表应用Application正式启动了，可以开始处理请求了。这里额外说一句，之所以等到所有服务提供器都注册完后再来进行引导是因为有可能在一个服务提供器的boot方法里调用了其他服务提供器注册的服务，所以需要等到所有即时注册的服务提供器都register完成后再来boot。

以上就是本文的全部内容，希望对大家的学习有所帮助，更多相关内容请关注PHP中文网！

相关推荐：

以上就是Laravel服务提供器(ServiceProvider)的解读的详细内容，更多请关注php中文网其它相关文章！

相关标签：
laravel php

大家都在看：

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移，垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是，许多工具可以让 Windows 保持平稳运行。

下载
来源：php中文网
收藏 点赞
上一篇：Laravel核心解读Response 下一篇：Laravel服务容器(IocContainer)的解读
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系admin@php.cn
作者最新文章
最新问题
解决WordPress标题HTML实体在Telegram中显示异常问题 本教程旨在解决WordPress文章标题中包含特殊字符（如破折号）时，通过API发送至Telegram等平台可能显示为HTML实体编码（如–）的问题。我们将介绍如何利用PHP的html_entity_decode()函数将这些实体解码回其对应的字符，确保内容在目标平台正确显示，提升用户体验。
2025-11-05 12:00:38
694
PHP接口怎么加密_PHP接口加密方法及数据传输安全。 使用HTTPS、AES、RSA、签名防重放和JWT五种方法保障PHP接口安全：首先通过HTTPS加密传输，防止数据窃听；其次用AES对称加密处理大量数据，结合RSA非对称加密保护密钥安全；再通过时间戳与HMAC签名防止重放攻击；最后利用JWT实现身份认证与数据安全封装，确保接口通信的机密性、完整性与可用性。
2025-11-05 12:00:02
574
php指针怎么用_PHP指针概念与引用操作方法教程 PHP通过引用实现类似指针的功能，使用&符号建立变量间的引用关系，使它们共享同一存储空间；修改一个变量会影响另一个，适用于函数参数传递、返回值及对象操作，默认情况下对象赋值即为引用传递。
2025-11-05 11:57:08
145
PHP中从Storage目录下载Excel文件的教程 本教程详细介绍了如何在PHP应用中安全有效地从storage目录下载Excel文件。通过利用storage_path()函数定位文件，并结合response()->download()方法设置正确的Content-Type头部，用户可以实现点击按钮后将服务器上的Excel文件下载到本地，确保文件传输的专业性和可靠性。
2025-11-05 11:56:01
562
使用PHP和sshpass实现SSH远程命令执行与密码自动化 本文详细介绍了如何使用PHP的exec()函数结合sshpass工具，实现远程服务器的SSH连接和命令执行，并解决手动输入密码的问题。教程涵盖了sshpass的安装、基本用法以及如何在PHP脚本中集成，旨在提供一种自动化SSH操作的专业解决方案，同时强调了相关的安全注意事项。
2025-11-05 11:49:48
760
PHPSpreadsheet：实现单元格内容与样式同步复制 本教程详细阐述了如何使用PHPSpreadsheet库实现Excel单元格内容及其完整格式的同步复制。针对仅复制值而丢失样式的问题，文章将指导您通过获取源单元格的样式数组并将其应用到目标单元格，从而确保数据和样式的完整迁移。这避免了使用getValue()等方法时格式丢失的常见困境。
2025-11-05 11:47:49
671
PHP实现SSH自动化登录与命令执行：sshpass的使用指南 本文详细介绍了如何在PHP中通过exec函数结合sshpass工具实现对远程服务器的自动化SSH登录与命令执行。针对传统SSH命令需要手动输入密码的问题，本教程提供了sshpass的安装与使用方法，并给出了PHP代码示例，帮助开发者构建无需人工干预的服务器管理脚本，提升自动化运维效率。
2025-11-05 11:40:32
833
PHP中SQL语句执行失败：引号转义的常见陷阱与解决方案 本文探讨了在PHP脚本中执行SQL查询时，因字符串内部引号未正确转义导致HTTP500错误的问题。通过详细的示例代码，展示了如何正确转义SQL语句中的引号，确保查询在PHP环境中顺利执行，从而避免常见的语法错误和服务器端异常。
2025-11-05 11:40:16
946
理解 PHP 配置：php.ini 与 .user.ini 的异同及应用场景 本文深入探讨PHP配置管理中的两个核心文件：php.ini和.user.ini。php.ini作为全局配置文件，对所有PHP脚本生效，且PHP仅读取一个主php.ini文件。而.user.ini则允许用户在特定目录及其所有子目录中覆盖部分配置，主要用于FastCGI模式下，提供更灵活的目录级配置管理。文章将详细阐述它们的作用范围、优先级、适用指令类型以及使用注意事项。
2025-11-05 11:38:00
205
使用正则表达式与回调函数进行PHP字符串前缀的条件替换 本文详细介绍了如何使用PHP的preg_replace_callback函数，结合精巧的正则表达式，实现对字符串前缀的条件性替换。针对数据源中常见的两字母前缀，教程演示了如何移除不必要的通用前缀，同时保留并规范化特定的方向性前缀（如“NW”、“SE”），有效解决了preg_replace在复杂条件替换中的局限性，确保数据清洗的准确性和灵活性。
2025-11-05 11:37:13
323
相关专题
更多>
热门推荐
开源免费商场系统广告
热门教程
更多>
相关推荐
热门推荐
最新课程
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网：公益在线php培训，帮助PHP学习者快速成长！
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号

  • PHP学习

  • 技术支持

  • 返回顶部