Go语言 JavaScript运行库 goja

Golang 中如何运行 Javascript 呢？github.com/dop251/goja  就是个不错的选择。以太坊软件 geth 就使用了 goja 用于解析和运行 javascript 脚本命令。

我们以 Hello world 为例，演示 goja 的使用方法。

1. goja 范例

package main
import (
 "fmt"
 js "github.com/dop251/goja"
)

func main() {
  vm := js.New() // 创建engine实例
  r, _ := vm.RunString(`
    1 + 1
 `) // 执行javascript代码
  v, _ : = r.Export().(int64) // 将执行的结果转换为Golang对应的类型
  fmt.Println(r)
}

这个例子展示了最基本的能力，给定一段Javascript的代码文本，它能执行得到一个结果，并且能得到执行结果的宿主语言的表示形式。

2. 交互

Javascript和Golang之间的交互分成两个方面：Golang向Javascript引擎中注入一些上下文，例如注册一些全局函数供Javascript使用，创建一个对象等；Golang从Javascript引擎中读取一些上下文，例如一个计算过程的计算结果。先看第一类。

常用的手段是，通过Runtime类型提供的Set方法在全局注册一个变量，例如：

rts := js.New()
o := rts.NewObject()
o.Set("x", 2)
rts.Set("o", o)
rts.RunString(`o.x+o.x`) // 4

切换到 Golang 的视角，是个很自然的过程，想要创建一个对象，需要在 Golang 中先创建一个对应的表述，然后在 Javascript 中才能使用。对于更复杂的对象，嵌套就好了。 定义函数则有所不同，不同之处在于 Javascript 中的函数在 Golang 中的表示和其它类型的值不太一样，Golang 中表式 Javascript 中的函数的签名为：func (js.FunctionCall) js.Value，js.FunctionCall 中包含了调用函数的上下文信息，基于此我们可以尝试给 Javascript 增加一个 console.log 的能力：

...
func log(call js.FunctionCall) js.Value {
  str := call.Argument(0)
  fmt.Print(str.String())
  return str
}
...
rts := js.New()
console := rts.NewObject()
console.Set("log", log)
rts.Set("console", console)
rts.RunString(`console.log('hello world')`) // hello world

相较于向Javascript引擎中注入一些信息，从中读取信息则比较简单，前面的hello world中展示了一种方法，执行一段Javascript代码，然后得到一个结果。但是这种方法不够灵活，如果想要精确的得到某个上下文，变量的值，就不那么方便。为此，goja提供了Get方法，Runtime类型的Get方法可以从Runtime中读取某个变量的信息，Object类型的Get方法则可以从对象中读取某个字段的值。签名如下：func (r *Runtime) Get(name string) Value，func (o *Object) Get(name string) Value。但是得到的值的类型都是Value类型，想要转换成对应的类型，需要通过一些方法来转换，这里就不再赘述，有兴趣可以去看它的文档。

3. 复杂范例

goja值提供了基本的解析执行Javascript代码的能力，但是我们常见的宿主提供的能力，需要在使用的过程中自己去补充。下面就基于上面的技巧，提供一个简单的require加载本地Javascript代码的能力。 通过require加载一段Commjs格式Javascript代码，直观的流程：根据文件名，读取文本，组装成一个立即执行函数，执行，然后返回module对象，但是中间可以做一些小优化，比如已经被加载过的代码， 就不重新加载，执行，只是返回就好了。

大概的实现如下：

package core

import (
  "io/ioutil"
  "path/filepath"

  js "github.com/dop251/goja"
)

func moduleTemplate(c string) string {
  return "(function(module, exports) {" + c + "\n})"
}

func createModule(c *Core) *js.Object {
  r := c.GetRts()
  m := r.NewObject()
  e := r.NewObject()
  m.Set("exports", e)

  return m
}

func compileModule(p string) *js.Program {
  code, _ := ioutil.ReadFile(p)
  text := moduleTemplate(string(code))
  prg, _ := js.Compile(p, text, false)

  return prg
}

func loadModule(c *Core, p string) js.Value {
  p = filepath.Clean(p)
  pkg := c.Pkg[p]
  if pkg != nil {
    return pkg
  }

  prg := compileModule(p)

  r := c.GetRts()
  f, _ := r.RunProgram(prg)
  g, _ := js.AssertFunction(f)

  m := createModule(c)
  jsExports := m.Get("exports")
  g(jsExports, m, jsExports)

  return m.Get("exports")
}

要想让引擎能使用这个能力，就需要将require这个函数注册到Runtime中：

// RegisterLoader register a simple commonjs style loader to runtime
func RegisterLoader(c *Core) {
  r := c.GetRts()

  r.Set("require", func(call js.FunctionCall) js.Value {
    p := call.Argument(0).String()
    return loadModule(c, p)
  })
}

4. 导出函数

我们可以使用 goja 导出 javascript 中的函数，提供给 go 语言代码使用。

package main
import (
 "fmt"
  js "github.com/dop251/goja"
)

func main() {
	vm := js.New()
	
	var fn func(int32) int32
	err = vm.ExportTo(vm.Get("fib"), &fn)
	if err != nil {
		fmt.Println("Js函数映射到 Go 函数失败！")
		return
	}
	fmt.Println("斐波那契数列第30项的值为：", fn(4))
}