pluginloader:简化go语言plugin函数和对象调用

2019-5-11 新增:

UnknownObject 类型增加了两个新方法:JsonCopyToStruct,前一个导出JSON,后一个把结构体的可导出值复制到另一个相似的结构体中。

2019-4-19 新修改:

  • 修改 pluginwrap ,删除生成的文件中的 InitxxxFuncs,改为:func GetxxxFuncs(p *pluginloader.PluginLoader) *xxxFuncs, 函数都被包含在 xxxFuncs结构体中避免命名冲突。
  • pluginloader新增用于调用未定义结构体的对象:UnknownObject。

2019-4-18 新修改:pluginwrap几乎已经完美了! 现在除了用户自定义类型,已经可以使用所有被导入库的类型。

go语言的plugin调用还是很繁琐,而且功能限制也不少,我开发了的这个程序包含一个包github.com/rocket049/pluginloader和一个命令行工具github.com/rocket049/pluginloader/cmd/pluginwrap

github.com/rocket049/pluginloader引用到程序中,用于简化函数调用。

命令行工具pluginwrap用于从plugin的源代码生成可导出对象struct对应的interface和可导出func

使用pluginloader

安装命令: go get github.com/rocket049/pluginloader

可调用的函数:

type PluginLoader struct {
    P *plugin.Plugin
}

///Call return type must be: (res,error)
func (p *PluginLoader) Call(funcName string, p0 ...interface{}) (interface{}, error)

//CallValue Allow any number of return values,return type: []reflect.Value,error
func (p *PluginLoader) CallValue(funcName string, p0 ...interface{}) ([]reflect.Value, error)

//MakeFunc point a func ptr to plugin
func (s *PluginLoader) MakeFunc(fptr interface{}, name string) error 

//20190419 新增
//UnknownObject 成员'V' 必须是结构体指针的 Value: *struct{...}
type UnknownObject struct {
    V reflect.Value
}
//NewUnknownObject 参数'v' 必须是结构体指针的 Value: *struct{...},否则返回 nil
func NewUnknownObject(v reflect.Value) *UnknownObject 

//Get 得到结构体成员的 Value
func (s *UnknownObject) Get(name string) reflect.Value

//Call 运行结构体的 method
func (s *UnknownObject) Call(fn string, args ...interface{}) []reflect.Value

//Json 把结构体编码为 JSON。 convert the struct to JSON. if error,return nil.
func (s *UnknownObject) Json() []byte 

//CopyToStruct 利用 reflect 技术把结构体的可 export 值复制到 v 中,v 必须是相似结构体的指针。 copy the exported value of a struct to v 
func (s *UnknownObject) CopyToStruct(v interface{}) error 

pluginloader导出method的具体说明

  • Call,直接通过函数名调用对应的函数,但是返回值形式受到限制。
  • CallValue,直接通过函数名调用对应的函数,返回值形式不受限制。
  • MakeFunc,根据名字把预定义的函数类型变量指向插件中的函数。

UnknownObject说明

  • func NewUnknownObject(v reflect.Value) *UnknownObject,参数'v' 必须是结构体指针的 Value: *struct{...},否则返回 nil
  • Method:Get(name string) reflect.Value,得到结构体成员的 Value
  • Method:Call(fn string, args ...interface{}) []reflect.Value,运行结构体的 method

调用示例

import "github.com/rocket049/pluginloader"

p, err := pluginloader.NewPluginLoader( "foo.so" )
if err != nil {
    panic(err)
}

res, err := p.Call("NameOfFunc", p0,p1,p3,...)
// ...

ret := p.CallValue("NameOfFunc", p0,p1,p3,...)
// ...

var Foo func(arg string)(string,error)
p.MakeFunc(&Foo,"Foo")
ret, err = Foo("something")
// ...

// 使用 UnknownObject. NewFoo return 'foo *Foo'
v, err := p.CallValue("NewFoo")
if err != nil {
    t.Fatal(err)
}
obj := NewUnknownObject(v[0])

id: = obj.Get("Id").Int()

err = obj.Call("Set", nil)

使用pluginwrap

安装命令: go get github.com/rocket049/pluginloader/cmd/pluginwrap

用法

pluginwrap path/to/plugin/foo

生成的文件名字:
fooWrap.go

把这个文件加入你的工程就可以方便的调用plugin的导出函数了。

功能

  1. 生成导出对象的接口,以便用于类型断言。
  2. 生成导出函数。

限制

本程序基于标准包pluginreflect实现,因为go语言的变量类型转换的使用有很多限制,所以本程序对导出函数的参数类型、返回值类型都有限制, 导出参数、返回值的类型仅限于基本类型、标准库、第三方库中的类型,不能使用自定义类型。

如果必须使用自定义类型,有两种办法:

  1. 请使用 pluginloader.Callpluginloader.CallValue 调用。
  2. 把需要导出的复杂类型做成第三方库(import "your/package"),不要在plugin源代码中定义。

示例

使用对象(struct)

    p, err := pluginloader.NewPluginLoader("foo.so")
    if err != nil {
        panic(err)
    }
    iface, err := p.Call("NewFoo",arg...)
    if err != nil {
        panic(err)
    }
    foo := iface.(IFoo)
    // use foo.Method

使用func

    //2090419 new
    p, err := pluginloader.NewPluginLoader("foo.so")
    if err != nil {
        panic(err)
    }
    
    // MUST call GetxxxFuncs(p) before call funcs, xxx = plugin名字
    funcs := GetfooFuncs(p)
    
    // call methods in plugin foo
    funcs.Method(arg)
    
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,904评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,581评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,527评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,463评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,546评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,572评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,582评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,330评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,776评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,087评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,257评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,923评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,571评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,192评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,436评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,145评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352

推荐阅读更多精彩内容