包开发

介绍
- 关于 Facades 的说明
包发现
服务提供者
资源
命令
- 优化命令
公共资源
发布文件组

介绍

包是向 Laravel 添加功能的主要方式。包可能是任何东西，从一个很好的处理日期的方式，比如 Carbon，到一个允许你将文件与 Eloquent 模型关联的包，比如 Spatie 的 Laravel Media Library。

有不同类型的包。一些包是独立的，意味着它们可以与任何 PHP 框架一起工作。Carbon 和 Pest 是独立包的例子。任何这些包都可以通过在你的 composer.json 文件中要求它们来与 Laravel 一起使用。

另一方面，其他包是专门为 Laravel 使用而设计的。这些包可能有专门用于增强 Laravel 应用程序的路由、控制器、视图和配置。本指南主要涵盖那些专门为 Laravel 开发的包。

关于 Facades 的说明

在编写 Laravel 应用程序时，使用 contracts 还是 facades 通常无关紧要，因为两者都提供了基本相同的可测试性。然而，在编写包时，你的包通常无法访问所有 Laravel 的测试助手。如果你希望能够像在典型的 Laravel 应用程序中安装包一样编写包测试，你可以使用 Orchestral Testbench 包。

包发现

Laravel 应用程序的 bootstrap/providers.php 文件包含了 Laravel 应该加载的服务提供者列表。然而，除了要求用户手动将你的服务提供者添加到列表中，你可以在包的 composer.json 文件的 extra 部分定义提供者，以便它可以被 Laravel 自动加载。除了服务提供者，你还可以列出任何你希望注册的 facades：

json

"extra": {
    "laravel": {
        "providers": [
            "Barryvdh\\Debugbar\\ServiceProvider"
        ],
        "aliases": {
            "Debugbar": "Barryvdh\\Debugbar\\Facade"
        }
    }
},

一旦你的包被配置为发现，Laravel 将在安装时自动注册其服务提供者和 facades，为你的包用户创造一个方便的安装体验。

选择退出包发现

如果你是包的消费者并希望禁用包发现，你可以在应用程序的 composer.json 文件的 extra 部分列出包名：

json

"extra": {
    "laravel": {
        "dont-discover": [
            "barryvdh/laravel-debugbar"
        ]
    }
},

你可以使用应用程序的 dont-discover 指令中的 * 字符禁用所有包的包发现：

json

"extra": {
    "laravel": {
        "dont-discover": [
            "*"
        ]
    }
},

服务提供者

服务提供者是你的包与 Laravel 之间的连接点。服务提供者负责将内容绑定到 Laravel 的服务容器并告知 Laravel 从哪里加载包资源，如视图、配置和语言文件。

服务提供者扩展了 Illuminate\Support\ServiceProvider 类，并包含两个方法：register 和 boot。基础 ServiceProvider 类位于 illuminate/support Composer 包中，你应该将其添加到你自己的包的依赖项中。要了解有关服务提供者的结构和目的的更多信息，请查看他们的文档。

资源

配置

通常，你需要将包的配置文件发布到应用程序的 config 目录。这将允许你的包用户轻松覆盖你的默认配置选项。要允许你的配置文件被发布，请从服务提供者的 boot 方法中调用 publishes 方法：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    $this->publishes([
        __DIR__.'/../config/courier.php' => config_path('courier.php'),
    ]);
}

现在，当你的包用户执行 Laravel 的 vendor:publish 命令时，你的文件将被复制到指定的发布位置。一旦你的配置被发布，其值可以像任何其他配置文件一样访问：

php

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

WARNING

你不应该在配置文件中定义闭包。当用户执行 config:cache Artisan 命令时，它们无法正确序列化。

默认包配置

你还可以将自己的包配置文件与应用程序的已发布副本合并。这将允许你的用户仅在已发布的配置文件副本中定义他们实际上想要覆盖的选项。要合并配置文件值，请在服务提供者的 register 方法中使用 mergeConfigFrom 方法。

mergeConfigFrom 方法接受你的包的配置文件的路径作为第一个参数，并接受应用程序的配置文件副本的名称作为第二个参数：

php

/**
 * 注册任何应用程序服务。
 */
public function register(): void
{
    $this->mergeConfigFrom(
        __DIR__.'/../config/courier.php', 'courier'
    );
}

WARNING

此方法仅合并配置数组的第一级。如果你的用户部分定义了多维配置数组，缺少的选项将不会被合并。

路由

如果你的包包含路由，你可以使用 loadRoutesFrom 方法加载它们。此方法将自动确定应用程序的路由是否已缓存，并且如果路由已缓存，将不会加载你的路由文件：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    $this->loadRoutesFrom(__DIR__.'/../routes/web.php');
}

迁移

如果你的包包含数据库迁移，你可以使用 publishesMigrations 方法通知 Laravel 给定的目录或文件包含迁移。当 Laravel 发布迁移时，它将自动更新其文件名中的时间戳以反映当前日期和时间：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    $this->publishesMigrations([
        __DIR__.'/../database/migrations' => database_path('migrations'),
    ]);
}

语言文件

如果你的包包含语言文件，你可以使用 loadTranslationsFrom 方法通知 Laravel 如何加载它们。例如，如果你的包名为 courier，你应该在服务提供者的 boot 方法中添加以下内容：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    $this->loadTranslationsFrom(__DIR__.'/../lang', 'courier');
}

包翻译行使用 package::file.line 语法约定引用。因此，你可以像这样从 messages 文件中加载 courier 包的 welcome 行：

php

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

你可以使用 loadJsonTranslationsFrom 方法为你的包注册 JSON 翻译文件。此方法接受包含包的 JSON 翻译文件的目录的路径：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    $this->loadJsonTranslationsFrom(__DIR__.'/../lang');
}

发布语言文件

如果你想将包的语言文件发布到应用程序的 lang/vendor 目录，你可以使用服务提供者的 publishes 方法。publishes 方法接受一个包路径数组及其所需的发布位置。例如，要发布 courier 包的语言文件，你可以执行以下操作：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    $this->loadTranslationsFrom(__DIR__.'/../lang', 'courier');

    $this->publishes([
        __DIR__.'/../lang' => $this->app->langPath('vendor/courier'),
    ]);
}

现在，当你的包用户执行 Laravel 的 vendor:publish Artisan 命令时，你的包的语言文件将被发布到指定的发布位置。

视图

要将包的视图注册到 Laravel，你需要告诉 Laravel 视图的位置。你可以使用服务提供者的 loadViewsFrom 方法来完成此操作。loadViewsFrom 方法接受两个参数：视图模板的路径和包的名称。例如，如果你的包名为 courier，你可以在服务提供者的 boot 方法中添加以下内容：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    $this->loadViewsFrom(__DIR__.'/../resources/views', 'courier');
}

包视图使用 package::view 语法约定引用。因此，一旦你的视图路径在服务提供者中注册，你可以像这样从 courier 包加载 dashboard 视图：

php

Route::get('/dashboard', function () {
    return view('courier::dashboard');
});

覆盖包视图

当你使用 loadViewsFrom 方法时，Laravel 实际上为你的视图注册了两个位置：应用程序的 resources/views/vendor 目录和你指定的目录。因此，以 courier 包为例，Laravel 将首先检查开发人员是否在 resources/views/vendor/courier 目录中放置了视图的自定义版本。然后，如果视图没有被自定义，Laravel 将搜索你在调用 loadViewsFrom 时指定的包视图目录。这使得包用户可以轻松自定义/覆盖包的视图。

发布视图

如果你想让你的视图可以发布到应用程序的 resources/views/vendor 目录，你可以使用服务提供者的 publishes 方法。publishes 方法接受一个包视图路径数组及其所需的发布位置：

php

/**
 * 启动包服务。
 */
public function boot(): void
{
    $this->loadViewsFrom(__DIR__.'/../resources/views', 'courier');

    $this->publishes([
        __DIR__.'/../resources/views' => resource_path('views/vendor/courier'),
    ]);
}

现在，当你的包用户执行 Laravel 的 vendor:publish Artisan 命令时，你的包的视图将被复制到指定的发布位置。

视图组件

如果你正在构建一个使用 Blade 组件的包或将组件放在非传统目录中，你需要手动注册你的组件类及其 HTML 标签别名，以便 Laravel 知道在哪里找到组件。你通常应该在包的服务提供者的 boot 方法中注册你的组件：

php

use Illuminate\Support\Facades\Blade;
use VendorPackage\View\Components\AlertComponent;

/**
 * 启动包的服务。
 */
public function boot(): void
{
    Blade::component('package-alert', AlertComponent::class);
}

一旦你的组件被注册，它可以使用其标签别名进行渲染：

blade

<x-package-alert/>

自动加载包组件

或者，你可以使用 componentNamespace 方法按约定自动加载组件类。例如，一个 Nightshade 包可能有 Calendar 和 ColorPicker 组件，它们位于 Nightshade\Views\Components 命名空间中：

php

use Illuminate\Support\Facades\Blade;

/**
 * 启动包的服务。
 */
public function boot(): void
{
    Blade::componentNamespace('Nightshade\\Views\\Components', 'nightshade');
}

这将允许使用包组件通过其供应商命名空间使用 package-name:: 语法：

blade

<x-nightshade::calendar />
<x-nightshade::color-picker />

Blade 将通过 pascal-casing 组件名称自动检测与此组件链接的类。子目录也支持使用“点”符号。

匿名组件

如果你的包包含匿名组件，它们必须放置在包的“视图”目录的 components 目录中（如 loadViewsFrom 方法指定）。然后，你可以通过在组件名称前加上包的视图命名空间来渲染它们：

blade

<x-courier::alert />

"About" Artisan 命令

Laravel 的内置 about Artisan 命令提供了应用程序环境和配置的概要。包可以通过 AboutCommand 类向此命令的输出推送附加信息。通常，这些信息可以从包服务提供者的 boot 方法中添加：

php

use Illuminate\Foundation\Console\AboutCommand;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    AboutCommand::add('My Package', fn () => ['Version' => '1.0.0']);
}

命令

要将包的 Artisan 命令注册到 Laravel，你可以使用 commands 方法。此方法期望一个命令类名数组。一旦命令被注册，你可以使用 Artisan CLI 执行它们：

php

use Courier\Console\Commands\InstallCommand;
use Courier\Console\Commands\NetworkCommand;

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    if ($this->app->runningInConsole()) {
        $this->commands([
            InstallCommand::class,
            NetworkCommand::class,
        ]);
    }
}

优化命令

Laravel 的 optimize 命令缓存应用程序的配置、事件、路由和视图。使用 optimizes 方法，你可以注册包自己的 Artisan 命令，这些命令应在执行 optimize 和 optimize:clear 命令时调用：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    if ($this->app->runningInConsole()) {
        $this->optimizes(
            optimize: 'package:optimize',
            clear: 'package:clear-optimizations',
        );
    }
}

公共资源

你的包可能有 JavaScript、CSS 和图像等资源。要将这些资源发布到应用程序的 public 目录，请使用服务提供者的 publishes 方法。在此示例中，我们还将添加一个 public 资源组标签，可用于轻松发布相关资源组：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    $this->publishes([
        __DIR__.'/../public' => public_path('vendor/courier'),
    ], 'public');
}

现在，当你的包用户执行 vendor:publish 命令时，你的资源将被复制到指定的发布位置。由于用户通常需要在每次更新包时覆盖资源，你可以使用 --force 标志：

shell

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

发布文件组

你可能希望单独发布包资源和资源组。例如，你可能希望允许用户发布包的配置文件，而不必强制发布包的资源。你可以通过在包的服务提供者的 boot 方法中调用 publishes 方法时“标记”它们来实现。例如，让我们使用标签为 courier 包定义两个发布组（courier-config 和 courier-migrations）：

php

/**
 * 启动任何包服务。
 */
public function boot(): void
{
    $this->publishes([
        __DIR__.'/../config/package.php' => config_path('package.php')
    ], 'courier-config');

    $this->publishesMigrations([
        __DIR__.'/../database/migrations/' => database_path('migrations')
    ], 'courier-migrations');
}

现在你的用户可以通过在执行 vendor:publish 命令时引用其标签来单独发布这些组：

shell

php artisan vendor:publish --tag=courier-config

你的用户也可以使用 --provider 标志发布由你的软件包服务提供者定义的所有可发布文件：

shell

php artisan vendor:publish --provider="Your\Package\ServiceProvider"

包开发 ​

介绍 ​

关于 Facades 的说明 ​

包发现 ​

选择退出包发现 ​

服务提供者 ​

资源 ​

配置 ​

默认包配置 ​

路由 ​

迁移 ​

语言文件 ​

发布语言文件 ​

视图 ​

覆盖包视图 ​

发布视图 ​

视图组件 ​

自动加载包组件 ​

匿名组件 ​

"About" Artisan 命令 ​

命令 ​

优化命令 ​

公共资源 ​

发布文件组 ​

包开发

介绍

关于 Facades 的说明

包发现

选择退出包发现

服务提供者

资源

配置

默认包配置

路由

迁移

语言文件

发布语言文件

视图

覆盖包视图

发布视图

视图组件

自动加载包组件

匿名组件

"About" Artisan 命令

命令

优化命令

公共资源

发布文件组