通过使用插件在运行时扩展程序的功能,而无需重新编译程序,这是一个很常见的功能需求,特别是在模块化设计的程序里面,比如 Nginx 的模块系统。 在 C/C++中通过使用动态库的方式可以实现动态加载,但是 Go 直到 1.8 官方才开始支持,下面将介绍 Go 如何基于动态链接库来实现动态加载。
优点:
缺点:
因此请慎重考虑,是使用动态插件还是在源码里面进行插件化。
从 1.8 版开始,官方提供了这种插件化的手段:plugin. 此功能使程序员可以使用动态链接库构建松散耦合的模块化程序,可以在运行时动态加载和绑定。
Go 插件是使用 -buildmode = plugin
标记编译的一个包,用于生成一个共享对象 (.so) 库文件。 Go 包中的导出的函数和变量被公开为 ELF 符号,可以使用 plugin 包在运行时查找并绑定 ELF 符号。Go 编译器能够使用 build flag -buildmode = c-shared 创建 C 风格的动态共享库。
1.8 版本插件功能只能在 Linux 上使用。 1.10 也可以在 Mac 上运行。
下面将介绍使用 Go 插件系统创建模块化软件的一些开发原则,并提供一个功能齐全的示例。
使用 Go 插件创建模块化程序需要遵循与常规 Go 软件包一样严格的软件实践。然而,插件引入了新的设计问题,因为它们的解耦性质被放大了。因此我们在设计可插拔系统时,有一些原则需要关注:
应该将插件视为与其他组件分离的独立组件。这允许插件独立于他们的消费者,并拥有自己的开发和部署生命周期。注意插件的可用性很重要,因为它有肯能为整个系统带来不稳定的因素,因此系统必须为插件集成提供一个简单的封装层,插件开发人员将系统视为黑盒,不作为所提供的合约以外的假设,从而保证插件自身的可用性。
Go 插件可以导出任何类型的包函数和变量。您可以设计插件来将其功能解耦为一组松散的函数。缺点是您必须单独查找和绑定每个函数符号。
然而,更为简单的方法是使用接口类型。创建导出功能的接口提供了统一简洁的交互,并具有清晰的功能划分。解析到接口的符号将提供对该功能的整个方法集的访问,而不仅仅是一个方法。
插件代码应该设计成只关注一个功能点。
插件是不透明而独立的实体,应该进行版本控制,以向用户提示其支持的功能。这里的一个建议是在命名共享对象文件时使用语义版本控制。例如,上面的文件编译插件可以命名为 eng.so.1.0.0。
我以我遇到的一个实际需求为例,在开发物联网接入组件的时候,需要动态支持物解析,下面就开发一个物解析的插件系统。
下面是项目结构,parser.go 是接口规约,main.go 是主程序,plugins 存放多个插件包
├── main.go
├── parser.go
└── plugins
├── car
│ └── car.go
└── phone
└── phone.go
package main
// Parser use to parse things
type Parser interface {
byte) (meta map[string]string, data map[string]float64, err error)
}
package main
type car string
func (c *car) Parse([]byte) (meta map[string]string, data map[string]float64, err error) {
map[string]string{"key1": "a"}
map[string]float64{"key1": 1}
return meta, data, nil
}
var Car car
package main
type phone string
func (p *phone) Parse([]byte) (meta map[string]string, data map[string]float64, err error) {
map[string]string{"key1": "b"}
map[string]float64{"key1": 2}
return meta, data, nil
}
var Phone phone
$ cd plugins
$ go build -buildmode=plugin -o car.so car/car.go
$ go build -buildmode=plugin -o phone.so phone/phone.go
最终在 plugins 目录下会生成好我们编译好的插件:
$ ls *.so
car.so phone.so
插件的使用很简单,大概步骤如下:
主程序使用插件:main.go
package main
import (
"fmt"
"plugin"
)
// Parser use to parse things
type Parser interface {
byte) (meta map[string]string, data map[string]float64, err error)
}
func pa() {
"./plugins/car.so")
if err != nil {
panic(err)
}
"Car")
if err != nil {
panic(err)
}
p, ok := car.(Parser)
if ok {
byte("a"))
if err != nil {
panic(err)
}
"meta: %v, data: %v \n", meta, data)
}
}
func pb() {
"./plugins/phone.so")
if err != nil {
panic(err)
}
"Phone")
if err != nil {
panic(err)
}
p, ok := phone.(Parser)
if ok {
byte("a"))
"meta: %v, data: %v \n", meta, data)
}
}
func main() {
pa()
pb()
}
测试是否正常运行:
$ go run main.go
meta: map[key1:a], data: map[key1:1]
meta: map[key1:b], data: map[key1:2]