Golang庫插件注冊加載機制的問題
最近看到一個內(nèi)部項目的插件加載機制,非常贊。當然這里說的插件并不是指的golang原生的可以在buildmode中加載指定so文件的那種加載機制。而是軟件設(shè)計上的「插件」。如果你的軟件是一個框架,或者一個平臺性產(chǎn)品,想要提升擴展性,即可以讓第三方進行第三方庫開發(fā),最終能像搭積木一樣將這些庫組裝起來。那么就可能需要這種庫加載機制。
我們的目標是什么?對第三方庫進行某種庫規(guī)范,只要按照這種庫規(guī)范進行開發(fā),這個庫就可以被加載到框架中。
我們先定義一個插件的數(shù)據(jù)結(jié)構(gòu),這里肯定是需要使用接口來規(guī)范,這個可以根據(jù)你的項目自由發(fā)揮,比如我希望插件有一個Setup方法來在啟動的時候加載即可。然后我就定義如下的Plugin結(jié)構(gòu)。
type Plugin interface{ Name() string Setup(config map[string]string) error }
而在框架啟動的時候,我啟動了一個如下的全局變量:
var plugins map[string]Plugin
注冊
有人可能會問,這里有了加載函數(shù)setup,但是為什么沒有注冊邏輯呢?
答案是注冊的邏輯放在庫的init函數(shù)中。
即框架還提供了一個注冊函數(shù)。
// package plugin Register(plugin Plugin)
這個register就是實現(xiàn)了將第三方plugin放到plugins全局變量中。
所以第三方的plugin庫大致實現(xiàn)如下:
package MyPlugin type MyPlugin struct{ } func (m *MyPlugin) Setup(config map[string]string) error { // TODO func (m *MyPlugin) Name() string { return "myPlugin" func init() { plugin.Register(&MyPlugin)
這樣注冊的邏輯就變成了,如果你要加載一個插件,那么你在main.go中直接以 _ import的形式引入即可。
package main _ import "github.com/foo/myplugin" func main() { }
整體的感覺,這樣子插件的注冊就被“隱藏”到import中了。
加載
注冊的邏輯其實看起來也平平無奇,但是加載的邏輯就考驗細節(jié)了。
首先插件的加載其實有兩點需要考慮:
- 配置
- 依賴
配置指的是插件一定是有某種配置的,這些配置以配置文件yaml中plugins.myplugin的路徑存在。
plugins: myplugin: foo: bar
其實我對這種實現(xiàn)持保留意見。配置文件以一個文件中配置項的形式存在,好像不如以配置文件的形式存在,即以config/plugins/myplugin.yaml 的文件。
這樣不會出現(xiàn)一個大配置文件的問題。畢竟每個配置文件本身就是一門DSL語言。如果你將配置文件的邏輯變復(fù)雜,一定會有很多附帶的bug是由于配置文件錯誤導(dǎo)致的。
第二個說的是依賴。插件A依賴與插件B,那么這里就有加載函數(shù)Setup的先后順序了。這種先后順序如果純依賴用戶的“經(jīng)驗”,將某個插件的Setup調(diào)用放在某個插件的Setup調(diào)用之前,是非常痛苦的。(雖然一定是有辦法可以做到)。更好的辦法是依賴于框架自身的加載機制來進行加載。
首先我們在plugin包中定義一個接口:
type Depend interface{ DependOn() []string }
如果我的插件依賴一個名字為 “fooPlugin” 的插件,那么我的插件 MyPlugin就會實現(xiàn)這個接口。
package MyPlugin type MyPlugin struct{ } func (m *MyPlugin) Setup(config map[string]string) error { // TODO func (m *MyPlugin) Name() string { return "myPlugin" func init() { plugin.Register(&MyPlugin) func (m *MyPlugin) DependOn() []string { return []string{"fooPlugin"}
在最終加載所有插件的時候,我們并不是簡單地將所有插件調(diào)用Setup,而是使用一個channel,將所有插件放在channel中,然后一個個調(diào)用Setup,遇到有Depend其他插件的,且依賴插件還未被加載,則將當前插件放在隊列最后(重新塞入channel)。
var setupStatus map[string]bool // 獲取所有注冊插件 func loadPlugins() (plugin chan Plugin, setupStatus map[string]bool) { // 這里定義一個長度為10的隊列 var sortPlugin = make(chan Plugin, 10) var setupStatus = make[string]bool // 所有的插件 for name, plugin := range plugins { sortPlugin <- plugin setupStatus[name] = false } return sortPlugin, setupStatus } // 加載所有插件 func SetupPlugins(pluginChan chan Plugin, setupStatus map[string]bool) error { num := len(pluginChan) for num > 0 { plugin <- pluginChan canSetup := true if deps, ok := p.(Depend); ok { depends := deps.DependOn() for _, dependName := range depends{ if _, setuped := setupStatus[dependName]; !setup { // 有未加載的插件 canSetup = false break } } } // 如果這個插件能被setup if canSetup { plugin.Setup(xxx) setupStatus[p.Name()] = true } else { // 如果插件不能被setup, 這個plugin就塞入到最后一個隊列 pluginChan <- plugin return nil }
上面這段代碼最精妙的就是使用了一個有buffer的channel作為一個隊列,消費隊列一方SetupPlugins,除了消費隊列,也有可能生產(chǎn)數(shù)據(jù)到隊列,這樣就保證了隊列中所有plugin都是被按照標記的依賴被順序加載的。
總結(jié)
這種插件的注冊和加載機制是非常優(yōu)雅的。注冊方面,巧妙使用隱式import來做插件的注冊。而加載方面,巧妙使用有buffer的channel作為加載隊列。
到此這篇關(guān)于Golang庫插件注冊加載機制的文章就介紹到這了,更多相關(guān)Golang插件機制內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Golang的Crypto/SHA256庫實戰(zhàn)指南
無論是在保護數(shù)據(jù)安全、驗證數(shù)據(jù)完整性,還是在構(gòu)建復(fù)雜的安全系統(tǒng)中,crypto/sha256都是Golang程序員不可或缺的工具,本文主要介紹了Golang的Crypto/SHA256庫實戰(zhàn)指南,感興趣的可以了解一下2024-02-02詳解Golang中string的實現(xiàn)原理與高效使用
在Go語言中,無論是字符串常量、字符串變量還是代碼中出現(xiàn)的字符串字面量,它們的類型都被統(tǒng)一設(shè)置為string,下面就跟隨小編一起來了解一下Golang中string的實現(xiàn)原理與高效使用吧2024-01-01Go語言編譯程序從后臺運行,不出現(xiàn)dos窗口的操作
這篇文章主要介紹了Go語言編譯程序從后臺運行,不出現(xiàn)dos窗口的操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2021-04-04Go語言利用time.After實現(xiàn)超時控制的方法詳解
最近在學(xué)習(xí)golang,所以下面這篇文章主要給大家介紹了關(guān)于Go語言利用time.After實現(xiàn)超時控制的相關(guān)資料,文中通過示例介紹的非常詳細,需要的朋友可以參考借鑒,下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2018-08-08golang interface判斷為空nil的實現(xiàn)代碼
這篇文章主要介紹了golang interface判斷為空nil的實現(xiàn)代碼,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2021-04-04