前言

最近需要在 Golang 里嵌入一个脚本语言，现在对于 Golang 来说比较成熟的有 python, javascript, lua 的第三方作为内嵌脚本执行引擎。

其中我使用了 starlark 主要是大部分兼容 python 语法，并且比起其他的脚本实现它实际上是没有 vm 的更加的轻量。

一、最小化运行

1

go get -u -v go.starlark.net/starlark

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

package main

import (
    "log"

	"go.starlark.net/starlark"
)

func main() {
    thread := &starlark.Thread{
		Name: "starlark",
		Print: func(_ *starlark.Thread, msg string) {
            // starlark.Thread 是执行栈
			log.Println(msg)
		},
    }
    g, err := starlark.ExecFile(thread, "", `
print("hello starlark!")
    `, nil)
    if err != nil {
        log.Fatalln(err)
    }
    // g 是脚本的全局对象字典
    log.Println(g)
}

二、load 和 print 设置

我们查看 starlark.Thread 结构发现有三个字段 Name string, Print func(thread *Thread, msg string), func(thread *Thread, module string) (StringDict, error) 可以设置

  1. Name 没啥特别的意义就是命名。
  2. Print 设置 starlark 脚本里的 print 函数调用。
  3. Load 可以用来做额外的模块脚本加载，个人觉的没啥用，作为一个嵌入脚本，直接把需要的模块全部手动注入了就好了。

三、module 注入

在 starlark.ExecFile 方法会发现最后有一个 predeclared StringDict 参数，这个就是后面需要执行的脚本里注入的全局模块函数还有变量。

不得不说官方文档不知道为啥不写一个 starlarkstruct.Module 注入教程，找了一下手动的声明就可以了。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

package main

import (
    "log"

    "go.starlark.net/starlark"
    "go.starlark.net/starlarkstruct"
)

func Test(
	_ *starlark.Thread,
	_ *starlark.Builtin,
	_ starlark.Tuple,
	_ []starlark.Tuple,
) (starlark.Value, error) {
    log.Println("Test")
    return starlark.None, nil
}

func main() {
    thread := &starlark.Thread{
		Name: "starlark",
		Print: func(_ *starlark.Thread, msg string) {
            // starlark.Thread 是执行栈
			log.Println(msg)
		},
    }
    // 手动构建 starlarkstruct.Module 即可
    ctxModule := &starlarkstruct.Module{
		Name: "ctx",
		Members: starlark.StringDict{
			"test": starlark.NewBuiltin("test", Test),
		},
    }
    predeclared := starlark.StringDict{
        "ctx": ctxModule,
    }
    g, err := starlark.ExecFile(thread, "", `
ctx.test()
    `, predeclared)
    if err != nil {
        log.Fatalln(err)
    }
    // g 是脚本的全局对象字典
    log.Println(g)
}

四、回调支持

starlark 支持将函数传递到函数作为变量，所以不论是在 starlark 中回调 go 函数，还是在 go 中回调 starlark 的函数都是能够做到的。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

package main

import (
    "log"

    "go.starlark.net/starlark"
)

func main(){
    thread := &starlark.Thread{
		Name: "starlark",
		Print: func(_ *starlark.Thread, msg string) {
            // starlark.Thread 是执行栈
			log.Println(msg)
		},
    }
    g, err := starlark.ExecFile(thread, "", `
def call(msg):
    print(msg)
    `, nil)
    if err != nil {
        log.Fatalln(err)
    }
    // g 是脚本的全局对象字典
    _, err = starlark.Call(thread, g["call"], []starlark.Value{starlark.String("call ok")}, nil)
    if err != nil {
        log.Fatalln(err)
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

package main

import (
	"log"

	"go.starlark.net/starlark"
)

func Test(
	_ *starlark.Thread,
	_ *starlark.Builtin,
	args starlark.Tuple,
	_ []starlark.Tuple,
) (starlark.Value, error) {
	log.Println(args[0].(starlark.String).GoString())
	return starlark.None, nil
}

func main(){
	thread := &starlark.Thread{
		Name: "starlark",
		Print: func(_ *starlark.Thread, msg string) {
			// starlark.Thread 是执行栈
			log.Println(msg)
		},
	}
	g, err := starlark.ExecFile(thread, "", `
def deep_call(call):
    call("call go")
    `, nil)
	if err != nil {
		log.Fatalln(err)
	}
	// g 是脚本的全局对象字典
	_, err = starlark.Call(thread, g["deep_call"], []starlark.Value{starlark.NewBuiltin("", Test)}, nil)
	if err != nil {
		log.Fatalln(err)
	}
}

五、抛出错误支持

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

package main

import (
	"log"

	"go.starlark.net/starlark"
)

func error_(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
	if len(args) != 1 {
		return nil, fmt.Errorf("error: got %d arguments, want 1", len(args))
	}
	buf := new(strings.Builder)
	stk := thread.CallStack()
	stk.Pop()
	_, _ = fmt.Fprintf(buf, "%sError: ", stk)
	if s, ok := starlark.AsString(args[0]); ok {
		buf.WriteString(s)
	} else {
		buf.WriteString(args[0].String())
	}
	return starlark.None, fmt.Errorf(buf.String())
}


func main() {
    thread := &starlark.Thread{
		Name: "starlark",
		Print: func(_ *starlark.Thread, msg string) {
			// starlark.Thread 是执行栈
			log.Println(msg)
		},
	}
    predeclared := starlark.StringDict{
		"error": starlark.NewBuiltin("error", error_),
    }
	_, err := starlark.ExecFile(thread, "", `
def main():
    error("1")
main()
    `, predeclared)
	if err != nil {
		log.Fatalln(err)
	}
}

六、第三方模块

starlark 对于正常用户可能会缺失一些需要的库，现在我见到的第三方库里比较完善的还是 starlib 里面有很多 json, base64, http, hash 之类的库。

七、一些注意事项

  1. 没有很多语法，例如异常相关 try, except, finally, raise。
  2. 没有 class, dict 没有 has_key 可以去官方的 spec 里查看。

参考