写一个插件

从开发到测试

  • 新建一个项目，项目结构为：
  1. demo-plugin/
  2.   src/
  3.     github.com/
  4.         TeaWeb/
  5.             plugin/
  6.                 [https://github.com/TeaWeb/plugin源码]
  7.     main/
  8.         demo.go - 你的插件源文件  
  9.         build.sh - 构建脚本

其中plugin源码可以在 这里 下载；

  • 在 main/ 目录下建一个插件的Go文件，比如命名为 demo.go ；
  • 在 demo.go 中实现
  1. package main
  3. import (
  4.     "github.com/TeaWeb/plugin/loader"
  5.     "github.com/TeaWeb/plugin/plugins"
  6. )
  8. func main() {
  9.     demoPlugin := plugins.NewPlugin()
  10.     demoPlugin.Name = "Demo Plugin"
  11.     demoPlugin.Code = "com.example.demo"
  12.     demoPlugin.Developer = "Liu xiangchao"
  13.     demoPlugin.Version = "1.0.0"
  14.     demoPlugin.Date = "2018-10-15"
  15.     demoPlugin.Site = "https://github.com/TeaWeb/build"
  16.     demoPlugin.Description = "这是一个Demo插件"
  18.     loader.Start(demoPlugin)
  19. }
  • 可以修改 demoPlugin，以提供插件的名称、描述等信息，或者实现其他功能；
  • 使用 go build -o demo.tea demo.go 编译插件；
  • 将编译成功后的 demo.tea 放到TeaWeb 的 plugins/ 目录下，重启 TeaWeb 后生效。

构建脚本

build.sh

  1. #!/usr/bin/env bash
  3. export GOPATH=`pwd`/../../
  4. export CGO_ENABLED=1
  6. # msgpack
  7. if [ ! -d "${GOPATH}/src/github.com/vmihailenco/msgpack" ]
  8. then
  9.     go get "github.com/vmihailenco/msgpack"
  10. fi
  12. # TeaWeb
  13. if [ ! -d "${GOPATH}/src/github.com/TeaWeb/plugin" ]
  14. then
  15.     go get "github.com/TeaWeb/plugin"
  16. fi
  18. go build -o demo.tea demo.go

代码示例

请见 main/demo.go。