Laravel Pennant

介绍
安装
配置
定义特性
- 基于类的特性
检查特性
范围
丰富特性值
检索多个特性
预加载
更新值
- 批量更新
- 清除特性
测试
添加自定义 Pennant 驱动
事件

介绍

Laravel Pennant 是一个简单且轻量级的特性标志包 - 没有多余的内容。特性标志使您能够逐步推出新的应用程序功能，进行 A/B 测试新的界面设计，补充基于主干的开发策略等等。

安装

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

shell

composer require laravel/pennant

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

shell

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

最后，您应该运行应用程序的数据库迁移。这将创建一个 Pennant 用于其 database 驱动的 features 表：

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
{
    /**
     * 启动任何应用程序服务。
     */
    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 特性时，闭包的结果将由存储驱动程序存储。下次针对同一用户检查特性时，将从存储中检索该值，闭包将不会被调用。

为了方便起见，如果特性定义仅返回一个彩票，您可以完全省略闭包：

php

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
{
    /**
     * 解析特性的初始值。
     */
    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);

特性类通过容器解析，因此您可以在需要时将依赖项注入特性类的构造函数中。

自定义存储特性名称

默认情况下，Pennant 将存储特性类的完全限定类名。如果您希望将存储的特性名称与应用程序的内部结构解耦，您可以在特性类上指定一个 $name 属性。该属性的值将存储在类名的位置：

php

<?php

namespace App\Features;

class NewApi
{
    /**
     * 特性存储的名称。
     *
     * @var string
     */
    public $name = 'new-api';

    // ...
}

检查特性

要确定特性是否处于活动状态，您可以使用 Feature facade 上的 active 方法。默认情况下，特性是针对当前经过身份验证的用户检查的：

php

<?php

namespace App\Http\Controllers;

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

class PodcastController
{
    /**
     * 显示资源的列表。
     */
    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']);

在 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
{
    /**
     * 显示资源的列表。
     */
    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
{
    /**
     * 显示资源的列表。
     */
    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` 特性

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

php

<?php

namespace App\Models;

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

class User extends Authenticatable
{
    use HasFeatures;

    // ...
}

添加特性后，您可以轻松地通过调用 features 方法检查特性：

php

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

当然，features 方法提供了许多其他方便的方法来与特性进行交互：

php

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

// 状态...
$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

中间件

Pennant 还包括一个中间件，可用于在路由被调用之前验证当前经过身份验证的用户是否具有访问特性的权限。您可以将中间件分配给路由，并指定访问该路由所需的特性。如果当前经过身份验证的用户的任何指定特性处于非活动状态，则将返回 400 Bad Request HTTP 响应。

php

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

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

自定义响应

如果您希望自定义中间件在列出的特性处于非活动状态时返回的响应，您可以使用 EnsureFeaturesAreActive 中间件提供的 whenInactive 方法。通常，此方法应在您应用程序的某个服务提供者的 boot 方法中调用：

php

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

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    EnsureFeaturesAreActive::whenInactive(
        function (Request $request, array $features) {
            return new Response(status: 403);
        }
    );

    // ...
}

拦截特性检查

有时，在检索给定特性的存储值之前执行一些内存检查可能会很有用。想象一下，您正在开发一个通过特性标志的新 API，并希望在不丢失存储中的任何解析特性值的情况下禁用新 API。如果您在新 API 中发现了一个错误，您可以轻松地禁用它，除了内部团队成员之外，修复错误，然后重新启用新 API 供之前有权访问该特性的用户使用。

您可以通过基于类的特性的 before 方法实现这一点。当存在时，before 方法始终在内存中运行，然后再从存储中检索值。如果该方法返回非 null 值，则将在请求期间使用该值替代特性的存储值：

php

<?php

namespace App\Features;

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

class NewApi
{
    /**
     * 在检索存储值之前始终在内存中运行检查。
     */
    public function before(User $user): mixed
    {
        if (Config::get('features.new-api.disabled')) {
            return $user->isInternalTeamMember();
        }
    }

    /**
     * 解析特性的初始值。
     */
    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
{
    /**
     * 在检索存储值之前始终在内存中运行检查。
     */
    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 Carbon\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
{
    /**
     * 启动任何应用程序服务。
     */
    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，则 Pennant 将自动返回 false 作为特性的结果值。

因此，如果您传递给特性的范围可能为 null，并且希望调用特性的值解析器，则应在特性的定义中考虑这一点。由于在 Artisan 命令、队列作业或未经过身份验证的路由中检查特性时，通常没有经过身份验证的用户，因此默认范围将为 null。

如果您不总是显式指定特性范围，则应确保范围的类型是“可空的”，并在特性定义逻辑中处理 null 范围值：

php

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

Feature::define('new-api', fn (User $user) => match (true) {
Feature::define('new-api', fn (User|null $user) => match (true) {
    $user === null => true,
    $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
{
    /**
     * 将对象转换为给定驱动的特性范围标识符。
     */
    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 还允许您存储丰富的值。

例如，想象一下，您正在测试三种新颜色，用于您应用程序的“立即购买”按钮。您可以返回一个字符串，而不是返回 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

使用丰富值时，重要的是要知道，当特性具有任何值而不是 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
{
    /**
     * 启动任何应用程序服务。
     */
    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');

这只会更新由 Pennant 的存储驱动存储的解析特性值。您还需要在应用程序中更新特性定义。

清除特性

有时，清除存储中的整个特性可能会很有用。如果您已从应用程序中删除特性，或者您已对特性定义进行了调整，希望将其推广到所有用户，这通常是必要的。

您可以使用 purge 方法删除特性的所有存储值：

php

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

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

如果您希望清除所有特性，可以不带任何参数调用 purge 方法：

php

Feature::purge();

由于在应用程序的部署管道中清除特性可能很有用，Pennant 包括一个 pennant:purge Artisan 命令，该命令将从存储中清除提供的特性：

php artisan pennant:purge new-api

php artisan pennant:purge new-api purchase-button

还可以清除所有特性除了给定特性列表中的特性。例如，假设您希望清除所有特性，但保留存储中“new-api”和“purchase-button”特性的值。要实现这一点，您可以将这些特性名称传递给 --except 选项：

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

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

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 连接实现这些方法。有关如何实现每个方法的示例，请查看 Laravel\Pennant\Drivers\DatabaseDriver 的 Pennant 源代码

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
{
    /**
     * 注册任何应用程序服务。
     */
    public function register(): void
    {
        // ...
    }

    /**
     * 启动任何应用程序服务。
     */
    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
{
    /**
     * 获取为给定范围定义的特性。
     */
    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
{
    /**
     * 启动任何应用程序服务。
     */
    public function boot(): void
    {
        Event::listen(function (UnknownFeatureResolved $event) {
            Log::error("解析未知特性 [{$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;

/**
 * 启动任何应用程序服务。
 */
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 特性 ​

Blade 指令 ​

中间件 ​

自定义响应 ​

拦截特性检查 ​

内存缓存 ​

范围 ​

指定范围 ​

默认范围 ​

可空范围 ​

识别范围 ​

序列化范围 ​

丰富特性值 ​

检索多个特性 ​

预加载 ​

更新值 ​

批量更新 ​

清除特性 ​

测试 ​

存储配置 ​

添加自定义 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` 特性

Blade 指令

中间件

自定义响应

拦截特性检查

内存缓存

范围

指定范围

默认范围

可空范围

识别范围

序列化范围

丰富特性值

检索多个特性

预加载

更新值

批量更新

清除特性

测试

存储配置

添加自定义 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`