使用gopher-lua实现Golang中的Lua 5.1虚拟机

gopher-lua是一个纯Go实现的Lua 5.1虚拟机，它允许在Go应用程序中嵌入Lua脚本功能。下面我将详细介绍如何使用这个库。

基本安装

首先安装gopher-lua：

go get github.com/yuin/gopher-lua

基本用法示例

package main

import (
	"fmt"
	"github.com/yuin/gopher-lua"
)

func main() {
	// 创建新的Lua虚拟机
	L := lua.NewState()
	defer L.Close() // 确保虚拟机被关闭

	// 执行简单的Lua代码
	if err := L.DoString(`print("Hello from Lua!")`); err != nil {
		panic(err)
	}

	// 更复杂的示例
	script := `
		function add(a, b)
			return a + b
		end
		
		result = add(10, 20)
		print("The result is: "..result)
	`

	if err := L.DoString(script); err != nil {
		panic(err)
	}

	// 从Go中获取Lua变量
	lv := L.GetGlobal("result")
	if lv.Type() != lua.LTNumber {
		panic("result is not a number")
	}
	if v, ok := lv.(lua.LNumber); ok {
		fmt.Printf("Result from Go: %.0f\n", v)
	}
}

Go与Lua交互

从Go调用Lua函数

func main() {
	L := lua.NewState()
	defer L.Close()

	script := `
		function greet(name)
			return "Hello, " .. name
		end
	`

	if err := L.DoString(script); err != nil {
		panic(err)
	}

	// 调用Lua函数
	if err := L.CallByParam(lua.P{
		Fn:      L.GetGlobal("greet"), // 获取函数
		NRet:    1,                    // 指定返回值数量
		Protect: true,                 // 如果为true，调用在panic时会被恢复
	}, lua.LString("Gopher")); err != nil {
		panic(err)
	}

	// 获取返回值
	ret := L.Get(-1)
	L.Pop(1) // 从栈中移除返回值
	fmt.Println(ret.String())
}

从Lua调用Go函数

func main() {
	L := lua.NewState()
	defer L.Close()

	// 注册Go函数到Lua
	L.SetGlobal("add", L.NewFunction(func(L *lua.LState) int {
		a := L.ToInt(1) // 获取第一个参数
		b := L.ToInt(2) // 获取第二个参数
		L.Push(lua.LNumber(a + b)) // 压入返回值
		return 1 // 返回值的数量
	}))

	// 在Lua中调用Go函数
	if err := L.DoString(`
		local result = add(10, 20)
		print("10 + 20 = " .. result)
	`); err != nil {
		panic(err)
	}
}

加载Lua模块

gopher-lua支持加载预编译的Lua模块：

func main() {
	L := lua.NewState()
	defer L.Close()

	// 预加载模块
	L.PreloadModule("mymodule", func(L *lua.LState) int {
		mod := L.SetFuncs(L.NewTable(), map[string]lua.LGFunction{
			"hello": func(L *lua.LState) int {
				L.Push(lua.LString("Hello from module!"))
				return 1
			},
		})
		L.Push(mod)
		return 1
	})

	// 在Lua中使用模块
	if err := L.DoString(`
		local m = require("mymodule")
		print(m.hello())
	`); err != nil {
		panic(err)
	}
}

性能考虑

1. 复用Lua虚拟机：创建和销毁Lua虚拟机开销较大，应该尽可能复用
2. 预编译脚本：对于频繁执行的脚本，可以预编译
3. 限制执行时间：对于不可信脚本，应该设置执行超时

func main() {
	L := lua.NewState()
	defer L.Close()

	// 预编译脚本
	chunk, err := L.LoadString(`return 1 + 1`)
	if err != nil {
		panic(err)
	}

	// 多次执行预编译的脚本
	for i := 0; i < 5; i++ {
		L.Push(chunk)
		if err := L.PCall(0, 1, nil); err != nil {
			panic(err)
		}
		ret := L.Get(-1)
		L.Pop(1)
		fmt.Println(ret)
	}
}

错误处理

func main() {
	L := lua.NewState()
	defer L.Close()

	// 设置错误处理函数
	L.SetGlobal("error_handler", L.NewFunction(func(L *lua.LState) int {
		err := L.ToString(1)
		fmt.Printf("Lua error: %s\n", err)
		return 0
	}))

	// 在Lua中使用pcall捕获错误
	if err := L.DoString(`
		function risky()
			error("something went wrong")
		end
		
		local ok, err = pcall(risky)
		if not ok then
			error_handler(err)
		end
	`); err != nil {
		panic(err)
	}
}

实际应用场景

gopher-lua适用于：

• 游戏脚本系统
• 业务规则引擎
• 动态配置系统
• 插件系统

通过gopher-lua，你可以轻松地在Go应用中嵌入Lua脚本功能，实现高度灵活的配置和扩展能力。