PHP 枚舉類型的管理與設計

本文的實現主要是基於 myclabs/php-enum 擴展包。

今天來分享下如何管理 PHP 的枚舉類型。

一種常見的方式是，使用常量來代表枚舉類型

const YES = '是';
const NO = '否';

可以在這個基礎上更進一步，將其封裝成類，以便於管理

class BoolEnum {
    const YES = '是';
    const NO = '否';
}

現在，我們希望能通過方法來動態調用對應的枚舉類型

BoolEnum::YES(); // 是
BoolEnum::NO(); // 否

也可以批量獲取枚舉類型

BoolEnum::toArray(); // ['Yes' => '是', 'No' => '否']

下面來實現上面列舉的功能。

定義基本的枚舉基類，讓所有的枚舉類都繼承該抽象基類。

abstract class Enum
{   
    // 獲取所有枚舉類型
    public static function toArray(){

        // 通過反射獲取常量
        $reflection = new \ReflectionClass(static::class);
        $contants = $reflection->getConstants();

        // 返回對應的常量
        return $contants;
    }

    //  動態調用屬性
    public static function __callStatic($name, $arguments)
    {
        $arr = static::toArray();

        if(isset($arr[$name])){
            return $arr[$name];
        }

        throw new \BadMethodCallException("找不到對應的枚舉值 {$name}");
    }
}

class BoolEnum extends Enum
{
    const YES = '是';
    const NO = '否';
}

利用反射，可以獲取到所有的枚舉類型。同時，利用魔術方法則可以實現對屬性的動態調用。這裏要注意的是，反射會消耗較多的資源，因此，對 toArray 方法進行重構，增加一個緩存變量來緩存獲取到的枚舉類型，避免重複使用反射。

abstract class Enum
{   
    protected static $cache = [];

    public static function toArray(){

        $class = static::class;

        // 第一次獲取，就通過反射來獲取
        if(! isset(static::$cache[$class])){
            $reflection = new \ReflectionClass(static::class);
            static::$cache[$class] = $reflection->getConstants();
        }

        return static::$cache[$class];
    }
}

現在考慮更多的使用場景，比如用實例來代表特定枚舉類型

$yes = new BoolEnum("是");
echo $yes; // "是"

實現如下

abstract Enum
{
    protected $value;

    public function __construct($value)
    {   
        if ($value instanceof static) {
            $value = $value->getValue();
        }

        if(! $this->isValid($value)){
            throw new \UnexpectedValueException("$value 不屬於該枚舉值" . static::class);
        }

        $this->value = $value;
    }

    // 獲取實例對應的鍵
    public function getKey(){
        return array_search($this->value, static::toArray(), true);
    }

    // 獲取實例對應的值
    public function getValue()
    {
        return $this->value;
    }

    // 允許字符串形式輸出
    public function __toString()
    {
        return $this->value;
    }

    // 驗證值是否合法
    public function isValid($value)
    {
      $arr = static::toArray();

      return in_array($value, $arr, true);
    }

    // 驗證鍵是否合法
    public function isValidKey($key)
    {
      $arr = static::toArray();

      return array_key_exists($key, $arr);
    }
}

這樣做可避免用戶使用非法的枚舉類型的值

$user->banned = '非法值';  // 可能不會報錯
$yes = new BoolEnum("非法值"); // 將會拋出異常
$user->banned = $yes;

或者作爲參數類型限定

function setUserStatus(BoolEnum $boolEnum){
    $user->banned = $boolEnum;
}

PHP 作爲一門弱類型語言，參數限定的不足會導致很多不可預期的錯誤發生，通過使用枚舉類，我們進一步加強了參數限定的功能，同時，管理枚舉類型也更加的方便統一。

更多學習內容請訪問：

騰訊T3-T4標準精品PHP架構師教程目錄大全，只要你看完保證薪資上升一個臺階（持續更新）

以上內容希望幫助到大家，很多PHPer在進階的時候總會遇到一些問題和瓶頸，業務代碼寫多了沒有方向感，不知道該從那裏入手去提升，對此我整理了一些資料，包括但不限於：分佈式架構、高可擴展、高性能、高併發、服務器性能調優、TP6，laravel，YII2，Redis，Swoole、Swoft、Kafka、Mysql優化、shell腳本、Docker、微服務、Nginx等多個知識點高級進階乾貨需要的可以免費分享給大家，需要的可以加入我的官方羣點擊此處。