跳到主要内容

从原生到 Electron 中的 JavaScript

·4 分钟阅读

Electron 中用 C++ 或 Objective-C 编写的功能如何到达 JavaScript,以便最终用户可以使用它们?


背景

Electron 是一个 JavaScript 平台,其主要目的是降低开发人员构建健壮桌面应用程序的门槛,而无需担心平台特定的实现。然而,Electron 本身的核心仍然需要用特定系统语言编写的平台特定功能。

实际上,Electron 会为您处理原生代码,因此您可以专注于单个 JavaScript API。

但这究竟是如何运作的呢?Electron 中用 C++ 或 Objective-C 编写的功能如何到达 JavaScript,以便最终用户可以使用它们?

要追溯这条路径,我们从 app 模块开始。

打开我们 lib/ 目录中的 app.ts 文件,您会在顶部找到以下代码行

const binding = process.electronBinding('app');

这一行直接指向 Electron 将其 C++/Objective-C 模块绑定到 JavaScript 以供开发人员使用的机制。此函数由 ElectronBindings 类的头文件和 实现文件创建。

process.electronBinding

这些文件添加了 process.electronBinding 函数,其行为类似于 Node.js 的 process.bindingprocess.binding 是 Node.js require() 方法的低层实现,不同之处在于它允许用户 require 原生代码而不是其他用 JS 编写的代码。这个自定义的 process.electronBinding 函数提供了从 Electron 加载原生代码的能力。

当一个顶级 JavaScript 模块(如 app)需要这段原生代码时,这段原生代码的状态是如何确定和设置的?哪些方法暴露给了 JavaScript?属性呢?

native_mate

目前,这个问题的答案可以在 native_mate 中找到:它是 Chromium gin的一个分支,旨在简化 C++ 和 JavaScript 之间类型的封送处理。

native_mate/native_mate 内部有一个 object_template_builder 的头文件和实现文件。这就是我们能够在原生代码中形成模块的原因,其形状符合 JavaScript 开发人员的预期。

mate::ObjectTemplateBuilder

如果我们将每个 Electron 模块视为一个 object,就更容易理解为什么我们要使用 object_template_builder 来构建它们。此类建立在 V8 公开的类之上,V8 是 Google 用 C++ 编写的开源高性能 JavaScript 和 WebAssembly 引擎。V8 实现了 JavaScript (ECMAScript) 规范,因此其原生功能实现可以直接与 JavaScript 中的实现相关联。例如,v8::ObjectTemplate 为我们提供了没有专用构造函数和原型的 JavaScript 对象。它使用 Object[.prototype],在 JavaScript 中相当于 Object.create()

要看实际操作,请查看 app 模块的实现文件 atom_api_app.cc。底部是以下内容

mate::ObjectTemplateBuilder(isolate, prototype->PrototypeTemplate())
.SetMethod("getGPUInfo", &App::GetGPUInfo)

在上面这行中,.SetMethodmate::ObjectTemplateBuilder 上被调用。.SetMethod 可以在 ObjectTemplateBuilder 类的任何实例上调用,以以下语法在 JavaScript 的 Object prototype 上设置方法

.SetMethod("method_name", &function_to_bind)

这相当于 JavaScript 中的

function App{}
App.prototype.getGPUInfo = function () {
// implementation here
}

这个类也包含在模块上设置属性的函数

.SetProperty("property_name", &getter_function_to_bind)

.SetProperty("property_name", &getter_function_to_bind, &setter_function_to_bind)

这些将依次是 Object.defineProperty 的 JavaScript 实现

function App {}
Object.defineProperty(App.prototype, 'myProperty', {
get() {
return _myProperty
}
})

function App {}
Object.defineProperty(App.prototype, 'myProperty', {
get() {
return _myProperty
}
set(newPropertyValue) {
_myProperty = newPropertyValue
}
})

现在可以创建带有原型和属性的 JavaScript 对象,使其符合开发人员的期望,并更清晰地理解在此较低系统级别实现的功能和属性!

关于在何处实现任何给定模块方法,这本身就是一个复杂且通常不确定的决策,我们将在未来的文章中介绍。