Golang库插件注册加载机制的问题
作者:轩脉刃 发布时间:2023-06-24 04:25:59
最近看到一个内部项目的插件加载机制,非常赞。当然这里说的插件并不是指的golang原生的可以在buildmode中加载指定so文件的那种加载机制。而是软件设计上的「插件」。如果你的软件是一个框架,或者一个平台性产品,想要提升扩展性,即可以让第三方进行第三方库开发,最终能像搭积木一样将这些库组装起来。那么就可能需要这种库加载机制。
我们的目标是什么?对第三方库进行某种库规范,只要按照这种库规范进行开发,这个库就可以被加载到框架中。
我们先定义一个插件的数据结构,这里肯定是需要使用接口来规范,这个可以根据你的项目自由发挥,比如我希望插件有一个Setup方法来在启动的时候加载即可。然后我就定义如下的Plugin结构。
type Plugin interface{
Name() string
Setup(config map[string]string) error
}
而在框架启动的时候,我启动了一个如下的全局变量:
var plugins map[string]Plugin
注册
有人可能会问,这里有了加载函数setup,但是为什么没有注册逻辑呢?
答案是注册的逻辑放在库的init函数中。
即框架还提供了一个注册函数。
// package plugin
Register(plugin Plugin)
这个register就是实现了将第三方plugin放到plugins全局变量中。
所以第三方的plugin库大致实现如下:
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中了。
加载
注册的逻辑其实看起来也平平无奇,但是加载的逻辑就考验细节了。
首先插件的加载其实有两点需要考虑:
配置
依赖
配置指的是插件一定是有某种配置的,这些配置以配置文件yaml中plugins.myplugin的路径存在。
plugins:
myplugin:
foo: bar
其实我对这种实现持保留意见。配置文件以一个文件中配置项的形式存在,好像不如以配置文件的形式存在,即以config/plugins/myplugin.yaml 的文件。
这样不会出现一个大配置文件的问题。毕竟每个配置文件本身就是一门DSL语言。如果你将配置文件的逻辑变复杂,一定会有很多附带的bug是由于配置文件错误导致的。
第二个说的是依赖。插件A依赖与插件B,那么这里就有加载函数Setup的先后顺序了。这种先后顺序如果纯依赖用户的“经验”,将某个插件的Setup调用放在某个插件的Setup调用之前,是非常痛苦的。(虽然一定是有办法可以做到)。更好的办法是依赖于框架自身的加载机制来进行加载。
首先我们在plugin包中定义一个接口:
type Depend interface{
DependOn() []string
}
如果我的插件依赖一个名字为 “fooPlugin” 的插件,那么我的插件 MyPlugin就会实现这个接口。
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"}
在最终加载所有插件的时候,我们并不是简单地将所有插件调用Setup,而是使用一个channel,将所有插件放在channel中,然后一个个调用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,除了消费队列,也有可能生产数据到队列,这样就保证了队列中所有plugin都是被按照标记的依赖被顺序加载的。
来源:https://www.cnblogs.com/yjf512/p/16065604.html
猜你喜欢
- 介绍:SQL Server 2008变更数据捕获SQL Server 2008的CDC函数读取激活了CDC的每个表所关联的事务日志来记录系统
- CSS浮动一直是个比较让人郁闷的问题,很多的布局问题都出在浮动上,特别是当浮动的列数很多时,但其实只要理解了两列结构的浮动,面对多列数的浮动
- 我们在用Drwamweaver书写英文文本时,段落一般不缩进(不支持半角空格);但我们大多的时候都是用中文书写格式,必须在每段开头空两个汉字
- 阅读上一篇:浏览器中的内存泄露 4.内存泄露的解决方案显式类型转换 首先说说最容易处理的情况 对于类型转换造成的错误,我们可以通过显式类型转
- 建立资料表:Step1首先开启phpmyadmin,进入wordpress资料库中,并新增一个wp_gbook的资料表与栏位数目8。Step
- 一个将人民币数字转化为大写的asp函数,可以准确读出数字的大写,而不是简单的将数字翻译为大写。有了这个工具大家就可以很方便的写出大写的人民币
- 导语在设计论坛之前的讨论中曾经谈到过“设计师应该抓住这个时代的情感”,这是设计师的设计嗅觉和职业特性的体现,那么在纷纷扰扰中“裂变”的Web
- 内容摘要:严格地说,ASP 并不是一门编程语言,所以不存在类这一概念,我们这里说 ASP 类是指 A
- 1 实验环境(1)服务端:本实验基于虚拟机win2008系统的WAMP环境进行,该环境相关配置过程参考文章《【语言环境】WAMP环境部署及优
- 印刷和网络是不一样的。传统的布局排版并不适于网络,因为传统的印刷布局,几乎只想要什么样的平面效果都能很好的达到,但在网络上设计就很困难,尽管
- 语法: ROW_NUMBER() OVER([ <partition_by_clause>] <order_by_clau
- 经常看到说正则的文章,但说的只是方法,却很少有说以下几个基本概念:1.贪婪:+,*,?,{m,n}等默认是贪婪匹配,即尽可能多匹配,也叫最大
- 刚才帮一位朋友做跳转的时候做的,为了获取完整的url地址,还是花了那么点时间不过现在看来,原来是那么简单,没有网上那么多复杂的东东,相信一定
- 很多朋友想用SQL2000数据库的编程方法,但是却又苦于自己是学ACCESS的,对SQL只是一点点的了解而已,这里我给大家提供以下参考---
- ewebeditor支持兼容IE8 的方法方法:前几天ie8正式公布了,当天中午我就去下载了一个迫不急待的将自己的浏览器升级到ie8,偶还刻
- oracle数据库的快照是一个表,它包含有对一个本地或远程数据库上一个或多个表或视图的查询的结果。正因为快照是一个主表的查询子集,使用快照可
- Web 前端优化最佳实践第三部分面向 Cookie 。目前只有 2 条实践规则。1. 缩小 Cookie (Reduce Cook
- function createobj() { if (window.ActiveXObject)&n
- 人类学是关于人的研究;社会人类学(social anthropology)是研究人类社会的学科。社会人类学还可以理解成“文化翻译”(the
- 怎样才能将在表A取得的数据插入另一个表B中?(1)对于表A和表B两个表结构完全相同的话〔字段个数,相应字段的类型等等〕,可以使用 inser