Go 中 Set 的實現方式

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

本篇主要講述如何利用Go語言的文法特性實現Set類型的資料結構。

需求

對於Set類型的資料結構，其實本質上跟List沒什麼多大的區別。無非是Set不能含有重複的Item的特性，Set有初始化、Add、Clear、Remove、Contains等操作。接下來看具體的實現方式分析吧。

實現

仍然按照已有的編程經驗來聯想如何?基本Set功能，在Java中很容易知道HashSet的底層實現是HashMap，核心的就是用一個常量來填充Map索引值對中的Value選項。除此之外，重點關注Go中Map的資料結構，Key是不允許重複的，如下所示：

m := map[string]string{"1": "one","2": "two","1": "one","3": "three",}fmt.Println(m)

程式會直接報錯，提示重複Key值，這樣就非常符合Set的特性需求了。

定義

前面分析出Set的Value為固定的值，用一個常量替代即可。但是筆者分析的實現源碼，用的是一個空結構體來實現的，如下所示：

// 空結構體var Exists = struct{}{}// Set is the main interfacetype Set struct {// struct為結構體類型的變數m map[interface{}]struct{}}

為瞭解決上面為什麼用空結構體來做常量Value，先看下面的是測試：

import ("fmt""unsafe")// 定義非空結構體type S struct {        a uint16        b uint32}func main() {var s Sfmt.Println(unsafe.Sizeof(s)) // prints 8, not 6var s2 struct{}fmt.Println(unsafe.Sizeof(s2)) // prints 0}

列印出空結構體變數的記憶體佔用大小為0，再看看下面這個測試：

a := struct{}{}b := struct{}{}fmt.Println(a == b) // truefmt.Printf("%p, %p\n", &a, &b) // 0x55a988, 0x55a988

很有趣，a和b竟然相等，並且a和b的地址也是一樣的。現在各位應該明白了為什麼會有：

var Exists = struct{}{}

這樣的常量也來填充所有Map的Value了吧，Go真是精彩！！！

初始化

Set類型資料結構的初始化操作，在聲明的同時可以選擇傳入或者不傳入進去。聲明Map切片的時候，Key可以為任意類型的資料，用空介面來實現即可。Value的話按照上面的分析，用空結構體即可：

func New(items ...interface{}) *Set {    // 擷取Set的地址s := &Set{}// 聲明map類型的資料結構s.m = make(map[interface{}]struct{})s.Add(items...)return s}

添加

簡化操作可以添加不定個數的元素進入到Set中，用變長參數的特性來實現這個需求即可，因為Map不允許Key值相同，所以不必有排重操作。同時將Value數值指定為空結構體類型。

func (s *Set) Add(items ...interface{}) error {for _, item := range items {s.m[item] = Exists}return nil}

包含

Contains操作其實就是查詢操作，看看有沒有對應的Item存在，可以利用Map的特性來實現，但是由於不需要Value的數值，所以可以用 _,ok來達到目的：

func (s *Set) Contains(item interface{}) bool {_, ok := s.m[item]return ok}

長度和清除

擷取Set長度很簡單，只需要擷取底層實現的Map的長度即可：

func (s *Set) Size() int {return len(s.m)}

清除操作的話，可以通過重新初始化Set來實現，如下即為實現過程：

func (s *Set) Clear() {s.m = make(map[interface{}]struct{})}

相等

判斷兩個Set是否相等，可以通過迴圈遍曆來實現，即將A中的每一個元素，查詢在B中是否存在，只要有一個不存在，A和B就不相等，實現方式如下所示：

func (s *Set) Equal(other *Set) bool {  // 如果兩者Size不相等，就不用比較了if s.Size() != other.Size() {return false}   // 迭代查詢遍曆for key := range s.m {        // 只要有一個不存在就返回falseif !other.Contains(key) {return false}}return true}

子集

判斷A是不是B的子集，也是迴圈遍曆的過程，具體分析在上面已經講述過，實現方式如下所示：

func (s *Set) IsSubset(other *Set) bool {// s的size長於other，不用說了if s.Size() > other.Size() {return false}    // 迭代遍曆for key := range s.m {if !other.Contains(key) {return false}}return true}

Ok，以上就是Go中Set的主要函數實現方式，還是很有意思的。繼續加油。