扩展包开发

简介

扩展包是向 Laravel 中添加功能的主要方式。扩展包可以包含很多有用的功能，例如时间处理扩展包 Carbon，亦或者是提供完整 BDD 测试框架的扩展包 Behat。

当然，扩展包有很多种类型。有些扩展包是独立运行的，意味着他们可以在任意的 PHP 框架中使用。Carbon 和 Behat 就是这样的独立扩展包。要在 Laravel 中使用这种扩展包只需要在 composer.json 文件中引入他们即可。

另一方面，有些扩展包只能在 Laravel 中使用。这些扩展包可能包含专门用来增强 Laravel 应用的路由、控制器、视图和配置的文件。这份指南主要介绍 Laravel 扩展包的开发。

Facades 注解

当开发 Laravel 应用时，通常使用契约（contracts）或 facades 没有什么区别，因为他们都提供基本相同的可测试能力。然而，在进行扩展包开发的时候，扩展包并不能访问 Laravel 提供的所有测试辅助函数。如果你想像在 Laravel 应用中一样编写扩展包的测试用例，你可以使用扩展包 Orchestral Testbench 。

发现扩展包

在 Laravel 应用的 config/app.php 配置文件中，providers 选项定义了能够被 Laravel 加载的服务提供者列表。当有人安装你的扩展包时，你需要将你的服务提供者包含到这个列表中。你可以将服务提供者定义到扩展包的 composer.json 文件中的 extra 部分，而不是让用户手动将你的服务提供者添加到列表中。除了服务提供者，还可以列出所有你想注册的 facades ：

  1. "extra": {
  2.     "laravel": {
  3.         "providers": [
  4.             "Barryvdh\\Debugbar\\ServiceProvider"
  5.         ],
  6.         "aliases": {
  7.             "Debugbar": "Barryvdh\\Debugbar\\Facade"
  8.         }
  9.     }
  10. },

一旦你的扩展包配置为可发现，Laravel 就会在安装时自动注册扩展包的服务提供者和 facades，为扩展包的用户提供一个友好的安装体验。

选择性的发现扩展包

如果你是扩展包的用户，想要禁止一个扩展包被发现，你可以在应用的 composer.json 文件中的 extra 部分列出这个扩展包：

  1. "extra": {
  2.     "laravel": {
  3.         "dont-discover": [
  4.             "barryvdh/laravel-debugbar"
  5.         ]
  6.     }
  7. },

你也可以通过在应用的 dont-discover 指令中使用 * 字符，禁用扩展包发现功能：

  1. "extra": {
  2.     "laravel": {
  3.         "dont-discover": [
  4.             "*"
  5.         ]
  6.     }
  7. },

服务提供者

服务提供者 让你的扩展包与 Laravel 联系在一起。服务提供者负责将一些东西绑定到 Laravel 的 服务容器 中，并且告诉 Laravel 从哪里加载扩展包的资源文件，例如视图、配置文件、语言包等。

服务提供者继承了 Illuminate\Support\ServiceProvider 类，并包含了两个方法：register 和 boot。基类 ServiceProvider 位于名为 illuminate/support 的 Composer 扩展包中，你必须将它加入到你的扩展包依赖。想要了解更多关于服务提供者的结构和用途，请查阅 它的文档。

资源文件

配置

有时，你需要将扩展包配置文件发布到应用本身的 config 目录中。这样使用扩展包的用户就可以轻松的重写默认配置项。想要发布扩展包配置文件，只需要在服务提供者的 boot 方法中调用 publishes 方法即可：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     $this->publishes([
  9.         __DIR__.'/path/to/config/courier.php' => config_path('courier.php'),
  10.     ]);
  11. }

现在，当扩展包的用户执行 Laravel 的 vendor:publish 命令，扩展包文件就会被复制到指定的目录中。当然，一旦你的配置文件被发布，就可以如同其他配置一样被访问：

  1. $value = config('courier.option');

{注意} 你不应该在配置文件中定义闭包函数。因为当用户执行 config:cache Artisan 命令时，配置文件将不能被正确的序列化。

扩展包默认配置

你也可以将扩展包默认配置与应用的副本配置合并在一起。这样扩展包用户就可以在副本配置文件中定义他们想要覆盖的配置选项。想要合并配置，只需要在服务提供者的 register 方法中调用 mergeConfigFrom 方法即可：

  1. /**
  2.  *  在容器中注册绑定
  3.  *
  4.  * @return void
  5.  */
  6. public function register()
  7. {
  8.     $this->mergeConfigFrom(
  9.         __DIR__.'/path/to/config/courier.php', 'courier'
  10.     );
  11. }

{注意} 此方法只合并配置数组的第一维。如果扩展包用户定义了多维配置数组，缺少的选项将不会被合并。

路由

如果你的扩展包中包含路由文件，你需要使用 loadRoutesFrom 方法加载他们。此方法将自动判断应用的路由是否已被缓存，如果路由已缓存，将不会加载你的路由文件：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     $this->loadRoutesFrom(__DIR__.'/routes.php');
  9. }

数据库迁移

如果你的扩展包中包含 数据库迁移，你需要使用 loadMigrationsFrom 方法告知 Laravel 如何加载他们。loadMigrationsFrom 方法只需要扩展包迁移文件路径作为唯一参数：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     $this->loadMigrationsFrom(__DIR__.'/path/to/migrations');
  9. }

一旦你的扩展包迁移文件被注册，当运行 php artisan migrate 命令时他们就会被自动执行。你不需要将他们导入到应用的 database/migrations 目录中。

语言包

如果你的扩展包中包含 语言包文件，你需要使用 loadTranslationsFrom 方法告知 Laravel 如何加载他们。例如，如果你的扩展包名为 courier，你需要将下面的内容加入到服务提供者的 boot 方法中：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     $this->loadTranslationsFrom(__DIR__.'/path/to/translations', 'courier');
  9. }

扩展包翻译约定使用 package::file.line 语法进行引用。因此，你可以按照下面的方式来加载 courier 扩展包中的 messages 文件的 welcome 行：

  1. echo trans('courier::messages.welcome');

发布语言包

如果你想要将扩展包中的语言包发布到应用的 resources/lang/vendor 目录，可以使用服务提供者的 publishes 方法。publishes 方法接收一个包含语言包路径和对应发布位置的数组。例如，发布 courier 扩展包的语言包文件，操作如下：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     $this->loadTranslationsFrom(__DIR__.'/path/to/translations', 'courier');
  10.     $this->publishes([
  11.         __DIR__.'/path/to/translations' => resource_path('lang/vendor/courier'),
  12.     ]);
  13. }

现在，当扩展包的用户执行 Laravel 的 vendor:publish Artisan 命令，语言包将会被发布到指定的目录中。

视图

想要在 Laravel 中注册你的扩展包的 视图 ， 需要告知 Laravel 视图文件的位置。你可以使用服务提供者的 loadViewsFrom 方法来实现。loadViewsFrom 方法允许接收两个参数：视图模板路径和扩展包名。例如，如果你的扩展包名为 courier，你需要将下面的内容加入到服务提供者的 boot 方法中：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     $this->loadViewsFrom(__DIR__.'/path/to/views', 'courier');
  9. }

扩展包视图约定使用 package::view 语法进行引用。因此，一旦视图路径在服务提供者中注册成功，你可以使用下面的方式来加载 courier 扩展包中的 admin 视图：

  1. Route::get('admin', function () {
  2.     return view('courier::admin');
  3. });

重写扩展包视图

当你使用 loadViewsFrom 方法时，Laravel 实际上在两个位置注册视图：应用的 resources/views/vendor 目录和你的自定义目录。所以，还以 courier 扩展包为例，Laravel 首先会检查开发人员是否在 resources/views/vendor/courier 中提供了一个自定义版本的视图。然后，如果视图尚未被定义，Laravel 将会搜索在 loadViewsFrom 中定义的视图目录。这种方法可以让用户很简单的自定义或重写扩展包的视图。

发布视图

如果你希望将你的视图发布到应用的 resources/views/vendor 目录中，可以使用服务提供者的 publishes 方法。publishes 方法接收一个包含视图路径和对应发布位置的数组：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     $this->loadViewsFrom(__DIR__.'/path/to/views', 'courier');
  10.     $this->publishes([
  11.         __DIR__.'/path/to/views' => resource_path('views/vendor/courier'),
  12.     ]);
  13. }

现在，当扩展包的用户执行 Laravel 的 vendor:publish Artisan 命令，视图将会被发布到自定的目录中。

命令

想要在 Laravel 中注册扩展包的 Artisan 命令，需要使用 commands 方法。此方法接收一个命令类的数组。一旦这些命令注册成功，可以使用 Artisan 命令行 执行他们：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     if ($this->app->runningInConsole()) {
  9.         $this->commands([
  10.             FooCommand::class,
  11.             BarCommand::class,
  12.         ]);
  13.     }
  14. }

公共资源文件

你的扩展包中可能存在 JavaScript、CSS 和图片之类的资源文件。想要发布这些资源文件到应用的 public 目录，可以使用服务提供者的 publishes 方法。在下面的例子中，我们也可以添加一个 public 资源分类标签，可用于相关发布资源的分类：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     $this->publishes([
  9.         __DIR__.'/path/to/assets' => public_path('vendor/courier'),
  10.     ], 'public');
  11. }

在，当扩展包的用户执行 vendor:publish 命令，你的资源文件将会被复制到指定的目录中。由于每次更新扩展包时通常都需要覆盖资源文件，因此需要使用 —force 标签：

  1. php artisan vendor:publish --tag=public --force

发布群组文件

你可能想要分别打包发布扩展包资源文件或资源。举个例子，你想让用户单独发布扩展包中的配置文件，而不是被强制发布扩展包中的所有资源文件。你可以通过调用扩展包服务提供者中的 publishes 方法给不同文件打上「标签」。例如，让我们使用扩展包服务提供者中的 boot 方法来定义两个发布群组：

  1. /**
  2.  * 在注册后启动服务
  3.  *
  4.  * @return void
  5.  */
  6. public function boot()
  7. {
  8.     $this->publishes([
  9.         __DIR__.'/../config/package.php' => config_path('package.php')
  10.     ], 'config');
  12.     $this->publishes([
  13.         __DIR__.'/../database/migrations/' => database_path('migrations')
  14.     ], 'migrations');
  15. }

现在你的用户就可以通过执行 vendor:publish 命令，根据定义的标签来发布不同的群组文件：

  1. php artisan vendor:publish --tag=config

本文章首发在 LearnKu.com 网站上。

本文中的所有译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接 我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。