Golang实现ECMAScript 5.1+解释器的JavaScript引擎插件库goja的使用

简介

goja是一个用纯Go语言实现的ECMAScript 5.1(+)解释器，重点在于标准合规性和性能。这个项目很大程度上受到了otto的启发。

最低要求的Go版本是1.20。

特性

• 完整的ECMAScript 5.1支持（包括正则表达式和严格模式）
• 通过了几乎所有tc39测试（针对目前已实现的功能）
• 能够运行Babel、Typescript编译器以及几乎所有用ES5编写的代码
• 支持Sourcemaps
• 大部分ES6功能（仍在开发中）

基本示例

运行JavaScript并获取结果值：

vm := goja.New()
v, err := vm.RunString("2 + 2")
if err != nil {
    panic(err)
}
if num := v.Export().(int64); num != 4 {
    panic(num)
}

传递值到JavaScript

任何Go值都可以使用Runtime.ToValue()方法传递给JS：

vm := goja.New()
vm.Set("myVar", 42)
res, _ := vm.RunString("myVar + 8")
fmt.Println(res.Export()) // 输出: 50

从JS导出值

JS值可以使用Value.Export()方法导出为其默认的Go表示形式，或者使用Runtime.ExportTo()方法导出到特定的Go变量。

从Go调用JS函数

有两种方法：

1. 使用AssertFunction()：

const SCRIPT = `
function sum(a, b) {
    return +a + b;
}
`

vm := goja.New()
_, err := vm.RunString(SCRIPT)
if err != nil {
    panic(err)
}
sum, ok := goja.AssertFunction(vm.Get("sum"))
if !ok {
    panic("Not a function")
}

res, err := sum(goja.Undefined(), vm.ToValue(40), vm.ToValue(2))
if err != nil {
    panic(err)
}
fmt.Println(res)
// 输出: 42

1. 使用Runtime.ExportTo()：

const SCRIPT = `
function sum(a, b) {
    return +a + b;
}
`

vm := goja.New()
_, err := vm.RunString(SCRIPT)
if err != nil {
    panic(err)
}

var sum func(int, int) int
err = vm.ExportTo(vm.Get("sum"), &sum)
if err != nil {
    panic(err)
}

fmt.Println(sum(40, 2)) // 注意：函数中的_this_值将是undefined
// 输出: 42

映射结构体字段和方法名

默认情况下，名称按原样传递（即大写）。要匹配标准的JavaScript命名约定，可以使用FieldNameMapper：

vm := goja.New()
vm.SetFieldNameMapper(TagFieldNameMapper("json", true))
type S struct {
    Field int `json:"field"`
}
vm.Set("s", S{Field: 42})
res, _ := vm.RunString(`s.field`) // 没有映射器的话会是s.Field
fmt.Println(res.Export())
// 输出: 42

异常处理

任何在JavaScript中抛出的异常都会作为*Exception类型的错误返回：

vm := goja.New()
_, err := vm.RunString(`

throw("Test");

`)

if jserr, ok := err.(*Exception); ok {
    if jserr.Value().Export() != "Test" {
        panic("wrong value")
    }
} else {
    panic("wrong type")
}

中断执行

func TestInterrupt(t *testing.T) {
    const SCRIPT = `
    var i = 0;
    for (;;) {
        i++;
    }
    `

    vm := goja.New()
    time.AfterFunc(200 * time.Millisecond, func() {
        vm.Interrupt("halt")
    })

    _, err := vm.RunString(SCRIPT)
    if err == nil {
        t.Fatal("Err is nil")
    }
    // err是*InterruptError类型，其Value()方法返回传递给vm.Interrupt()的任何内容
}

完整示例

下面是一个完整的示例，展示了如何初始化goja引擎、执行脚本并与Go代码交互：

package main

import (
	"fmt"
	"github.com/dop251/goja"
)

func main() {
	// 创建新的VM实例
	vm := goja.New()

	// 定义一个JavaScript函数
	script := `
	function greet(name) {
		return "Hello, " + name + "!";
	}

	function add(a, b) {
		return a + b;
	}
	`

	// 执行脚本
	_, err := vm.RunString(script)
	if err != nil {
		panic(err)
	}

	// 调用JavaScript中的greet函数
	greet, ok := goja.AssertFunction(vm.Get("greet"))
	if !ok {
		panic("greet is not a function")
	}

	res, err := greet(goja.Undefined(), vm.ToValue("World"))
	if err != nil {
		panic(err)
	}
	fmt.Println(res) // 输出: Hello, World!

	// 使用ExportTo调用add函数
	var addFunc func(int, int) int
	err = vm.ExportTo(vm.Get("add"), &addFunc)
	if err != nil {
		panic(err)
	}

	sum := addFunc(20, 22)
	fmt.Println(sum) // 输出: 42

	// 从Go传递对象到JavaScript
	type Person struct {
		Name string `json:"name"`
		Age  int    `json:"age"`
	}

	vm.SetFieldNameMapper(goja.TagFieldNameMapper("json", true))
	vm.Set("person", Person{Name: "Alice", Age: 30})
	
	val, err := vm.RunString(`
		"Name: " + person.name + ", Age: " + person.age
	`)
	if err != nil {
		panic(err)
	}
	fmt.Println(val) // 输出: Name: Alice, Age: 30
}

这个示例展示了goja的基本用法，包括执行脚本、调用JS函数、在Go和JS之间传递数据等核心功能。