Go Scripts · 多语言嵌入式脚本引擎框架

项目亮点

什么是 Go Scripts?

脚本引擎

系统架构

接口架构

核心功能

引擎管理

脚本加载与执行

热更新

技术栈

项目结构

go-scripts/
├── engine.go # 能力接口 + Engine 聚合接口 + 辅助函数
├── factory.go # 工厂注册表
├── manager.go # 多引擎管理器
├── engine_pool.go # 固定大小引擎池
├── engine_pool_autogrow.go # 自动扩容引擎池
├── types.go # 类型常量定义
├── source/ # 脚本来源模块
│ ├── source.go # Reader / Watcher / ReadWatcher 接口
│ ├── file.go # 本地文件源
│ ├── fs.go # io/fs.FS 源 (embed / zip)
│ ├── memory.go # 内存源
│ ├── multiple.go # 多源聚合 (Fallback / FirstOK)
│ ├── transform.go # 解密/解压/过滤中间件
│ ├── cached.go # 缓存层 (TTL + Watch 自动失效)
│ ├── s3/ # Amazon S3 / 兼容对象存储
│ ├── etcd/ # etcd KV
│ ├── consul/ # Consul KV
│ ├── redis/ # Redis
│ ├── http/ # HTTP 远程拉取
│ ├── git/ # Git 仓库 (go-git/v6)
│ └── database/ # SQL 数据库 (database/sql)
├── lua/ # Lua 引擎 (gopher-lua)
├── javascript/ # JavaScript 引擎 (goja)
├── gpython/ # Python 引擎 (gpython)
├── yaegi/ # Go 引擎 (Yaegi)
├── wazero/ # WebAssembly 引擎 (wazero)
├── cel/ # CEL 表达式引擎 (cel-go)
├── expr/ # Expr 表达式引擎 (expr-lang)
├── starlark/ # Starlark 引擎 (starlark-go)
└── tcl/ # TCL 引擎 (modernc/tcl)

快速开始

安装

go get github.com/tx7do/go-scripts

基础用法

package main
import (
 "context"
 "fmt"
 "log"
 scriptEngine "github.com/tx7do/go-scripts"
 _ "github.com/tx7do/go-scripts/javascript" // 注册 JavaScript 引擎
)
func main() {
 // 1. 创建引擎实例
 eng, err := scriptEngine.NewScriptEngine(scriptEngine.JavaScriptType)
 if err != nil {
 log.Fatal(err)
 }
 defer eng.Close()
 // 2. 初始化
 ctx := context.Background()
 if err := eng.Init(ctx); err != nil {
 log.Fatal(err)
 }
 // 3. 注入宿主变量
 _ = eng.RegisterGlobal("name", "world")
 // 4. 注册宿主函数
 _ = eng.RegisterFunction("greet", func(name string) string {
 return fmt.Sprintf("Hello, %s!", name)
 })
 // 5. 执行脚本
 result, err := eng.ExecuteString(ctx, "hello.js", `greet(name)`)
 if err != nil {
 log.Fatal(err)
 }
 fmt.Println(result) // Hello, world!
}

引擎池(生产推荐)

// 固定大小引擎池(8 实例)
pool, err := scriptEngine.NewEnginePool(8, scriptEngine.LuaType)
// 或:自动扩容池(初始 2,上限 16)
pool, err := scriptEngine.NewAutoGrowEnginePool(2, 16, scriptEngine.LuaType)
if err != nil {
 log.Fatal(err)
}
defer pool.Close()
// 注入宿主函数(注:仅作用于被 Acquire 的实例)
_ = pool.RegisterFunction("calc", func(a, b int) int { return a + b })
// 执行脚本
result, _ := pool.ExecuteString(ctx, "calc.lua", `return calc(10, 20)`)

配合 ScriptSource

// 从本地文件加载
src := source.NewFileSource()
eng.SetSource(src)
// 从文件执行
result, _ := eng.ExecuteFromKey(ctx, "/path/to/script.lua")
// S3 + Memory Fallback
s3Src, _ := s3source.New(ctx, "my-bucket", s3source.WithRegion("us-east-1"))
memSrc := source.NewMemSource()
memSrc.Set("backup.lua", `print("fallback")`)
multi, _ := source.NewFallbackSource(s3Src, memSrc)
eng.SetSource(multi)

热更新

// 启动监听
if err := eng.StartWatch(ctx, "/path/to/script.lua"); err != nil {
 log.Fatal(err)
}
// 文件变更时自动重载,无需手动干预
// 停止监听
_ = eng.StopWatch("/path/to/script.lua")

测试

# 运行所有子模块测试
cd lua && go test -v ./...
cd javascript && go test -v ./...
cd cel && go test -v ./...
cd expr && go test -v ./...
cd starlark && go test -v ./...
cd gpython && go test -v ./...
cd yaegi && go test -v ./...
cd wazero && go test -v ./...
cd tcl && go test -v ./...

相关文档

脚本引擎

脚本来源

外部资源

License