概述
在迭代了N個(gè)版本后,終于在目前最新的版本中實(shí)現(xiàn)了和Java枚舉定義使用都非常相似的PHP枚舉庫(kù)php-enum
這里有必要提一下為什么非要實(shí)現(xiàn)Java枚舉功能。我是在Java中認(rèn)識(shí)枚舉的,在此之前,我使用PHP很長(zhǎng)時(shí)間也沒(méi)有聽(tīng)說(shuō)的過(guò)枚舉,但在Java的項(xiàng)目中,枚舉隨處可見(jiàn),尤其是在API返回統(tǒng)一狀態(tài)碼的場(chǎng)景中,它已經(jīng)快成為了規(guī)范,所以我并沒(méi)有辦法忽略它,于是也學(xué)著使用它,等我再使用PHP的時(shí)候發(fā)現(xiàn)已經(jīng)不太習(xí)慣沒(méi)有枚舉,于是感覺(jué)去搜索PHP的枚舉
眾所周知,在PHP中要使用枚舉有兩個(gè)選擇,一個(gè)是官方在SPL中提供的枚舉庫(kù),看到這里,是不是特別開(kāi)心。別急,閱讀文檔后你會(huì)發(fā)現(xiàn),你不僅要以拓展的方式安裝它,它提供的方法也非常有限。所以通常我們會(huì)選擇第二種方式,也就是使用第三方的枚舉庫(kù)。而通過(guò)閱讀第三方的枚舉的源碼你也會(huì)發(fā)現(xiàn),它們或多或少都有Java枚舉的影子。但如果它們實(shí)現(xiàn)了Java枚舉的功能也就不會(huì)有今天的庫(kù)和文章了。
我查了很多枚舉,發(fā)現(xiàn)它們都缺少Java枚舉中的核心功能,也就是自定義屬性值(在Java枚舉中,枚舉并不是簡(jiǎn)單的定義常量名稱(chēng)和常量值,你可以定義屬性來(lái)承載枚舉中的元素)同時(shí)也發(fā)現(xiàn)在php中實(shí)現(xiàn)這個(gè)功能并不容易,于是我在項(xiàng)目中寫(xiě)了個(gè)抽象類(lèi)來(lái)實(shí)現(xiàn)固定兩個(gè)屬性的功能,因?yàn)橐诙鄠€(gè)項(xiàng)目中使用,就將它放到了github上,經(jīng)過(guò)多次重構(gòu),一次次推翻自己的想法,最終終于接近了Java枚舉的實(shí)現(xiàn)
安裝
composer require phpenum/phpenum
快速開(kāi)始
PHPEnum用起來(lái)和Java枚舉很像,比如定義一個(gè)表示性別的枚舉
在Java中:
public enum GenderEnum {
MALE(1, "male"),
FEMALE(2, "female");
private Integer id;
private String name;
GenderEnum(Integer id, String name) {
this.id = id;
this.name = name;
}
public Integer getId() {
return id;
}
public String getName() {
return name;
}
}
使用PhpEnum:
class GenderEnum extends \PhpEnum\Enum
{
const MALE = [1, 'male'];
const FEMALE = [2, 'female'];
private $id;
private $name;
protected function construct($id, $name)
{
$this->id = $id;
$this->name->$name;
}
public function getId()
{
return $this->id;
}
public function getName()
{
return $this->name;
}
}
你會(huì)發(fā)現(xiàn)它們的用法也非常相似
在Java中:
GenderEnum.values(); // enum instance array
GenderEnum.valueOf("FEMALE"); // enum instance
GenderEnum.MALE.equals(GenderEnum.valueOf("MALE")); // true
GenderEnum.MALE.name(); // MALE
GenderEnum.MALE.ordinal(); // 0
GenderEnum.MALE.toString(); // MALE
GenderEnum.MALE.getId(); // 1
GenderEnum.MALE.getName(); // male
使用PhpEnum:
GenderEnum::values(); // enum instance array
GenderEnum::valueOf('FEMALE'); // enum instance
GenderEnum::MALE()->equals(GenderEnum::valueOf('MALE')); // true
GenderEnum::MALE()->name(); // MALE
GenderEnum::MALE()->ordinal(); // 0
(string)GenderEnum::MALE(); // MALE
GenderEnum::MALE()->getId(); // 1
GenderEnum::MALE()->getName(); // male
不僅如此,PhpEnum還在子類(lèi)中提供了高級(jí)功能
GenderEnum::MALE()->idEquals(1); // true
GenderEnum::MALE()->NameEquals('male'); // true
GenderEnum::containsId(1); // 1
GenderEnum::containsName('male'); // 1
GenderEnum::ofId(1); // enum instance
GenderEnum::ofName('male'); // enum instance