在测试中使用Laravel中的PHP后备枚举（枚举.测试中.Laravel.PHP...）

PHP 枚举概述

PHP 8.1 引入了枚举，提供了一种定义命名值集合的结构化方式。Laravel 与枚举无缝集成，允许在模型、验证规则和查询条件中使用它们。然而，在测试中，一些细微之处可能会导致意外的失败。

示例：订单项目状态枚举

这是一个订单项目状态的后备枚举示例：

namespace AppSupportEnumsOrder;

enum OrderItemStatusEnum: int
{
    case Accepted = 1;
    case Suspended = 2;
    case RefusalClient = 3;
    case SupplierRejection = 4;
    case PriceExceeded = 5;
    case InTransit = 6;
    case InStock = 7;
    case ReadyForShipment = 8;
    case Shipped = 9;
    case Damaged = 10;
    case SentToSupplier = 11;
    case InAssembly = 12;
    case Purchased = 13;
}

在 Laravel 应用中使用枚举

订单取消操作 使用枚举更新订单项状态：

final class OrderItemCancelAction implements Actionable
{
    public function handle(string $orderitemUuid, int $userId, int $managerId = null): OrderItem
    {
        $orderItem = OrderItem::query()->where('is_canceled', false)->findOrFail($orderitemUuid);

        DB::transaction(function () use ($orderItem) {
            $orderItem->update(['status_id' => OrderItemStatusEnum::RefusalClient->value]);
        });

        return $orderItem;
    }
}

使用后备枚举进行测试

这是一个验证状态更新的功能测试：

public function testAdminCancelOrderItem(): void
{
    $user = $this->getDefaultUser();
    $admin = $this->getAdmin();
    $this->actingAsAdmin($admin);

    $order = $this->createOrder($user);
    $orderItem = OrderItemFactory::new()->for($order)->for($user)->create();

    $data = ['user_id' => $user->id];

    $response = $this->put(route('api-admin:order.order-items.cancel', ['uuid' => $orderItem->uuid]), $data);

    $response->assertOk();

    $response->assertJson([
        'data' => [
            'item_status' => ['id' => OrderItemStatusEnum::RefusalClient->value],
        ]
    ]);
}

assertJson 的陷阱

如果我们在 assertJson 断言中省略 ->value：

$response->assertJson([
    'data' => [
        'item_status' => ['id' => OrderItemStatusEnum::RefusalClient],
    ]
]);

即使 Laravel 允许在许多地方直接使用枚举（例如：$order = Order::query()->whereIn('status_id', [OrderStatusEnum::Processing, OrderStatusEnum::Suspended])->findOrFail($orderitem->order_id);），测试将会失败。

失败信息具有误导性：

Unable to find JSON:
[
    {
        "data": {
            "item_status": {
                "id": 3
            }
        }
    }
]
within response JSON:
[
    {
        "data": {
            "item_status": {
                "id": 3
            }
        }
    }
].

这是因为 Laravel 的 assertJson 对枚举调用 json_encode，将其转换为字符串，导致不匹配。

结论

在 Laravel 中使用 PHP 枚举时，始终使用 ->value 以避免混淆。虽然 Laravel 允许在许多地方直接使用枚举，但 PHPUnit 测试需要显式转换。不要依赖 PHP 或 Laravel 的“魔法”——明确使用值！

以上就是在测试中使用Laravel中的PHP后备枚举的详细内容，更多请关注知识资源分享宝库其它相关文章！