Laravel Pennant

简介

Laravel Pennant 是一个简单轻量的功能标志（feature flag）包——没有多余的复杂性。功能标志使你能够自信地增量推出新的应用功能、A/B 测试新的界面设计、补充基于主干的开发策略等等。

安装

首先，使用 Composer 包管理器将 Pennant 安装到你的项目中：

shell

composer require laravel/pennant

接下来，你应该使用 vendor:publish Artisan 命令发布 Pennant 的配置和迁移文件：

shell

php artisan vendor:publish --provider="Laravel\Pennant\PennantServiceProvider"

最后，你应该运行应用的数据库迁移。这将创建一个 features 表，Pennant 使用它来驱动其 database 驱动：

shell

php artisan migrate

配置

发布 Pennant 的资源后，其配置文件将位于 config/pennant.php。此配置文件允许你指定 Pennant 用于存储已解析的功能标志值的默认存储机制。

Pennant 支持通过 array 驱动将已解析的功能标志值存储在内存数组中。或者，Pennant 可以通过 database 驱动将已解析的功能标志值持久化存储在关系数据库中，这是 Pennant 使用的默认存储机制。

定义功能

要定义一个功能，你可以使用 Feature facade 提供的 define 方法。你需要为功能提供一个名称，以及一个将被调用来解析功能初始值的闭包。

通常，功能是在服务提供者中使用 Feature facade 定义的。闭包将接收功能检查的"作用域"。最常见的作用域是当前认证的用户。在此示例中，我们将定义一个功能，用于向应用的用户增量推出新的 API：

php

<?php

namespace App\Providers;

use App\Models\User;
use Illuminate\Support\Lottery;
use Illuminate\Support\ServiceProvider;
use Laravel\Pennant\Feature;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Feature::define('new-api', fn (User $user) => match (true) {
            $user->isInternalTeamMember() => true,
            $user->isHighTrafficCustomer() => false,
            default => Lottery::odds(1 / 100),
        });
    }
}

如你所见，我们为功能定义了以下规则：

所有内部团队成员应使用新 API。
任何高流量客户不应使用新 API。
否则，该功能应以 1/100 的概率随机分配给用户。

首次为给定用户检查 new-api 功能时，闭包的结果将由存储驱动存储。下次针对同一用户检查该功能时，值将从存储中检索，闭包不会被调用。

为方便起见，如果功能定义仅返回一个 lottery，你可以完全省略闭包：

Feature::define('site-redesign', Lottery::odds(1, 1000));

基于类的功能

Pennant 还允许你定义基于类的功能。与基于闭包的功能定义不同，无需在服务提供者中注册基于类的功能。要创建基于类的功能，你可以调用 pennant:feature Artisan 命令。默认情况下，功能类将放置在应用的 app/Features 目录中：

shell

php artisan pennant:feature NewApi

编写功能类时，你只需要定义一个 resolve 方法，该方法将被调用来为给定作用域解析功能的初始值。同样，作用域通常是当前认证的用户：

php

<?php

namespace App\Features;

use App\Models\User;
use Illuminate\Support\Lottery;

class NewApi
{
    /**
     * Resolve the feature's initial value.
     */
    public function resolve(User $user): mixed
    {
        return match (true) {
            $user->isInternalTeamMember() => true,
            $user->isHighTrafficCustomer() => false,
            default => Lottery::odds(1 / 100),
        };
    }
}

如果你想手动解析基于类的功能实例，可以在 Feature facade 上调用 instance 方法：

php

use Illuminate\Support\Facades\Feature;

$instance = Feature::instance(NewApi::class);

NOTE

功能类通过容器解析，因此你可以在需要时向功能类的构造函数注入依赖。

自定义存储的功能名称

默认情况下，Pennant 会存储功能类的完全限定类名。如果你想将存储的功能名称与应用的内部结构解耦，可以在功能类上添加 Name 属性。该属性的值将代替类名进行存储：

php

<?php

namespace App\Features;

use Laravel\Pennant\Attributes\Name;

#[Name('new-api')]
class NewApi
{
    // ...
}

检查功能

要确定某个功能是否激活，你可以使用 Feature facade 的 active 方法。默认情况下，功能是针对当前认证的用户进行检查的：

php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Laravel\Pennant\Feature;

class PodcastController
{
    /**
     * Display a listing of the resource.
     */
    public function index(Request $request): Response
    {
        return Feature::active('new-api')
            ? $this->resolveNewApiResponse($request)
            : $this->resolveLegacyApiResponse($request);
    }

    // ...
}

虽然功能默认针对当前认证的用户进行检查，但你可以轻松地针对其他用户或作用域检查功能。为此，请使用 Feature facade 提供的 for 方法：

php

return Feature::for($user)->active('new-api')
    ? $this->resolveNewApiResponse($request)
    : $this->resolveLegacyApiResponse($request);

Pennant 还提供了一些额外的便捷方法，在确定功能是否激活时可能很有用：

php

// 确定所有给定的功能是否都激活...
Feature::allAreActive(['new-api', 'site-redesign']);

// 确定任何给定的功能是否激活...
Feature::someAreActive(['new-api', 'site-redesign']);

// 确定某个功能是否未激活...
Feature::inactive('new-api');

// 确定所有给定的功能是否都未激活...
Feature::allAreInactive(['new-api', 'site-redesign']);

// 确定任何给定的功能是否未激活...
Feature::someAreInactive(['new-api', 'site-redesign']);

NOTE

在 HTTP 上下文之外使用 Pennant 时，例如在 Artisan 命令或队列任务中，你通常应该显式指定功能的作用域。或者，你可以定义一个默认作用域来同时处理已认证的 HTTP 上下文和未认证的上下文。

检查基于类的功能

对于基于类的功能，检查功能时应提供类名：

php

<?php

namespace App\Http\Controllers;

use App\Features\NewApi;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Laravel\Pennant\Feature;

class PodcastController
{
    /**
     * Display a listing of the resource.
     */
    public function index(Request $request): Response
    {
        return Feature::active(NewApi::class)
            ? $this->resolveNewApiResponse($request)
            : $this->resolveLegacyApiResponse($request);
    }

    // ...
}

条件执行

when 方法可用于在功能激活时流畅地执行给定的闭包。此外，可以提供第二个闭包，它将在功能未激活时执行：

php

<?php

namespace App\Http\Controllers;

use App\Features\NewApi;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Laravel\Pennant\Feature;

class PodcastController
{
    /**
     * Display a listing of the resource.
     */
    public function index(Request $request): Response
    {
        return Feature::when(NewApi::class,
            fn () => $this->resolveNewApiResponse($request),
            fn () => $this->resolveLegacyApiResponse($request),
        );
    }

    // ...
}

unless 方法是 when 方法的反向操作，在功能未激活时执行第一个闭包：

php

return Feature::unless(NewApi::class,
    fn () => $this->resolveLegacyApiResponse($request),
    fn () => $this->resolveNewApiResponse($request),
);

`HasFeatures` Trait

Pennant 的 HasFeatures trait 可以添加到你应用的 User 模型（或任何其他具有功能的模型）中，以提供一种流畅、便捷的方式直接从模型检查功能：

php

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Laravel\Pennant\Concerns\HasFeatures;

class User extends Authenticatable
{
    use HasFeatures;

    // ...
}

一旦 trait 被添加到你的模型中，你可以通过调用 features 方法轻松检查功能：

php

if ($user->features()->active('new-api')) {
    // ...
}

当然，features 方法还提供了许多其他便捷方法来与功能交互：

php

// Values...
$value = $user->features()->value('purchase-button')
$values = $user->features()->values(['new-api', 'purchase-button']);

// State...
$user->features()->active('new-api');
$user->features()->allAreActive(['new-api', 'server-api']);
$user->features()->someAreActive(['new-api', 'server-api']);

$user->features()->inactive('new-api');
$user->features()->allAreInactive(['new-api', 'server-api']);
$user->features()->someAreInactive(['new-api', 'server-api']);

// 条件执行...
$user->features()->when('new-api',
    fn () => /* ... */,
    fn () => /* ... */,
);

$user->features()->unless('new-api',
    fn () => /* ... */,
    fn () => /* ... */,
);

Blade 指令

为了让在 Blade 中检查功能成为无缝体验，Pennant 提供了 @feature 和 @featureany 指令：

blade

@feature('site-redesign')
    <!-- 'site-redesign' 已激活 -->
@else
    <!-- 'site-redesign' 未激活 -->
@endfeature

@featureany(['site-redesign', 'beta'])
    <!-- 'site-redesign' 或 `beta` 已激活 -->
@endfeatureany

Middleware

Pennant 还包含一个 middleware，可用于在路由被调用之前验证当前认证的用户是否有权访问某个功能。你可以将 middleware 分配给路由并指定访问该路由所需的功能。如果当前认证用户的任何指定功能未激活，路由将返回 400 Bad Request HTTP 响应。可以将多个功能传递给静态 using 方法。

php

use Illuminate\Support\Facades\Route;
use Laravel\Pennant\Middleware\EnsureFeaturesAreActive;

Route::get('/api/servers', function () {
    // ...
})->middleware(EnsureFeaturesAreActive::using('new-api', 'servers-api'));

自定义响应

如果你想自定义当列出的某个功能未激活时 middleware 返回的响应，可以使用 EnsureFeaturesAreActive middleware 提供的 whenInactive 方法。通常，此方法应在你应用的某个服务提供者的 boot 方法中调用：

php

use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Laravel\Pennant\Middleware\EnsureFeaturesAreActive;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    EnsureFeaturesAreActive::whenInactive(
        function (Request $request, array $features) {
            return new Response(status: 403);
        }
    );

    // ...
}

拦截功能检查

有时在检索给定功能的存储值之前执行一些内存中检查可能很有用。假设你正在功能标志后面开发一个新 API，并希望能够在不丢失存储中任何已解析功能值的情况下禁用新 API。如果你发现新 API 中有 bug，可以轻松地为除内部团队成员之外的所有人禁用它，修复 bug，然后为之前有权访问该功能的用户重新启用新 API。

你可以通过基于类的功能的 before 方法来实现这一点。当存在时，before 方法始终在从存储检索值之前在内存中运行。如果方法返回非 null 值，它将在请求期间代替功能的存储值使用：

php

<?php

namespace App\Features;

use App\Models\User;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Lottery;

class NewApi
{
    /**
     * Run an always-in-memory check before the stored value is retrieved.
     */
    public function before(User $user): mixed
    {
        if (Config::get('features.new-api.disabled')) {
            return $user->isInternalTeamMember();
        }
    }

    /**
     * Resolve the feature's initial value.
     */
    public function resolve(User $user): mixed
    {
        return match (true) {
            $user->isInternalTeamMember() => true,
            $user->isHighTrafficCustomer() => false,
            default => Lottery::odds(1 / 100),
        };
    }
}

你还可以使用此功能来安排之前位于功能标志后面的功能的全局推出：

php

<?php

namespace App\Features;

use Illuminate\Support\Carbon;
use Illuminate\Support\Facades\Config;

class NewApi
{
    /**
     * Run an always-in-memory check before the stored value is retrieved.
     */
    public function before(User $user): mixed
    {
        if (Config::get('features.new-api.disabled')) {
            return $user->isInternalTeamMember();
        }

        if (Carbon::parse(Config::get('features.new-api.rollout-date'))->isPast()) {
            return true;
        }
    }

    // ...
}

内存缓存

检查功能时，Pennant 会创建结果的内存缓存。如果你使用 database 驱动，这意味着在单个请求中重新检查相同的功能标志不会触发额外的数据库查询。这也确保了功能在请求期间具有一致的结果。

如果你需要手动刷新内存缓存，可以使用 Feature facade 提供的 flushCache 方法：

php

Feature::flushCache();

作用域

指定作用域

如前所述，功能通常针对当前认证的用户进行检查。然而，这可能并不总是满足你的需求。因此，可以通过 Feature facade 的 for 方法指定你想要检查给定功能的作用域：

php

return Feature::for($user)->active('new-api')
    ? $this->resolveNewApiResponse($request)
    : $this->resolveLegacyApiResponse($request);

当然，功能作用域不仅限于"用户"。假设你构建了一个新的计费体验，你正在向整个团队而不是单个用户推出。也许你希望较老的团队比较新的团队有更慢的推出速度。你的功能解析闭包可能看起来像这样：

php

use App\Models\Team;
use Illuminate\Support\Carbon;
use Illuminate\Support\Lottery;
use Laravel\Pennant\Feature;

Feature::define('billing-v2', function (Team $team) {
    if ($team->created_at->isAfter(new Carbon('1st Jan, 2023'))) {
        return true;
    }

    if ($team->created_at->isAfter(new Carbon('1st Jan, 2019'))) {
        return Lottery::odds(1 / 100);
    }

    return Lottery::odds(1 / 1000);
});

你会注意到我们定义的闭包不期望接收 User，而是期望接收 Team 模型。要确定此功能对用户的团队是否激活，你应该将团队传递给 Feature facade 提供的 for 方法：

php

if (Feature::for($user->team)->active('billing-v2')) {
    return redirect('/billing/v2');
}

// ...

默认作用域

也可以自定义 Pennant 用于检查功能的默认作用域。例如，也许你所有的功能都是针对当前认证用户的团队进行检查的，而不是用户本身。你可以指定团队作为默认作用域，而不必每次检查功能时都调用 Feature::for($user->team)。通常，这应该在你应用的某个服务提供者中完成：

php

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Auth;
use Illuminate\Support\ServiceProvider;
use Laravel\Pennant\Feature;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Feature::resolveScopeUsing(fn ($driver) => Auth::user()?->team);

        // ...
    }
}

如果没有通过 for 方法显式提供作用域，功能检查现在将使用当前认证用户的团队作为默认作用域：

php

Feature::active('billing-v2');

// 现在等同于...

Feature::for($user->team)->active('billing-v2');

可空作用域

如果你在检查功能时提供的作用域为 null，并且功能的定义不通过可空类型或在联合类型中包含 null 来支持 null，Pennant 将自动返回 false 作为功能的结果值。

因此，如果你传递给功能的作用域可能为 null，并且你希望功能的值解析器被调用，你应该在功能定义中考虑到这一点。如果你在 Artisan 命令、队列任务或未认证的路由中检查功能，可能会出现 null 作用域。由于在这些上下文中通常没有认证的用户，默认作用域将为 null。

如果你不总是显式指定功能作用域，那么你应该确保作用域的类型是"可空的"，并在功能定义逻辑中处理 null 作用域值：

php

use App\Models\User;
use Illuminate\Support\Lottery;
use Laravel\Pennant\Feature;

Feature::define('new-api', fn (User $user) => match (true) {// [tl! remove]
Feature::define('new-api', fn (User|null $user) => match (true) {// [tl! add]
    $user === null => true,// [tl! add]
    $user->isInternalTeamMember() => true,
    $user->isHighTrafficCustomer() => false,
    default => Lottery::odds(1 / 100),
});

识别作用域

Pennant 内置的 array 和 database 存储驱动知道如何正确存储所有 PHP 数据类型以及 Eloquent 模型的作用域标识符。然而，如果你的应用使用第三方 Pennant 驱动，该驱动可能不知道如何正确存储 Eloquent 模型或应用中其他自定义类型的标识符。

鉴于此，Pennant 允许你通过在应用中用作 Pennant 作用域的对象上实现 FeatureScopeable 契约来格式化用于存储的作用域值。

例如，假设你在单个应用中使用两个不同的功能驱动：内置的 database 驱动和第三方的 "Flag Rocket" 驱动。"Flag Rocket" 驱动不知道如何正确存储 Eloquent 模型。相反，它需要一个 FlagRocketUser 实例。通过实现 FeatureScopeable 契约定义的 toFeatureIdentifier，我们可以自定义提供给应用使用的每个驱动的可存储作用域值：

php

<?php

namespace App\Models;

use FlagRocket\FlagRocketUser;
use Illuminate\Database\Eloquent\Model;
use Laravel\Pennant\Contracts\FeatureScopeable;

class User extends Model implements FeatureScopeable
{
    /**
     * Cast the object to a feature scope identifier for the given driver.
     */
    public function toFeatureIdentifier(string $driver): mixed
    {
        return match($driver) {
            'database' => $this,
            'flag-rocket' => FlagRocketUser::fromId($this->flag_rocket_id),
        };
    }
}

序列化作用域

默认情况下，Pennant 在存储与 Eloquent 模型关联的功能时使用完全限定类名。如果你已经使用了 Eloquent morph map，你可以选择让 Pennant 也使用 morph map 来将存储的功能与应用结构解耦。

为此，在服务提供者中定义 Eloquent morph map 后，你可以调用 Feature facade 的 useMorphMap 方法：

php

use Illuminate\Database\Eloquent\Relations\Relation;
use Laravel\Pennant\Feature;

Relation::enforceMorphMap([
    'post' => 'App\Models\Post',
    'video' => 'App\Models\Video',
]);

Feature::useMorphMap();

丰富的功能值

到目前为止，我们主要展示的是功能处于二元状态，即它们要么"激活"要么"未激活"，但 Pennant 也允许你存储丰富的值。

例如，假设你正在为应用的 "Buy now" 按钮测试三种新颜色。你可以从功能定义中返回一个字符串，而不是返回 true 或 false：

php

use Illuminate\Support\Arr;
use Laravel\Pennant\Feature;

Feature::define('purchase-button', fn (User $user) => Arr::random([
    'blue-sapphire',
    'seafoam-green',
    'tart-orange',
]));

你可以使用 value 方法检索 purchase-button 功能的值：

php

$color = Feature::value('purchase-button');

Pennant 包含的 Blade 指令也使得根据功能的当前值有条件地渲染内容变得简单：

blade

@feature('purchase-button', 'blue-sapphire')
    <!-- 'blue-sapphire' 已激活 -->
@elsefeature('purchase-button', 'seafoam-green')
    <!-- 'seafoam-green' 已激活 -->
@elsefeature('purchase-button', 'tart-orange')
    <!-- 'tart-orange' 已激活 -->
@endfeature

NOTE

使用丰富值时，重要的是要知道功能在具有除 false 之外的任何值时被视为"激活"。

调用条件 when 方法时，功能的丰富值将提供给第一个闭包：

php

Feature::when('purchase-button',
    fn ($color) => /* ... */,
    fn () => /* ... */,
);

同样，调用条件 unless 方法时，功能的丰富值将提供给可选的第二个闭包：

php

Feature::unless('purchase-button',
    fn () => /* ... */,
    fn ($color) => /* ... */,
);

检索多个功能

values 方法允许检索给定作用域的多个功能：

php

Feature::values(['billing-v2', 'purchase-button']);

// [
//     'billing-v2' => false,
//     'purchase-button' => 'blue-sapphire',
// ]

或者，你可以使用 all 方法检索给定作用域的所有已定义功能的值：

php

Feature::all();

// [
//     'billing-v2' => false,
//     'purchase-button' => 'blue-sapphire',
//     'site-redesign' => true,
// ]

然而，基于类的功能是动态注册的，在显式检查之前 Pennant 不知道它们。这意味着如果在当前请求中尚未检查过，你应用的基于类的功能可能不会出现在 all 方法返回的结果中。

如果你希望确保在使用 all 方法时始终包含功能类，可以使用 Pennant 的功能发现能力。首先，在你应用的某个服务提供者中调用 discover 方法：

php

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Laravel\Pennant\Feature;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Feature::discover();

        // ...
    }
}

discover 方法将注册你应用 app/Features 目录中的所有功能类。all 方法现在将在其结果中包含这些类，无论它们是否在当前请求中被检查过：

php

Feature::all();

// [
//     'App\Features\NewApi' => true,
//     'billing-v2' => false,
//     'purchase-button' => 'blue-sapphire',
//     'site-redesign' => true,
// ]

预加载

虽然 Pennant 为单个请求保留所有已解析功能的内存缓存，但仍然可能遇到性能问题。为了缓解这个问题，Pennant 提供了预加载功能值的能力。

为了说明这一点，假设我们在循环中检查功能是否激活：

php

use Laravel\Pennant\Feature;

foreach ($users as $user) {
    if (Feature::for($user)->active('notifications-beta')) {
        $user->notify(new RegistrationSuccess);
    }
}

假设我们使用数据库驱动，此代码将为循环中的每个用户执行一个数据库查询——可能执行数百个查询。然而，使用 Pennant 的 load 方法，我们可以通过预加载用户集合或作用域的功能值来消除这个潜在的性能瓶颈：

php

Feature::for($users)->load(['notifications-beta']);

foreach ($users as $user) {
    if (Feature::for($user)->active('notifications-beta')) {
        $user->notify(new RegistrationSuccess);
    }
}

要仅在尚未加载时加载功能值，可以使用 loadMissing 方法：

php

Feature::for($users)->loadMissing([
    'new-api',
    'purchase-button',
    'notifications-beta',
]);

你可以使用 loadAll 方法加载所有已定义的功能：

php

Feature::for($users)->loadAll();

更新值

当功能的值首次被解析时，底层驱动将结果存储在存储中。这通常是必要的，以确保用户在请求之间获得一致的体验。然而，有时你可能想要手动更新功能的存储值。

为此，你可以使用 activate 和 deactivate 方法来切换功能的"开"或"关"：

php

use Laravel\Pennant\Feature;

// 为默认作用域激活功能...
Feature::activate('new-api');

// 为给定作用域停用功能...
Feature::for($user->team)->deactivate('billing-v2');

也可以通过向 activate 方法提供第二个参数来手动设置功能的丰富值：

php

Feature::activate('purchase-button', 'seafoam-green');

要指示 Pennant 忘记功能的存储值，可以使用 forget 方法。当再次检查该功能时，Pennant 将从其功能定义中解析功能的值：

php

Feature::forget('purchase-button');

批量更新

要批量更新存储的功能值，可以使用 activateForEveryone 和 deactivateForEveryone 方法。

例如，假设你现在对 new-api 功能的稳定性充满信心，并且已经为你的结账流程确定了最佳的 'purchase-button' 颜色——你可以相应地为所有用户更新存储的值：

php

use Laravel\Pennant\Feature;

Feature::activateForEveryone('new-api');

Feature::activateForEveryone('purchase-button', 'seafoam-green');

或者，你可以为所有用户停用该功能：

php

Feature::deactivateForEveryone('new-api');

NOTE

这只会更新已由 Pennant 的存储驱动存储的已解析功能值。你还需要更新应用中的功能定义。

清除功能

有时，从存储中清除整个功能可能很有用。如果你已从应用中移除了该功能，或者你对功能定义进行了调整并希望向所有用户推出，这通常是必要的。

你可以使用 purge 方法删除功能的所有存储值：

php

// 清除单个功能...
Feature::purge('new-api');

// 清除多个功能...
Feature::purge(['new-api', 'purchase-button']);

如果你想从存储中清除所有功能，可以不带任何参数调用 purge 方法：

php

Feature::purge();

由于在应用的部署流程中清除功能可能很有用，Pennant 包含一个 pennant:purge Artisan 命令，该命令将从存储中清除提供的功能：

shell

php artisan pennant:purge new-api

php artisan pennant:purge new-api purchase-button

也可以清除给定功能列表之外的所有功能。例如，假设你想清除所有功能，但保留存储中 "new-api" 和 "purchase-button" 功能的值。为此，你可以将这些功能名称传递给 --except 选项：

shell

php artisan pennant:purge --except=new-api --except=purchase-button

为方便起见，pennant:purge 命令还支持 --except-registered 标志。此标志表示应清除所有功能，除了那些在服务提供者中显式注册的功能：

shell

php artisan pennant:purge --except-registered

测试

在测试与功能标志交互的代码时，控制功能标志在测试中返回值的最简单方法是简单地重新定义该功能。例如，假设你在应用的某个服务提供者中定义了以下功能：

php

use Illuminate\Support\Arr;
use Laravel\Pennant\Feature;

Feature::define('purchase-button', fn () => Arr::random([
    'blue-sapphire',
    'seafoam-green',
    'tart-orange',
]));

要在测试中修改功能的返回值，你可以在测试开始时重新定义该功能。以下测试将始终通过，即使 Arr::random() 实现仍然存在于服务提供者中：

PestPHPUnit

php

use Laravel\Pennant\Feature;

test('it can control feature values', function () {
    Feature::define('purchase-button', 'seafoam-green');

    expect(Feature::value('purchase-button'))->toBe('seafoam-green');
});

php

use Laravel\Pennant\Feature;

public function test_it_can_control_feature_values()
{
    Feature::define('purchase-button', 'seafoam-green');

    $this->assertSame('seafoam-green', Feature::value('purchase-button'));
}

同样的方法也可用于基于类的功能：

PestPHPUnit

php

use Laravel\Pennant\Feature;

test('it can control feature values', function () {
    Feature::define(NewApi::class, true);

    expect(Feature::value(NewApi::class))->toBeTrue();
});

php

use App\Features\NewApi;
use Laravel\Pennant\Feature;

public function test_it_can_control_feature_values()
{
    Feature::define(NewApi::class, true);

    $this->assertTrue(Feature::value(NewApi::class));
}

如果你的功能返回 Lottery 实例，有一些有用的测试辅助方法可用。

存储配置

你可以通过在应用的 phpunit.xml 文件中定义 PENNANT_STORE 环境变量来配置 Pennant 在测试期间使用的存储：

xml

<?xml version="1.0" encoding="UTF-8"?>
<phpunit colors="true">
    <!-- ... -->
    <php>
        <env name="PENNANT_STORE" value="array"/>
        <!-- ... -->
    </php>
</phpunit>

添加自定义 Pennant 驱动

实现驱动

如果 Pennant 现有的存储驱动都不适合你应用的需求，你可以编写自己的存储驱动。你的自定义驱动应实现 Laravel\Pennant\Contracts\Driver 接口：

php

<?php

namespace App\Extensions;

use Laravel\Pennant\Contracts\Driver;

class RedisFeatureDriver implements Driver
{
    public function define(string $feature, callable $resolver): void {}
    public function defined(): array {}
    public function getAll(array $features): array {}
    public function get(string $feature, mixed $scope): mixed {}
    public function set(string $feature, mixed $scope, mixed $value): void {}
    public function setForAllScopes(string $feature, mixed $value): void {}
    public function delete(string $feature, mixed $scope): void {}
    public function purge(array|null $features): void {}
}

现在，我们只需要使用 Redis 连接实现每个方法。有关如何实现每个方法的示例，请查看 Pennant 源代码中的 Laravel\Pennant\Drivers\DatabaseDriver

NOTE

Laravel 不附带包含你扩展的目录。你可以自由地将它们放在任何你喜欢的地方。在此示例中，我们创建了一个 Extensions 目录来存放 RedisFeatureDriver。

注册驱动

一旦你的驱动被实现，你就可以将其注册到 Laravel。要向 Pennant 添加额外的驱动，你可以使用 Feature facade 提供的 extend 方法。你应该从应用的某个服务提供者的 boot 方法中调用 extend 方法：

php

<?php

namespace App\Providers;

use App\Extensions\RedisFeatureDriver;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\ServiceProvider;
use Laravel\Pennant\Feature;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        // ...
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Feature::extend('redis', function (Application $app) {
            return new RedisFeatureDriver($app->make('redis'), $app->make('events'), []);
        });
    }
}

驱动注册后，你可以在应用的 config/pennant.php 配置文件中使用 redis 驱动：

php

'stores' => [

    'redis' => [
        'driver' => 'redis',
        'connection' => null,
    ],

    // ...

],

外部定义功能

如果你的驱动是第三方功能标志平台的包装器，你可能会在该平台上而不是使用 Pennant 的 Feature::define 方法定义功能。如果是这种情况，你的自定义驱动还应实现 Laravel\Pennant\Contracts\DefinesFeaturesExternally 接口：

php

<?php

namespace App\Extensions;

use Laravel\Pennant\Contracts\Driver;
use Laravel\Pennant\Contracts\DefinesFeaturesExternally;

class FeatureFlagServiceDriver implements Driver, DefinesFeaturesExternally
{
    /**
     * Get the features defined for the given scope.
     */
    public function definedFeaturesForScope(mixed $scope): array {}

    /* ... */
}

definedFeaturesForScope 方法应返回为提供的作用域定义的功能名称列表。

事件

Pennant 会分发各种事件，这些事件在整个应用中跟踪功能标志时可能很有用。

`Laravel\Pennant\Events\FeatureRetrieved`

每当检查功能时都会分发此事件。此事件可能对创建和跟踪整个应用中功能标志使用情况的指标很有用。

`Laravel\Pennant\Events\FeatureResolved`

此事件在首次为特定作用域解析功能值时分发。

`Laravel\Pennant\Events\UnknownFeatureResolved`

此事件在首次为特定作用域解析未知功能时分发。如果你打算移除功能标志但意外地在整个应用中留下了零散的引用，监听此事件可能很有用：

php

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Laravel\Pennant\Events\UnknownFeatureResolved;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Event::listen(function (UnknownFeatureResolved $event) {
            Log::error("Resolving unknown feature [{$event->feature}].");
        });
    }
}

`Laravel\Pennant\Events\DynamicallyRegisteringFeatureClass`

此事件在请求期间首次动态检查基于类的功能时分发。

`Laravel\Pennant\Events\UnexpectedNullScopeEncountered`

此事件在将 null 作用域传递给不支持 null 的功能定义时分发。

这种情况会被优雅地处理，功能将返回 false。然而，如果你想选择退出此功能的默认优雅行为，可以在应用的 AppServiceProvider 的 boot 方法中为此事件注册监听器：

php

use Illuminate\Support\Facades\Log;
use Laravel\Pennant\Events\UnexpectedNullScopeEncountered;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Event::listen(UnexpectedNullScopeEncountered::class, fn () => abort(500));
}

`Laravel\Pennant\Events\FeatureUpdated`

此事件在更新作用域的功能时分发，通常通过调用 activate 或 deactivate。

`Laravel\Pennant\Events\FeatureUpdatedForAllScopes`

此事件在为所有作用域更新功能时分发，通常通过调用 activateForEveryone 或 deactivateForEveryone。

`Laravel\Pennant\Events\FeatureDeleted`

此事件在删除作用域的功能时分发，通常通过调用 forget。

`Laravel\Pennant\Events\FeaturesPurged`

此事件在清除特定功能时分发。

`Laravel\Pennant\Events\AllFeaturesPurged`

此事件在清除所有功能时分发。

Laravel Pennant ​

简介 ​

安装 ​

配置 ​

定义功能 ​

基于类的功能 ​

自定义存储的功能名称 ​

检查功能 ​

检查基于类的功能 ​

条件执行 ​

HasFeatures Trait ​

Blade 指令 ​

Middleware ​

自定义响应 ​

拦截功能检查 ​

内存缓存 ​

作用域 ​

指定作用域 ​

默认作用域 ​

可空作用域 ​

识别作用域 ​

序列化作用域 ​

丰富的功能值 ​

检索多个功能 ​

预加载 ​

更新值 ​

批量更新 ​

清除功能 ​

测试 ​

存储配置 ​

添加自定义 Pennant 驱动 ​

实现驱动 ​

注册驱动 ​

外部定义功能 ​

事件 ​

Laravel\Pennant\Events\FeatureRetrieved ​

Laravel\Pennant\Events\FeatureResolved ​

Laravel\Pennant\Events\UnknownFeatureResolved ​

Laravel\Pennant\Events\DynamicallyRegisteringFeatureClass ​

Laravel\Pennant\Events\UnexpectedNullScopeEncountered ​

Laravel\Pennant\Events\FeatureUpdated ​

Laravel\Pennant\Events\FeatureUpdatedForAllScopes ​

Laravel\Pennant\Events\FeatureDeleted ​

Laravel\Pennant\Events\FeaturesPurged ​

Laravel\Pennant\Events\AllFeaturesPurged ​

Laravel Pennant

简介

安装

配置

定义功能

基于类的功能

自定义存储的功能名称

检查功能

检查基于类的功能

条件执行

`HasFeatures` Trait

Blade 指令

Middleware

自定义响应

拦截功能检查

内存缓存

作用域

指定作用域

默认作用域

可空作用域

识别作用域

序列化作用域

丰富的功能值

检索多个功能

预加载

更新值

批量更新

清除功能

测试

存储配置

添加自定义 Pennant 驱动

实现驱动

注册驱动

外部定义功能

事件

`Laravel\Pennant\Events\FeatureRetrieved`

`Laravel\Pennant\Events\FeatureResolved`

`Laravel\Pennant\Events\UnknownFeatureResolved`

`Laravel\Pennant\Events\DynamicallyRegisteringFeatureClass`

`Laravel\Pennant\Events\UnexpectedNullScopeEncountered`

`Laravel\Pennant\Events\FeatureUpdated`

`Laravel\Pennant\Events\FeatureUpdatedForAllScopes`

`Laravel\Pennant\Events\FeatureDeleted`

`Laravel\Pennant\Events\FeaturesPurged`

`Laravel\Pennant\Events\AllFeaturesPurged`