Golang实现Go与Lua语言绑定交互的插件库binder使用指南

简介

Binder是一个高级的Go与Lua绑定库，基于gopher-lua实现，让你"写更少的代码，做更多的事"。

安装

$ go get -u github.com/alexeyco/binder

运行单元测试：

$ cd $GOPATH/src/github.com/alexeyco/binder
$ go test -cover

使用示例

函数绑定

package main

import (
	"errors"
	"log"

	"github.com/alexeyco/binder"
)

func main() {
	b := binder.New(binder.Options{
		SkipOpenLibs: true,
	})

	// 绑定log函数到Lua
	b.Func("log", func(c *binder.Context) error {
		t := c.Top()  // 获取参数数量
		if t == 0 {
			return errors.New("需要参数")
		}

		l := []interface{}{}

		// 收集所有参数
		for i := 1; i <= t; i++ {
			l = append(l, c.Arg(i).Any())
		}

		log.Println(l...)  // 打印所有参数
		return nil
	})

	// 执行Lua代码
	if err := b.DoString(`
		log('This', 'is', 'Lua')
	`); err != nil {
		log.Fatalln(err)
	}
}

模块绑定

package main

import (
	"errors"
	"log"

	"github.com/alexeyco/binder"
)

func main() {
	b := binder.New()

	// 创建reverse模块
	m := b.Module("reverse")
	m.Func("string", func(c *binder.Context) error {
		if c.Top() == 0 {
			return errors.New("需要参数")
		}

		s := c.Arg(1).String()  // 获取第一个参数

		// 反转字符串
		runes := []rune(s)
		for i, j := 0, len(runes)-1; i < j; i, j = i+1, j-1 {
			runes[i], runes[j] = runes[j], runes[i]
		}

		c.Push().String(string(runes))  // 将结果压入栈
		return nil
	})

	// 使用reverse模块
	if err := b.DoString(`
		local r = require('reverse')
		print(r.string('ABCDEFGHIJKLMNOPQRSTUFVWXYZ'))
	`); err != nil {
		log.Fatalln(err)
	}
}

表绑定

package main

import (
	"errors"
	"log"

	"github.com/alexeyco/binder"
)

type Person struct {
	Name string
}

func main() {
	b := binder.New()

	// 创建person表
	t := b.Table("person")
	t.Static("new", func(c *binder.Context) error {
		if c.Top() == 0 {
			return errors.New("需要参数")
		}
		n := c.Arg(1).String()  // 获取名字参数

		// 创建Person对象并推入栈
		c.Push().Data(&Person{n}, "person")
		return nil
	})

	// 动态绑定name方法
	t.Dynamic("name", func(c *binder.Context) error {
		// 获取Person对象
		p, ok := c.Arg(1).Data().(*Person)
		if !ok {
			return errors.New("需要person对象")
		}

		// 根据参数数量决定是获取还是设置name
		if c.Top() == 1 {
			c.Push().String(p.Name)  // 获取名字
		} else {
			p.Name = c.Arg(2).String()  // 设置名字
		}

		return nil
	})

	// 使用person表
	if err := b.DoString(`
		local p = person.new('Steeve')
		print(p:name())

		p:name('Alice')
		print(p:name())
	`); err != nil {
		log.Fatalln(err)
	}
}

选项配置

// Options 绑定器选项对象
type Options struct {
	// CallStackSize 调用栈大小
	CallStackSize int
	// RegistrySize 数据栈大小
	RegistrySize int
	// SkipOpenLibs 控制是否默认加载库
	SkipOpenLibs bool
	// IncludeGoStackTrace 是否在Lua堆栈跟踪中包含Go堆栈跟踪
	IncludeGoStackTrace bool
}

// 使用示例
b := binder.New(binder.Options{
	SkipOpenLibs: true,
})

错误处理

package main

import (
	"errors"
	"log"
	"os"

	"github.com/alexeyco/binder"
)

type Person struct {
	Name string
}

func main() {
	b := binder.New()
	
	// ... 其他代码 ...

	if err := b.DoString(`-- some string`); err != nil {
		switch err.(type) {
		case *binder.Error:
			e := err.(*binder.Error)
			e.Print()  // 打印详细错误信息

			os.Exit(0)
			break
		default:
			log.Fatalln(err)
		}
	}
}

注意事项

如果设置SkipOpenLibs为true，以下基础库仍会被加载：

• 所有基本函数
• table库
• package库

许可证

MIT许可证