Laravel Pennant

简介
安装
配置
定义功能
- 基于类的功能
检查功能
作用域
富功能值
检索多个功能
急加载
更新值
- 批量更新
- 清除功能
测试
添加自定义 Pennant 驱动程序
事件

简介

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

安装

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

composer require laravel/pennant

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

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

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

php artisan migrate

配置

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

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

定义功能

要定义一个功能，您可以使用 Feature 外观提供的 define 方法。您需要为功能提供一个名称，以及一个将用于解析功能初始值的闭包。

通常，功能是在服务提供程序中使用 Feature 外观定义的。闭包将接收功能检查的“作用域”。最常见的是，作用域是当前经过身份验证的用户。在此示例中，我们将为逐步向应用程序用户推出新的 API 定义一个功能

<?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 功能时，闭包的结果将由存储驱动程序存储。下次针对同一用户检查该功能时，该值将从存储中检索，并且不会调用闭包。

为方便起见，如果功能定义仅返回彩票，则可以完全省略闭包

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

基于类的功能

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

php artisan pennant:feature NewApi

在编写功能类时，您只需要定义一个 resolve 方法，该方法将用于解析给定作用域的功能的初始值。同样，作用域通常是当前经过身份验证的用户

<?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 外观上调用 instance 方法

use Illuminate\Support\Facades\Feature;
 
$instance = Feature::instance(NewApi::class);

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

自定义存储的功能名称

默认情况下，Pennant 将存储功能类的完全限定类名。如果您想将存储的功能名称与应用程序的内部结构分离，您可以在功能类上指定 $name 属性。此属性的值将存储在类名的地方

<?php
 
namespace App\Features;
 
class NewApi
{
    /**
     * The stored name of the feature.
     *
     * @var string
     */
    public $name = 'new-api';
 
    // ...
}

检查功能

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

<?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 外观提供的 for 方法

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

Pennant 还提供了一些额外方便的方法，这些方法在确定功能是否处于活动状态时可能会很有用

// Determine if all of the given features are active...
Feature::allAreActive(['new-api', 'site-redesign']);
 
// Determine if any of the given features are active...
Feature::someAreActive(['new-api', 'site-redesign']);
 
// Determine if a feature is inactive...
Feature::inactive('new-api');
 
// Determine if all of the given features are inactive...
Feature::allAreInactive(['new-api', 'site-redesign']);
 
// Determine if any of the given features are inactive...
Feature::someAreInactive(['new-api', 'site-redesign']);

在 HTTP 上下文之外使用 Pennant 时，例如在 Artisan 命令或排队作业中，您通常应该显式指定功能的作用域。或者，您可以定义一个默认作用域，该作用域同时考虑经过身份验证的 HTTP 上下文和未经身份验证的上下文。

检查基于类的功能

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

<?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
 
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 方法的逆方法，如果功能处于非活动状态，则执行第一个闭包

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

`HasFeatures` Trait

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

<?php
 
namespace App\Models;
 
use Illuminate\Foundation\Auth\User as Authenticatable;
use Laravel\Pennant\Concerns\HasFeatures;
 
class User extends Authenticatable
{
    use HasFeatures;
 
    // ...
}

将 trait 添加到模型后，您可以通过调用 features 方法轻松检查功能

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

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

// 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']);
 
// Conditional execution...
$user->features()->when('new-api',
    fn () => /* ... */,
    fn () => /* ... */,
);
 
$user->features()->unless('new-api',
    fn () => /* ... */,
    fn () => /* ... */,
);

Blade 指令

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

@feature('site-redesign')
    <!-- 'site-redesign' is active -->
@else
    <!-- 'site-redesign' is inactive -->
@endfeature
 
@featureany(['site-redesign', 'beta'])
    <!-- 'site-redesign' or `beta` is active -->
@endfeatureany

中间件

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

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 方法中调用

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 中存在错误，您可以轻松地禁用除内部团队成员之外的所有人的新 API，修复错误，然后为之前有权访问该功能的用户重新启用新 API。

您可以使用基于类的功能的 before 方法来实现这一点。如果存在 before 方法，它总是在从存储中检索值之前在内存中运行。如果该方法返回一个非 null 值，它将在请求期间替代该功能的存储值。

<?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
 
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 方法。

Feature::flushCache();

作用域

指定作用域

如前所述，功能通常是针对当前经过身份验证的用户进行检查的。但是，这可能并不总是满足您的需求。因此，可以通过 Feature facade 的 for 方法指定要检查给定功能的作用域。

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

当然，功能的作用域不限于“用户”。假设您构建了一个新的计费体验，您正在向整个团队而不是个人用户推出。也许您希望较旧的团队比新团队的推出速度慢一些。您的功能解析闭包可能如下所示：

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 方法。

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

默认作用域

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

<?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 方法显式提供作用域，则功能检查现在将使用当前经过身份验证的用户的团队作为默认作用域。

Feature::active('billing-v2');
 
// Is now equivalent to...
 
Feature::for($user->team)->active('billing-v2');

可为空的作用域

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

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

如果您并非总是显式指定您的功能作用域，那么您应该确保该作用域的类型是“可为空的”，并在功能定义逻辑中处理 null 作用域值。

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
 
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 变形映射，您也可以选择让 Pennant 使用变形映射将存储的功能与您的应用程序结构解耦。

为了实现这一点，在服务提供程序中定义 Eloquent 变形映射后，您可以调用 Feature facade 的 useMorphMap 方法。

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。

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 功能的值。

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

Pennant 包含的 Blade 指令也可以轻松地根据功能的当前值有条件地呈现内容。

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

使用丰富的值时，重要的是要知道当功能具有除 false 之外的任何值时，该功能被认为是“活动的”。

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

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

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

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

检索多个功能

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

Feature::values(['billing-v2', 'purchase-button']);
 
// [
//     'billing-v2' => false,
//     'purchase-button' => 'blue-sapphire',
// ]

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

Feature::all();
 
// [
//     'billing-v2' => false,
//     'purchase-button' => 'blue-sapphire',
//     'site-redesign' => true,
// ]

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

如果您想确保在使用 all 方法时始终包含功能类，则可以使用 Pennant 的功能发现功能。首先，在您的应用程序的服务提供程序之一中调用 discover 方法。

<?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 方法将在其结果中包含这些类，无论它们是否在当前请求期间被检查。

Feature::all();
 
// [
//     'App\Features\NewApi' => true,
//     'billing-v2' => false,
//     'purchase-button' => 'blue-sapphire',
//     'site-redesign' => true,
// ]

急加载

尽管 Pennant 为单个请求保留所有已解析功能的内存缓存，但仍然可能会遇到性能问题。为了缓解这种情况，Pennant 提供了急切加载功能值的功能。

为了说明这一点，假设我们正在循环中检查某个功能是否处于活动状态。

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

假设我们正在使用数据库驱动程序，此代码将为循环中的每个用户执行一个数据库查询 - 可能会执行数百个查询。但是，使用 Pennant 的 load 方法，我们可以通过急切加载用户或作用域集合的功能值来消除这种潜在的性能瓶颈。

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

要在尚未加载功能值时才加载它们，可以使用 loadMissing 方法。

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

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

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

更新值

当首次解析某个功能的值时，底层驱动程序会将结果存储在存储中。这通常是必要的，以确保用户在跨请求时获得一致的体验。但是，有时您可能需要手动更新该功能的存储值。

要实现这一点，您可以使用 activate 和 deactivate 方法来切换功能的“开”或“关”。

use Laravel\Pennant\Feature;
 
// Activate the feature for the default scope...
Feature::activate('new-api');
 
// Deactivate the feature for the given scope...
Feature::for($user->team)->deactivate('billing-v2');

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

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

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

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

批量更新

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

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

use Laravel\Pennant\Feature;
 
Feature::activateForEveryone('new-api');
 
Feature::activateForEveryone('purchase-button', 'seafoam-green');

或者，您可以为所有用户停用该功能。

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

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

清除功能

有时，从存储中清除整个功能会很有用。如果您已从应用程序中删除该功能，或者您对功能定义进行了调整，并且希望将其推出给所有用户，则通常需要这样做。

您可以使用 purge 方法删除该功能的所有存储值。

// Purging a single feature...
Feature::purge('new-api');
 
// Purging multiple features...
Feature::purge(['new-api', 'purchase-button']);

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

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

测试

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

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

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

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');
});

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'));
}

同样的方法可以用于基于类的功能。

use Laravel\Pennant\Feature;
 
test('it can control feature values', function () {
    Feature::define(NewApi::class, true);
 
    expect(Feature::value(NewApi::class))->toBeTrue();
});

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 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
 
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。

Laravel 没有自带用于存放扩展的目录。您可以将它们放在您喜欢的任何地方。在本例中，我们创建了一个 Extensions 目录来存放 RedisFeatureDriver。

注册驱动程序

一旦您的驱动程序实现完成，您就可以将其注册到 Laravel。要向 Pennant 添加其他驱动程序，您可以使用 Feature 外观提供的 extend 方法。您应该从应用程序的其中一个服务提供器的 boot 方法中调用 extend 方法。

<?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 驱动程序。

'stores' => [
 
    'redis' => [
        'driver' => 'redis',
        'connection' => null,
    ],
 
    // ...
 
],

外部定义功能

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

<?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
 
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 方法中注册此事件的侦听器。

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`

当清除所有功能时，会分派此事件。