Go 語言里怎么正確實(shí)現(xiàn)枚舉?答案藏著官方的源碼里
本文轉(zhuǎn)載自微信公眾號「網(wǎng)管叨bi叨」,作者網(wǎng)管。轉(zhuǎn)載本文請聯(lián)系網(wǎng)管叨bi叨公眾號。
在編程領(lǐng)域里,枚舉是用來表示只包含有限數(shù)量的固定值的類型,在開發(fā)中一般用于標(biāo)識錯誤碼或者狀態(tài)機(jī)。拿一個(gè)實(shí)體對象的狀態(tài)機(jī)來說,它通常與這個(gè)對象在數(shù)據(jù)庫里對應(yīng)記錄的標(biāo)識狀態(tài)的字段值相對應(yīng)。
在剛開始學(xué)編程的時(shí)候,你一定寫過,至少見過直接使用魔術(shù)數(shù)字進(jìn)行判斷的代碼。啥叫魔術(shù)數(shù)字呢,舉個(gè)例子,要置頂一個(gè)文章的時(shí)候先判斷文章是不是已發(fā)布狀態(tài)。
- if (article.state == 2) {
- // state 2 代表文章已發(fā)布
- }
假如我們的代碼里沒有注釋,或者等我們項(xiàng)目的代碼里充斥著這些魔術(shù)數(shù)字的判斷的時(shí)候,你是不是會很頭疼?
后來我就學(xué)會了把這些狀態(tài)值定義成常量,并且也搞一個(gè)判斷對象狀態(tài)的方法單獨(dú)封裝這段邏輯。
- public class ArticleState {
- public static final int Draft = 1; //草稿
- public static final int Published = 2; //發(fā)布
- public static final int Deleted = 3; // 已刪除
- }
- public Boolean checkArticleState(int state) {
- ...
- }
這種用法,肯定是比在程序里直接用魔術(shù)數(shù)字進(jìn)行判斷要強(qiáng)很多啦,至少看著不會很頭疼,不會想罵**。
不過后來被當(dāng)時(shí)帶我的老大哥說這種也有缺點(diǎn),上面這個(gè) checkArticleState 方法用來檢查文章狀態(tài),本意是讓調(diào)用者傳入 ArticleState 的三個(gè)靜態(tài)常量之一,但由于沒有類型上的約束,因此傳入任意一個(gè) int 值在語法上也是允許的,編譯器也不會提出任何警告,換成用枚舉更合適一些。
em~! 我不記得大學(xué)教 Java 的那個(gè)學(xué)期老師講過這玩意啊,莫非又是一個(gè)上課玩手機(jī)錯過的知識點(diǎn)?......
所以使用枚舉后我們的Java代碼變成了:
- // 使用enum而非class聲明
- public enum ArticleState {
- //要在enum里創(chuàng)建所有的枚舉對象
- Draft(1, "草稿");
- Published(2, "已發(fā)布");
- Deleted(3, "已刪除")
- // 自定義屬性
- private int code;
- private String text;
- // 構(gòu)造方法必須是private的
- ArticleState(int code, String text) {
- this.code = id;
- this.text = name;
- }
- }
- public Boolean checkArticleState(ArticleState state) {
- ...
- }
這樣就能靠形參的枚舉類型幫我們過濾掉非法的狀態(tài)值。把整型值作為參數(shù)傳給 checkArticleState 方法時(shí)因?yàn)轭愋筒黄ヅ渚幾g不過去,在寫代碼時(shí)編譯器也能馬上提示出來。
如果沒有用過 Java 的小伙伴也不用糾結(jié),主要的語法點(diǎn)我用注釋標(biāo)注出來了。
后來這兩年主要在用Go做項(xiàng)目,我發(fā)現(xiàn)相似的問題 Go 里也存在,但是 Go 并沒有提供枚舉類型,那怎么做到進(jìn)行狀態(tài)值的正確限制呢?如果還是用 int 型的常量肯定不行。比如:
- const (
- Draft int = 1
- Published = 2
- Deleted = 3
- )
- const (
- Summer int = 1
- Autumn = 2
- Winter = 3
- Spring = 4
- )
- func main() {
- // 輸出 true, 不會有任何編譯錯誤
- fmt.Println(Autumn == Draft)
- }
比如上面定義了兩組 int 類型的常量,一類代表文章狀態(tài),一類代表季節(jié)的四季。這種方式拿文章狀態(tài)與季節(jié)進(jìn)行比較不會有任何編譯上的錯誤。
答案在 Go 內(nèi)置庫或者一些咱們都知道的開源庫的代碼里就能找到。比如看看 google.golang.org/grpc/codes 里的gRPC 的錯誤碼是怎么定義的,我們馬上就能明白該怎么正確的實(shí)現(xiàn)枚舉。
下面不多賣關(guān)子直接上答案了,不想去源碼里看的,就看我這里寫的也行,都是這么做的。
我們可以用 int 作為基礎(chǔ)類型創(chuàng)建一個(gè)別名類型,Go 里邊是支持這個(gè)的
- type Season int
- const (
- Summer Season = 1
- Autumn = 2
- Winter = 3
- Spring = 4
- )
當(dāng)然定義連續(xù)的常量值的時(shí)候 Go 里邊經(jīng)常使用 iota,所以上面的定義還能進(jìn)一步簡化。
- type Season int
- const (
- Summer Season = iota + 1
- Autumn
- Winter
- Spring
- )
- type ArticleState int
- const (
- Draft ArticleState = iota + 1
- Published
- Deleted
- )
- func checkArticleState(ArticleState state) {
- // ...
- }
- func main() {
- // 兩個(gè)操作數(shù)類型不匹配,編譯錯誤
- fmt.Println(Autumn == Draft)
- // 參數(shù)類型不匹配,編譯錯誤
- checkArticleState(100)
- }
雖然這些狀態(tài)值的底層的類型都是 int 值,但是現(xiàn)在不論是進(jìn)行兩個(gè)不相干類型的枚舉值比較,還是用整型值作為參數(shù)調(diào)用 checkArticleState 方法檢查文章狀態(tài),都會造成編譯錯誤,因?yàn)楝F(xiàn)在我們使用狀態(tài)值的地方都有了類型限制。
這就是為什么針對錯誤碼、狀態(tài)機(jī)這種涉及有限數(shù)量狀態(tài)值的場景下不能用整型常量而是要用枚舉的原因。雖然 Go 語言里沒有像 Java 一樣單獨(dú)提供一個(gè) enum 表示枚舉的類型,但是我們?nèi)匀荒芡ㄟ^創(chuàng)建類型別名來實(shí)現(xiàn)枚舉。
你學(xué)會了嗎?(#^.^#)