總覽
本文將會對scala中的枚舉類型實現(xiàn)進行深入的探討,并且和其他語言中的枚舉做簡單的比較毙死。
什么是枚舉
現(xiàn)實中的事物往往只有 有限 個個體組成,枚舉就是為了表示本事物的個體的有限個枚舉項喻鳄。參照《百科》對枚舉的介紹:
在數(shù)學(xué)和計算機科學(xué)理論中扼倘,一個集的枚舉是列出某些有窮序列集的所有成員的程序,或者是一種特定類型對象的計數(shù)
比如表示一個問題的對錯除呵、真假等的bool類型再菊,就是一個枚舉。
enum Bool {
TRUE, FALSE
}
再比如人的眼睛只能看到3種顏色:紅竿奏、綠袄简、藍(lán)。顏色就是一個枚舉泛啸。其他顏色都是這三種顏色的不同比例的混合绿语。
enum Color {
RED, GREEN, BLUE
}
比如一周7天的名稱就是一個枚舉
enum WeekDay {
Mon, Tue, Wed, Thu, Fri, Sat, Sun
}
編程語言中的枚舉項一般來說都有一個編號(一般是自動編號)和一個名稱(可選)。編號一般用于比較候址,名稱一般用于引用這個枚舉項吕粹。
枚舉項有如下一些隱含的特性
1 枚舉項被定義之后是不能被修改的,也就是一些語言中的常量岗仑。
2 枚舉項是各不相同的匹耕。
其他語言中的枚舉
在一些語言中引入了enum語法, 可以直接定義枚舉。一些語言中沒有enum語法(1.5之前的java荠雕,python, scala等)稳其,為了表示枚舉,使用了一些特殊的方法炸卑。
比如java在引入enum關(guān)鍵字之前既鞠,可以使用私有構(gòu)造函數(shù)+靜態(tài)字段方式來模擬enum
public class Color {
public static final Color RED = new Color(1);
public static final Color GREEN = new Color(2);
public static final Color BLUE = new Color(3);
private int id;
private Color(int id) {
this.id = id;
}
// override equals & hashCode
}
而1.5版本之后java中的enum也只是語法糖而已,最終編譯后的enum也和上面的的代碼沒有什么區(qū)別盖文,只是添加了一些輔助方法嘱蛋。
對于一些有enum語法支持的語言,直接定義就可以五续。
比如上一節(jié)舉例的枚舉都是c語言風(fēng)格的枚舉洒敏。為了實現(xiàn)枚舉項的2個特性,基本所有語言中的枚舉項都是給每個枚舉一個固定而不同的編號疙驾,那么所有的枚舉就不會相等了凶伙。
Scala中的枚舉
scala中也沒有enum關(guān)鍵字和語法支持,雖然scala有非常復(fù)雜的類型系統(tǒng)它碎。scala中的枚舉是使用了標(biāo)準(zhǔn)庫中的scala.Enumeration來實現(xiàn)的镊靴。一般的铣卡,聲明一個枚舉的方法如下
object Color extends Enumeration {
type Color = Value
val RED, GREEN, BLUE = Value
}
代碼的解釋
- 第一行是聲明一個枚舉名稱為Color。
- 第二行是聲明了一個類型別名偏竟。和這個枚舉名字相同,其實并不是必須的敞峭,也可以定義成其他名稱踊谋。但是為了代碼的可讀性,一般來說定義成相同的旋讹。
- 第三行聲明了這個枚舉的各枚舉項
- 第四行結(jié)束
object Color
中的Color
只是一個普通的對象(Enumeration的一個實現(xiàn))殖蚕,和其他的對象沒有什么太大的區(qū)別。它內(nèi)部定義了一個type Color
別名和3個常量RED
, GREEN
, BLUE
沉迹。
為了了解為什么這么聲明睦疫,我們深入到Enumeration的內(nèi)部去看一下。
Enumeration內(nèi)部
Enumeration是scala標(biāo)準(zhǔn)庫中的類鞭呕,是一個抽象(abstract)類蛤育,代碼很長,把重要部分抽取出來之后的代碼如下(為了簡化做了稍許修改):
abstract class Enumeration {
thisenum =>
private val vmap: mutable.Map[Int, Value] = new mutable.HashMap
protected var nextId: Int = 0
protected final def Value: Value = Value(nextId)
protected final def Value(i: Int): Value = new Val(i)
abstract class Value extends Ordered[Value] with Serializable {
def id: Int
private[Enumeration] val outerEnum = thisenum
override def equals(other: Any): Boolean = other match {
case that: Enumeration#Value => (outerEnum eq that.outerEnum) && (id == that.id)
case _ => false
}
}
protected class Val(i: Int) extends Value with Serializable {
assert(!vmap.isDefinedAt(i), "Duplicate id: " + i)
vmap(i) = this
nextId = i + 1
def id: Int = i
}
}
注意其中和Value相關(guān)的方法def Value
和類 abstract class Value
葫松。
我們定義的枚舉中的type別名中的Value就是類瓦糕,而枚舉項中的Value就是方法。
枚舉項定義val RED, GREEN, BLUE = Value
要看懂這句腋么,先要明白scala中的一個簡單語法咕娄,一句話給多個變量賦值,看如下代碼
val a, b, c = 1
那么相當(dāng)于給常量 a
, b
, c
都賦值為1
具體到這里的定義珊擂,相當(dāng)于RED
, GREEN
, BLUE
都賦值給了Value
圣勒。而這里的Value就是方法def Value: Value
。只是他的方法名和返回值都叫Value而已摧扇。 而方法Value具體的功能圣贸,就是返回一個新的Value的實例,并且id每次都自動加1.
那么也就是RED扳剿,GREEN旁趟,BLUE都是Value類型,并且id一次加1.
RED.id == 0
GREEN.id == 1
BLUE.id == 2
別名定義type Color = Value
枚舉項已經(jīng)生成了庇绽,那么怎么使用呢锡搜。首先是聲明的地方,需要定義個變量(或常量)瞧掺,他的類型是Color耕餐,值是枚舉值。那么這里的變量別名就派上了用場辟狈。
枚舉項都是Value類型肠缔,但是怎么區(qū)分不同的枚舉中的枚舉項呢夏跷?就靠這里的別名。因為定義中的object Color
是一個對象實例明未,不能用作類型槽华。要是使用Color.Value作為類型,也感覺怪怪的趟妥,所以別名定義就是為了方便在使用枚舉時的聲明猫态。舉個例子:
import Color._
def paint(text: String, color: Color)
枚舉的比較
枚舉大部分情況下用來比較。對于不同的枚舉披摄,肯定不會相同亲雪,即便他們的id和名稱都是相同的也不會【尾玻可以看一下Enumeration中的thisenum
這個self type
义辕。 thisenum相當(dāng)于是this,但是在Value類中使用到寓盗。為了區(qū)分Value中的this和Enumeration中的this灌砖,定義了this的別名也即
thisenum == Enumeration.this
那么對于不同的枚舉,他們的thisenum是不同的贞让,所以在Value的equals方法中周崭,就先判斷了(outerEnum eq that.outerEnum)
。對于同一個枚舉喳张,這兩個是一樣的续镇,對于不同的枚舉,這兩個肯定是不相同的(為什么不使用==销部,參考scala中的==和eq的用法)摸航。
先判斷了thisenum是否相同,然后再判斷id(id == that.id)
就完成了比較舅桩。
擴展:定義自己的枚舉
看到這里酱虎,我們明白了,其實scala中的枚舉只是一個普通的object擂涛。那么我們是否可以不使用Enumeration來自己定義個枚舉呢读串?答案是可以的,而且非常簡單撒妈。
首先定義枚舉的父類恢暖,當(dāng)然也是abstract的:
abstract class enum(initial: Int = 0) {
en =>
protected class Item(val id: Int) {
override def toString: String = st.toString + "(" + id + ")"
private[enum] val st = en
override def equals(obj: Any): Boolean = obj match {
case that: Item => (st eq that.eq) && (id == that.id)
case _ => false
}
override def hashCode(): Int = id.##
}
private val nmap = new collection.mutable.HashMap[Int, Item]
var nextId: Int = initial
def Item: Item = createItem(nextId)
def createItem(i: Int): Item = {
val item = new Item(i)
nextId += 1
nmap(i) = item
item
}
def withId(id: Int): Item = nmap(id)
}
定義時仿照Enumeration即可
object Color extends enum {
type Color = Item
val RED, GREEN, BLUE = Item
}
總結(jié)
本文對scala和其他語言中的枚舉進行了一些簡單的介紹,深入scala的Enumeration內(nèi)部狰右,研究了它的實現(xiàn)機制杰捂。之后,參照scala的機制棋蚌,自己實現(xiàn)了簡單的枚舉嫁佳。