詳解Golang函數(shù)式選項(xiàng)(Functional?Options)模式
概覽
最近閱讀源碼的時候看到一段不錯的代碼,但是當(dāng)時卻不是非常理解為什么這么寫。
我們先來看一下源代碼:
type User struct { ID string Name string Age int Email string Phone string Gender string } type Option func(*User) func WithAge(age int) Option { return func(u *User) { u.Age = age } } func WithEmail(email string) Option { return func(u *User) { u.Email = email } } func WithPhone(phone string) Option { return func(u *User) { u.Phone = phone } } func WithGender(gender string) Option { return func(u *User) { u.Gender = gender } } func NewUser(id string, name string, options ...func(*User)) (*User, error) { user := User{ ID: id, Name: name, Age: 0, Email: "", Phone: "", Gender: "female", } for _, option := range options { option(&user) } //... return &user, nil } func main() { user, err := NewUser("1", "Ada", WithAge(18), WithPhone("123456")) if err != nil { fmt.Printf("NewUser: err:%v", err) } fmt.Printf("NewUser Success") }
當(dāng)時呢,也不是很明白 NewUser 這個構(gòu)造函數(shù)為什么要這么寫,后來查看了資料才知道了這是一種設(shè)計模式–函數(shù)式選項(xiàng)(functional options)模式。
什么是函數(shù)式選項(xiàng)模式,為什么要這么寫,這個編程模式解決了什么問題呢?
其實(shí)就是為了解決動態(tài)靈活的配置不同的參數(shù)的問題。
假如我們有一個需求:
在網(wǎng)站注冊賬號,有很多可選的選項(xiàng),可填可不填。會根據(jù)你填的信息初始化你的 User 對象。
重載函數(shù)
如果你有 C++ 或者 Java 的編程基礎(chǔ),你的第一反應(yīng)應(yīng)該是函數(shù)重載。
但是因?yàn)?Golang 語言不像 C++ 一樣支持重載函數(shù),所以,你得用不同的函數(shù)名來應(yīng)對不同的配置選項(xiàng)。
像這樣:
func NewUserDefault(id string, name string) (*User, error) { return &User{ID: id, Name: name}, nil } func NewUserWithPhone(id string, name string, phone string) (*User, error) { return &User{ID: id, Name: name, Phone: phone}, nil } func NewUserWithEmail(id string, name string, email string) (*User, error) { return &User{ID: id, Name: name, Email: email}, nil }
如果一共只有兩三個參數(shù)的情況下,比較簡單,但是更多的選項(xiàng)的組合就代碼看起來很亂了。
配置化
這個時候我們可能會想到,配置化。
把所有可選的參數(shù)放到一個Config的struct中。
type Config struct { Age int Email string Phone string Gender string }
然后把Config放到User的struct中。
type User struct { ID string Name string Conf *Config }
于是,我們只需要一個 NewUser() 的函數(shù)了,在使用前需要構(gòu)造 Config 對象。
func NewUser(id string, name string, conf *Config) (*User, error) { //... } //Using the default configuratrion user, _ := NewUser("1", "Ada", nil) conf := Config{Age:18, Phone: "123456"} user2, _ := NewUser("2", "Bob", &conf)
這段代碼看起來算是不錯了,很多時候我使用的一些開源庫也是這么寫的。通過引入一個Config對象來解決多個參數(shù)的組合的問題。
Builder模式
有些經(jīng)常使用Java的同學(xué)會想到Builder模式。
于是就可以以如下的方式來使用了:
user := new(UserBuilder).Create("1", "Ada"). age(18). phone("123456"). gender("female"). Build()
需要引入一個抽象的UserBuilder對象,來包裝User對象,最終Build一個User對象返回。
函數(shù)式選項(xiàng)模式
函數(shù)式選項(xiàng)模式 首先需要定義一個函數(shù)類型:
type Option func(*User)
然后,我們定義一組返回函數(shù)的函數(shù):
func WithAge(age int) Option { return func(u *User) { u.Age = age } } func WithEmail(email string) Option { return func(u *User) { u.Email = email } } func WithPhone(phone string) Option { return func(u *User) { u.Phone = phone } } func WithGender(gender string) Option { return func(u *User) { u.Gender = gender } }
這個模式和Builder模式的區(qū)別是,Builder模式返回的是 * User 對象,Functional Options 返回的是函數(shù)類型 func(* User)。
上面這組代碼傳入一個參數(shù),然后返回一個函數(shù),返回的這個函數(shù)會設(shè)置自己的 User 參數(shù)。
這樣我們就方便在 NewUser 里面統(tǒng)一初始化。循環(huán)對我們的函數(shù)類型執(zhí)行調(diào)用操作。 option(&user)
func NewUser(id string, name string, options ...func(*User)) (*User, error) { user := User{ ID: id, Name: name, Age: 0, Email: "", Phone: "", Gender: "female", } for _, option := range options { option(&user) } //... return &user, nil }
調(diào)用方式如下:
user1, err := NewUser("1", "Ada") user2, err := NewUser("2", "Bob", WithPhone("123456"), WithGender("male"))
這個看起來比較整潔和優(yōu)雅,對外的接口只有一個NewUser。
相比于Builder模式,不需要引入一個Builder對象。
對比配置化的模式,也不需要引入一個新的Config。
總結(jié)
Golang 由于語言本身的特性,不支持函數(shù)重載,函數(shù)式選項(xiàng) 的編程模式在一定程度上解決了其他語言需要通過函數(shù)重載解決的問題。
函數(shù)式選項(xiàng) 編程有以下優(yōu)點(diǎn):
優(yōu)點(diǎn):
任意順序傳遞參數(shù)支持默認(rèn)值向后兼容性很容易維護(hù)和擴(kuò)展
看了這么多,是不是想馬上上手重構(gòu)你之前的代碼了。
雖然 函數(shù)式選項(xiàng) 編程模式有很多優(yōu)點(diǎn),但是設(shè)計模式的存在都是為了彌補(bǔ)語言特性的缺陷的一種手段。它是為了解決代碼擴(kuò)展性的問題,往往是通過增加抽象犧牲了簡單性,切勿過度使用。有些簡單的配置,就不需要設(shè)計的這么通用了。
函數(shù)式選項(xiàng)模式的使用場景有哪些呢:
我們一般用來配置一些基礎(chǔ)的服務(wù)配置,比如MySQL,Redis,Kafka的配置,很多可選參數(shù),可以方便動態(tài)靈活的配置想要配置的參數(shù)。
到此這篇關(guān)于Golang函數(shù)式選項(xiàng)(Functional Options)模式的文章就介紹到這了,更多相關(guān)Golang函數(shù)式選項(xiàng)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
使用Go語言實(shí)現(xiàn)找出兩個大文件中相同的記錄
這篇文章主要為大家詳細(xì)介紹了使用Go語言實(shí)現(xiàn)找出兩個大文件中相同的記錄的相關(guān)知識,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2024-10-10golang?pprof?監(jiān)控goroutine?thread統(tǒng)計原理詳解
這篇文章主要為大家介紹了golang?pprof?監(jiān)控goroutine?thread統(tǒng)計原理詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-04-04golang中的io.ReadCloser與ioutil.NopCloser使用
這篇文章主要介紹了golang中的io.ReadCloser與ioutil.NopCloser使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-03-03Go語言中使用 buffered channel 實(shí)現(xiàn)線程安全的 pool
這篇文章主要介紹了Go語言中使用 buffered channel 實(shí)現(xiàn)線程安全的 pool,因?yàn)镚o語言自帶的sync.Pool并不是很好用,所以自己實(shí)現(xiàn)了一線程安全的 pool,需要的朋友可以參考下2014-10-10