Js Engine V8 Embedding - C++ 变量暴露给 Javascript 环境

目标

上一篇通过 Hello World 示例了解了 v8 的核心概念和基本使用方式,这篇中我们要将 C++ 环境中的对象暴露到 Javascript 环境中,即在 Javascript 代码中可以使用在 C++ 环境中的数据。

代码 & 说明

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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
// expose-var.cpp
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "include/libplatform/libplatform.h"
#include "include/v8.h"

using namespace v8;

int main(int argc, char* argv[]) {
// 初始化 V8
V8::InitializeICUDefaultLocation(argv[0]);
V8::InitializeExternalStartupData(argv[0]);
std::unique_ptr<Platform> platform = platform::NewDefaultPlatform();
V8::InitializePlatform(platform.get());
V8::Initialize();

// 创建 Isolate 实例
Isolate::CreateParams create_params;
create_params.array_buffer_allocator =
ArrayBuffer::Allocator::NewDefaultAllocator();
Isolate* isolate = Isolate::New(create_params);
{
// 使 `isolate` 成为当前 Isolate
Isolate::Scope isolate_scope(isolate);

// 创建一个 HandleScope,用于管理 Handle 的生命周期
HandleScope handle_scope(isolate);

// 定义三个 v8 变量
Local<String> myname = String::NewFromUtf8(isolate, "Maslow");
Local<String> myblog = String::NewFromUtf8(isolate, "https://laogen.site");
Local<Number> myage = Number::New(isolate, 25);

// 创建一个 v8 对象模板 `author`,将上面的三个变量设为 `author` 的属性
Local<ObjectTemplate> author = ObjectTemplate::New(isolate);
author->Set(String::NewFromUtf8(isolate, "name"), myname);
author->Set(String::NewFromUtf8(isolate, "age"), myage);
author->Set(String::NewFromUtf8(isolate, "blog"), myblog);

// 创建一个 v8 对象模板 `global_template`,将上面的 `author` 设为其属性
Local<ObjectTemplate> global_template = ObjectTemplate::New(isolate);
global_template->Set(String::NewFromUtf8(isolate, "author"), author);

// 创建 v8 Context,将 `global_template` 做为它的 global 对象模板
Local<Context> context = Context::New(isolate, NULL, global_template);

// 进入 or 使用 context
Context::Scope context_scope(context);

{
// 在 js 代码中就可以直接访问 global 中的对象了
const char* js_code =
"`My Info: ${author.name}, ${author.age} years old, visit ${author.blog}`";

Local<String> source = String::NewFromUtf8(isolate, js_code);

// 编译 JS 代码
Local<Script> script = Script::Compile(context, source).ToLocalChecked();

// 运行 JS 代码,并获取结果
Local<Value> result = script->Run(context).ToLocalChecked();

// 将运行结果转换为 UTF8 字符串,并打印
String::Utf8Value utf8(isolate, result);
printf("%s\n", *utf8);
}
}

// 释放 V8 相关资源
isolate->Dispose();
V8::Dispose();
V8::ShutdownPlatform();
delete create_params.array_buffer_allocator;
return 0;
}

在我们创建一个 Context 对象时,可以指定一个 ObjectTemplate 做为它的全局对象模板( Global ObjectTemplate ),我们只需要将 C++ 的变量挂(设置)到 Global ObjectTemplate 上,在 js 环境中就可以全局访问它们。

比如,浏览器中的 window document 等对象就是以这种方式提供给 js 执行环境的。

ObjectTemplate 与 Object 的区别

在 v8 中,一个 Object 对象代表一个 js 对象;
ObjectTemplate 对象,官方文档说它是 Object 对象的 “Blueprint”,简单的说,ObjectTemplateObject 对象的 “定义”,可以用它来生成相应的 Object

Gobal ObjectTemplate

1
Local<ObjectTemplate> global_template = ObjectTemplate::New(isolate);

这个 global_template 就是一个 ObjectTemplatecontext 根据这它来生成 Global 对象,而 Global 对象里面的属性,我们在 js 环境中是可以全局访问的。

相关链接