PHP 列舉型別的管理與設計

心智極客發表於2020-02-12
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 作為一門弱型別語言，引數限定的不足會導致很多不可預期的錯誤發生，通過使用列舉類，我們進一步加強了引數限定的功能，同時，管理列舉型別也更加的方便統一。

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章