README
¶
Yaegi Engine · Go 脚本引擎
基于 Traefik Yaegi 的原生 Go 脚本引擎
概述
Yaegi 引擎使用 Traefik Yaegi 库，为 Go 应用提供原生 Go 语言的运行时脚本执行能力。无需编译，直接解释执行 Go 源码，适用于动态插件、DevOps 工具链等场景。
引擎特性
| 特性 | 说明 |
|---|---|
| 底层库 | github.com/traefik/yaegi v0.16.1 |
| 语言版本 | Go 1.x |
| 宿主互操作 | 通过合成 host 包暴露全局变量和函数，脚本需 import "host" |
| 线程安全 | 双锁模式（RWMutex + execMutex） |
| 热更新 | 支持 StartWatch / StopWatch |
| 类型常量 | scriptEngine.YaegiType |
安装
go get github.com/tx7do/go-scripts/yaegi
快速开始
package main
import (
"context"
"fmt"
"log"
scriptEngine "github.com/tx7do/go-scripts"
_ "github.com/tx7do/go-scripts/yaegi" // 注册 Yaegi 引擎
)
func main() {
eng, err := scriptEngine.NewScriptEngine(scriptEngine.YaegiType)
if err != nil {
log.Fatal(err)
}
defer eng.Close()
ctx := context.Background()
eng.Init(ctx)
// 注册宿主函数（脚本通过 host.FuncName 调用）
_ = eng.RegisterFunction("greet", func(name string) string {
return fmt.Sprintf("Hello, %s!", name)
})
// 执行 Go 脚本（注意：需要 import "host"）
result, _ := eng.ExecuteString(ctx, "hello.go", `
import "host"
host.greet("world")
`)
fmt.Println(result) // Hello, world!
}
注意：Yaegi 引擎中，通过
RegisterGlobal/RegisterFunction注册的变量和函数被放在合成的host包中，脚本必须import "host"才能访问。
API 参考
| 方法 | 说明 |
|---|---|
Init(ctx) |
创建 Yaegi 解释器实例 |
Close() |
关闭解释器，释放资源 |
LoadString(ctx, name, code) |
将 Go 源码加入执行队列 |
Execute(ctx) |
顺序执行队列中所有脚本 |
ExecuteString(ctx, name, code) |
编译并立即执行内联 Go 代码 |
RegisterGlobal(name, value) |
在 host 包中注册全局变量 |
RegisterFunction(name, fn) |
在 host 包中注册 Go 函数 |
CallFunction(ctx, name, args...) |
调用已注册的函数 |
RegisterModule(name, module) |
注册自定义包供脚本 import |
StartWatch(ctx, key) |
启动脚本热更新监听 |
StopWatch(key) |
停止热更新监听 |
测试
cd yaegi && go test -v ./...
相关文档
License
Documentation
¶
Overview ¶
Package yaegi provides a script engine implementation using the Yaegi Go interpreter (https://github.com/traefik/yaegi). It allows executing Go source code as scripts at runtime without compilation.
Construction:
eng, err := yaegi.New(ctx)
eng.Init(ctx)
eng.LoadString(ctx, "hello", `fmt.Println("hello world")`)
result, err := eng.Execute(ctx)
The engine supports hot-reload via StartWatch/StopWatch when the bound Source implements the Watcher interface.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrYaegiEngineNotInitialized is returned when an operation is invoked // before Init or after Close. ErrYaegiEngineNotInitialized = errors.New("yaegi engine not initialized") // ErrYaegiEngineAlreadyInitialized is returned when Init is called on an // already-initialized engine. ErrYaegiEngineAlreadyInitialized = errors.New("yaegi engine already initialized") // ErrYaegiInterpreterNotInitialized is returned when the underlying yaegi // interpreter is nil. ErrYaegiInterpreterNotInitialized = errors.New("yaegi interpreter not initialized") // ErrYaegiEvalFailed is returned when evaluating a script fails. ErrYaegiEvalFailed = errors.New("yaegi eval failed") // ErrYaegiNoScriptLoaded is returned when Execute is called but no script // has been loaded yet. ErrYaegiNoScriptLoaded = errors.New("yaegi no script loaded") // ErrYaegiFunctionNotFound is returned when CallFunction cannot find the // named function in the interpreter. ErrYaegiFunctionNotFound = errors.New("yaegi function not found") )
Sentinel errors returned by the Yaegi engine.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.