从零实现一个 PHP 微框架 - 服务提供者
前言
考试在两周前就结束了,因为一直在填坑 XK-Java,所以一直没更新 PHP 微框架系列文章 2333,最近 XK-Java 也填的差不多了,后续打算把 XK-PHP 也适配到 Swoole,还有 XK-Blog 的坑还没填 ?。
什么是服务提供者(Provider)?
如果你写过 Laravel,那么你一定对 Provider 不陌生,服务提供者实现了将服务绑定到服务容器(IoC Container),并按需启动的功能。
在 Laravel 中, 服务提供者是在 config/app.php
的配置文件中配置的:
_43<?php_43return [_43 'providers' => [_43 /*_43 * Laravel Framework Service Providers..._43 */_43 Illuminate\Auth\AuthServiceProvider::class,_43 Illuminate\Broadcasting\BroadcastServiceProvider::class,_43 Illuminate\Bus\BusServiceProvider::class,_43 Illuminate\Cache\CacheServiceProvider::class,_43 Illuminate\Foundation\Providers\ConsoleSupportServiceProvider::class,_43 Illuminate\Cookie\CookieServiceProvider::class,_43 Illuminate\Database\DatabaseServiceProvider::class,_43 Illuminate\Encryption\EncryptionServiceProvider::class,_43 Illuminate\Filesystem\FilesystemServiceProvider::class,_43 Illuminate\Foundation\Providers\FoundationServiceProvider::class,_43 Illuminate\Hashing\HashServiceProvider::class,_43 Illuminate\Mail\MailServiceProvider::class,_43 Illuminate\Notifications\NotificationServiceProvider::class,_43 Illuminate\Pagination\PaginationServiceProvider::class,_43 Illuminate\Pipeline\PipelineServiceProvider::class,_43 Illuminate\Queue\QueueServiceProvider::class,_43 Illuminate\Redis\RedisServiceProvider::class,_43 Illuminate\Auth\Passwords\PasswordResetServiceProvider::class,_43 Illuminate\Session\SessionServiceProvider::class,_43 Illuminate\Translation\TranslationServiceProvider::class,_43 Illuminate\Validation\ValidationServiceProvider::class,_43 Illuminate\View\ViewServiceProvider::class,_43_43 /*_43 * Package Service Providers..._43 */_43_43 /*_43 * Application Service Providers..._43 */_43 App\Providers\AppServiceProvider::class,_43 App\Providers\AuthServiceProvider::class,_43 // App\Providers\BroadcastServiceProvider::class,_43 App\Providers\EventServiceProvider::class,_43 App\Providers\RouteServiceProvider::class_43 ]_43];
这些服务提供者会在框架启动后将服务注册到服务容器上,如果你学过 Spring,那么就很好理解了,这些服务提供者就是用编码的方式来注册 Bean
、Component
等等,因为 PHP8 才开始支持注解,所以目前跑在 PHP7 的 Laravel 无法像 Spring 一样很 方便的绑定服务实例。
光说肯定没法很好的理解,那么我们就来看一个简单的服务提供者吧:
_24<?php_24_24namespace Illuminate\Cookie;_24_24use Illuminate\Support\ServiceProvider;_24_24class CookieServiceProvider extends ServiceProvider_24{_24 /**_24 * Register the service provider._24 *_24 * @return void_24 */_24 public function register()_24 {_24 $this->app->singleton('cookie', function ($app) {_24 $config = $app->make('config')->get('session');_24_24 return (new CookieJar)->setDefaultPathAndDomain(_24 $config['path'], $config['domain'], $config['secure'], $config['same_site'] ?? null_24 );_24 });_24 }_24}
这是 Laravel 用来注册 CookieJar
实例的服务提供者,可以看到在 register
方法中使用了 singleton
方法将一个的回调注册到了服务容器中,这样,当我们使用 $app->make('cookie')
的时候就可以取得 CookieJar
实例了。
当然服务提供者不止可以注册服务,还能在服务注册后启动实例,只要重写 boot
方法即可。
定义 Provider
了解了服务提供者,那么就可以开始编码了。
首先,我们需要定义 Provider
的接口和抽象类来规范 Provider
,如下:
_9<?php_9_9namespace App\Contracts;_9_9interface Provider_9{_9 // 之所以只定义 register 方法是因为并不是每一个服务提供者都需要预加载(boot),当然你也可以在接口定义 boot 方法,然后在抽象类中提供一个无影响的实现_9 public function register(): void;_9}
_23<?php_23_23namespace App\Providers;_23_23use App\Application;_23_23abstract class Provider implements \App\Contracts\Provider_23{_23 /**_23 * @var Application_23 */_23 protected $app;_23_23 /**_23 * @var bool_23 */_23 public $booted = false;_23_23 public function __construct(Application $app)_23 {_23 $this->app = $app;_23 }_23}
可以看到 Provider
和 Bootstrap
其实差不多,所以这里就不对抽象类做说明了,具体请看 Bootstrap 篇。
编写 Provider
由于 Provider
数量众多,所以这里就不全部写了,只列举几个比较典型的。
CookieProvider
CookieProvider
是一个简单纯注册服务的 Provider
:
_14<?php_14_14namespace App\Providers;_14_14use App\Http\CookieManager;_14_14class CookieProvider extends Provider_14{_14 public function register(): void_14 {_14 // 将 CookieManager 注册到服务容器_14 $this->app->singleton(CookieManager::class, null, 'cookie');_14 }_14}
RouteProvider
RouteProvider
在注册后还会提供预加载,即 boot
:
_20<?php_20_20namespace App\Providers;_20_20use App\Kernel\RouteManager;_20_20class RouteProvider extends Provider_20{_20 public function register(): void_20 {_20 $this->app->singleton(RouteManager::class, null, 'route');_20 }_20_20 // 在所有服务容器注册完毕后,经 BootProvider 这个 Bootstrap 调用该方法来预加载服务_20 public function boot(): void_20 {_20 // 预加载就是在框架启动后立即实例化服务的功能_20 $this->app->make(RouteManager::class);_20 }_20}
AspectProvider
除了简单 Provider
,还有一些比较复杂的 Provider
,如 AspectProvider
:
_39<?php_39_39namespace App\Providers;_39_39use App\Kernel\AspectManager;_39use function array_keys;_39use function config;_39_39class AspectProvider extends Provider_39{_39 /**_39 * @var string[]_39 */_39 protected $aspects;_39_39 public function register(): void_39 {_39 $this->app->singleton(_39 AspectManager::class,_39 function () {_39 return new AspectManager($this->app);_39 },_39 'aspect.manager'_39 );_39 $this->aspects = config('aspect');_39 foreach (array_keys($this->aspects) as $aspect) {_39 $this->app->singleton($aspect, null);_39 }_39 }_39_39 public function boot(): void_39 {_39 /* @var AspectManager $manager */_39 $manager = $this->app->make(AspectManager::class);_39 foreach ($this->aspects as $aspect => $points) {_39 $manager->putPoint($points, $this->app->make($aspect));_39 }_39 }_39}
在 AspectProvider
中不止注册了 AspectManager
,还会读取配置文件将切面也加载进服务容器,同时在启动时把切面依次放入 AspectManager
。
加载 Provider
有了 Provider
,那么 Provider
是如何被创建和执行的呢?
在 Bootstrap
有两个 Provider
相关的 Bootstrap
,分别是 RegisterProviders
和 BootProviders
,上一篇文章只是简单介绍了这两个 Bootstrap
的功能,这里就详细的讲解一下。
_20<?php_20_20namespace App\Bootstrap;_20_20use App\Kernel\ProviderManager;_20use function config;_20_20class RegisterProviders extends Bootstrap_20{_20 public function boot(): void_20 {_20 $this->app->setProviderManager(new ProviderManager($this->app));_20 $this->app->getProviderManager()->registers(config('app.providers'));_20 $this->app->instance(_20 ProviderManager::class,_20 $this->app->getProviderManager(),_20 'provider_manager'_20 );_20 }_20}
然后我们看看 ProviderManager
:
_78<?php_78_78namespace App\Kernel;_78_78use App\Application;_78use App\Providers\Provider;_78use function array_map;_78use function array_walk;_78use function is_string;_78use function method_exists;_78_78class ProviderManager_78{_78 /**_78 * @var Application_78 */_78 protected $app;_78_78 /**_78 * @var Provider[]_78 */_78 protected $providers;_78_78 public function __construct(Application $app)_78 {_78 $this->app = $app;_78 }_78_78 /**_78 * @param string|Provider $provider_78 * @return Provider|null_78 */_78 public function getProvider($provider): ?Provider_78 {_78 if (is_string($provider)) {_78 return $this->providers[$provider] ?? null;_78 }_78 return $provider;_78 }_78_78 public function setProvider($name, $provider): void_78 {_78 $this->providers[$name] = $provider;_78 }_78_78 public function register($provider, $force = false): Provider_78 {_78 if (!$force && ($reg = $this->getProvider($provider)) !== null) {_78 return $reg;_78 }_78 if (is_string($provider)) {_78 $name = $provider;_78 $provider = new $provider($this->app);_78 $this->setProvider($name, $provider);_78 }_78 if (method_exists($provider, 'register')) {_78 $provider->register();_78 }_78 return $provider;_78 }_78_78 public function registers(array $providers): array_78 {_78 return array_map(function ($provider) {_78 return $this->register($provider);_78 }, $providers);_78 }_78_78 public function boot(): void_78 {_78 array_walk($this->providers, function (Provider $provider) {_78 if (!$provider->booted && method_exists($provider, 'boot')) {_78 $this->app->call('boot', [], $provider);_78 $provider->booted = true;_78 }_78 });_78 }_78}
其实看起来复杂,不过 ProviderManager
做的事情也很简单。
首先利用 Class
创建对应 Provider
实例,然后将 Provider
添加到 ProviderManager
的 Provider
数组中,最后判断有没有 register
方法,如果有则执行该方法。
有了注册,那么还需要一个启动:
_11<?php_11_11namespace App\Bootstrap;_11_11class BootProviders extends Bootstrap_11{_11 public function boot(): void_11 {_11 $this->app->getProviderManager()->boot();_11 }_11}
在 BootProviders
中 boot
方法会从服务容器中取得 ProviderManager
,然后调用其 boot
方法,依次执行 Provider
的 boot
方法。
结语
到这里 Provider 的部分就说完了。现在也放假了,PHP 微框架的文章会逐步更新。不过最近还是比较忙的,更新速度会慢一点。?
从零实现一个 PHP 微框架 - 服务提供者
https://blog.ixk.me/post/implement-a-php-microframework-from-zero-5许可协议
发布于
2020-07-10
本文作者
Otstar Lin
转载或引用本文时请遵守许可协议,注明出处、不得用于商业用途!