如何简化PHP8.1Enum的比较与转换，oskarstark/enum-helper助你写出更优雅的代码

自从 PHP 8.1 引入了强大的 Enum（枚举）特性，我们的代码变得更加清晰、类型更加安全。定义一组固定的状态或类型，Enum 简直是神器。然而，在享受 Enum 带来的便利时，我最近在项目中也遇到了一些“小麻烦”。

比如，我有一个 OrderStatus 的 Enum，需要频繁地判断当前订单状态是否处于“待处理”、“已支付”或“已发货”中的任意一种。原生的写法往往是这样：

<pre class="brush:php;toolbar:false;">if ($orderStatus === OrderStatus::PENDING || $orderStatus === OrderStatus::PAID || $orderStatus === OrderStatus::SHIPPED) {
    // ... 执行某些操作
}

当需要判断的条件增多时，这个 if 语句就会变得异常冗长，不仅可读性差，还容易因为手误而引入 bug。

另一个常见的场景是，我需要将 Enum 的所有选项渲染到前端的下拉菜单或单选按钮组中。这意味着我需要将 Enum 的 name 和 value 提取出来，形成一个关联数组。手动编写 array_column(OrderStatus::cases(), 'value', 'name') 固然可以，但每次都写一遍，总觉得不够优雅，而且对于非 Backed Enum 还需要额外的处理。

立即学习“PHP免费学习笔记（深入）”；

这些看似简单却重复的“小麻烦”，让我一直在寻找一种更简洁、更具表现力的解决方案。幸运的是，我发现了 oskarstark/enum-helper 这个 Composer 包，它彻底改变了我处理 Enum 的方式！

救星驾到：oskarstark/enum-helper 简介

oskarstark/enum-helper 是一个轻量级的 PHP 库，专门为 PHP 8.1+ 的 Enum 提供了一系列实用的辅助功能。它通过引入两个 trait——Comparable 和 ToArray，极大地简化了 Enum 的比较操作和数组转换操作，让我们的代码变得更加 DRY（Don't Repeat Yourself）。

安装它非常简单，只需通过 Composer 即可：

<code class="bash">composer require oskarstark/enum-helper</code>

安装完成后，我们就可以在自己的 Enum 中引入这些 trait 了。

实战演练：让 Enum 变得更智能

假设我们有一个 Color 的 Enum：

<pre class="brush:php;toolbar:false;"><?php

declare(strict_types=1);

namespace App\Enum;

enum Color: string
{
    case RED = 'red';
    case BLUE = 'blue';
    case GREEN = 'green';
}

现在，我们为其添加 Comparable 和 ToArray trait：

<pre class="brush:php;toolbar:false;"><?php

declare(strict_types=1);

namespace App\Enum;

use OskarStark\Enum\Trait\Comparable;
use OskarStark\Enum\Trait\ToArray;

enum Color: string
{
    use Comparable; // 引入比较功能
    use ToArray;    // 引入转换为数组功能

    case RED = 'red';
    case BLUE = 'blue';
    case GREEN = 'green';
}

让 Enum 可以“比较”：Comparable Trait

Comparable trait 赋予了 Enum 实例强大的比较能力。

告别冗长的 if...else if... 链条！

Programming Helper

AI代码自动生成器，在AI的帮助下更快地编程

26

查看详情

现在，我们可以这样比较 Enum：

<pre class="brush:php;toolbar:false;">// 检查是否等于另一个 Enum 实例
Color::RED->equals(Color::BLUE); // 返回 false
Color::RED->equals(Color::RED);  // 返回 true

// 检查是否不等于另一个 Enum 实例
Color::RED->notEquals(Color::RED); // 返回 false

// 最实用的功能：检查是否等于多个 Enum 实例中的任意一个
Color::RED->equalsOneOf([
    Color::BLUE,
    Color::RED,
]); // 返回 true

这个 equalsOneOf() 方法简直是解决多条件判断的利器！我们可以结合它来定义更具业务含义的方法：

<pre class="brush:php;toolbar:false;"><?php

declare(strict_types=1);

namespace App\Enum;

use OskarStark\Enum\Trait\Comparable;
use OskarStark\Enum\Trait\ToArray;

enum Color: string
{
    use Comparable;
    use ToArray;

    case RED = 'red';
    case BLUE = 'blue';
    case GREEN = 'green';
    case YELLOW = 'yellow';

    public function isPrimaryColor(): bool
    {
        return $this->equalsOneOf([
            self::RED,
            self::BLUE,
            self::YELLOW,
        ]);
    }
}

// 现在判断颜色是否是原色变得如此简洁
Color::RED->isPrimaryColor();   // 返回 true
Color::GREEN->isPrimaryColor(); // 返回 false

通过这种方式，我们的业务逻辑更加清晰，代码也更加易读和维护。

让 Enum 轻松“变身”数组：ToArray Trait

ToArray trait 提供了一个静态方法 toArray()，能够将 Enum 的所有 Case 转换为一个关联数组，这对于构建前端表单选项或 API 响应非常有用。

前端需要下拉菜单？一个方法搞定！

• 对于 Backed Enum (有值的 Enum)：

  <pre class="brush:php;toolbar:false;">Color::toArray();
  // 返回：
  // [
  //     'RED' => 'red',
  //     'BLUE' => 'blue',
  //     'GREEN' => 'green',
  //     'YELLOW' => 'yellow',
  // ]

  登录后复制

  这样，你可以直接将这个数组传递给前端模板，轻松生成下拉菜单选项，其中键是 Enum 的名称，值是 Enum 的实际值。

• 对于 Non-Backed Enum (无值的 Enum)：

  如果你的 Enum 没有关联值（例如 enum Status { case ACTIVE; case INACTIVE; }），toArray() 也会智能地将其转换为：

  <pre class="brush:php;toolbar:false;">// 假设有一个 NonBackedEnum
  // NonBackedEnum::toArray();
  // 返回：
  // [
  //     'ACTIVE' => 'ACTIVE',
  //     'INACTIVE' => 'INACTIVE',
  // ]

  登录后复制

  这同样方便了在 UI 中展示 Enum 的名称。

总结与展望：代码更优雅，开发更高效

oskarstark/enum-helper 库虽然小巧，但它在解决 Enum 常见操作的痛点上表现出色。通过引入 Comparable 和 ToArray trait，它带来了以下显著优势：

• 代码简洁性：告别冗长的条件判断和重复的数组转换逻辑。
• 可读性提升：equalsOneOf() 和 toArray() 方法语义明确，让代码意图一目了然。
• 减少错误：封装好的辅助方法减少了手动实现可能带来的逻辑错误。
• 开发效率：将常见的 Enum 操作标准化，节省了开发者编写样板代码的时间。

在 PHP 8.1+ 的项目开发中，Enum 已经成为构建健壮应用不可或缺的一部分。结合 oskarstark/enum-helper 这样的辅助库，我们能够更优雅、更高效地利用 Enum 的强大功能。如果你也曾为 Enum 的比较和转换而烦恼，不妨试试这个库，它一定会让你的代码更上一层楼！

以上就是如何简化PHP8.1Enum的比较与转换，oskarstark/enum-helper助你写出更优雅的代码的详细内容，更多请关注php中文网其它相关文章！