ScriptX – 全能的脚本引擎抽象层开源

2021-03-25 09:40:04 浏览数 (1)

ScriptX是一个脚本引擎抽象层。对下封装多种脚本引擎，对上暴露统一的API，使得上层调用者可以完全隔离底层的引擎实现(后端)。

ScriptX不仅隔离了几种JavaScript引擎，甚至可以隔离不同脚本语言，使得上层在无需改变代码的前提下无缝切换脚本引擎和脚本语言。

ScriptX的术语中，"前端"指对外的C API，"后端"则指不同的底层引擎，目前已经实现的后端有：V8, node.js,JavaScriptCore, WebAssembly, Lua.

简介

ScriptX 的接口使用现代C 特性。并且做到100%符合C 标准，完全跨平台。

所有API以ScriptX.h聚合头文件暴露出来。

设计目标： 多语言 | 多引擎实现 | 高性能 | API易用 | 跨平台

特性介绍

1. 支持多种引擎，多脚本语言

ScriptX设计之初就目标为支持多种脚本语言，并在JavaScript上实现了V8和JavaScriptCore的引擎封装。后续为了验证ScriptX的多语言设计，实现了完整的Lua绑定。目前针对WebAssembly的支持也已经完成。

2. 现代的 C API

API设计上符合现代 C 风格，如：

  1. 三种引用类型Local/Global/Weak，使用copy, move语义实现自动的内存管理（自动引用计数）
  2. 使用variadic template 支持非常方便的 Function::call 语法
  3. 使用Template Meta-Programing 实现直接绑定C 函数

现代语言特性，引用空指针安全（nullibility safety 请参考kotlin的概念）。

注：ScriptX要求C 17（或1z）以上的编译器支持，并需要打开异常特性，（可以关闭RTTI特性）。

3. 高性能

高性能是ScriptX设计上的重要指标。在实现过程中也充分体现了 Zero-Overhead 的C 思想。并在增加功能特性的时候通过相关的性能测试。

测试指标：单次JS到C 函数调用耗时，微秒

测试环境：iMac i9-9900k 32G RAM@macOS 10.15

性能测试表示，在Release模式下，ScriptX可以达到几乎和原生绑定相同的性能。（由于ScriptX使用大量模板，请勿在Debug版进行性能测试） 

4. 支持异常处理

ScriptX通过一系列的技术手段实现了脚本的异常和C 异常相互打通的能力。在调用引擎API时无需判断返回值，可以使用异常统一处理，避免crash。

5. 易用的API

易用的API => 开心的工程师=> 高效 => 高质量

ScriptX 设计的时候充分考虑到API的易用性，包括操作友好简单，不易出错，错误信息明显，便于定位问题等。

6. 简单高效的绑定API

当app作为宿主使用脚本引擎时，通常都是需要注入大量native 绑定的函数/类来为脚本逻辑提供能力。ScriptX 设计的ClassDeifine相关绑定API简单易用，并且可以支持直接绑定C 函数，极大的提升工作效率。

7. 可以与原生引擎API互操作

ScriptX在提供引擎封装的同时，也提供了一套工具方法实现原生类型和ScriptX类型的相互转换。

代码印象

我们通过一段比较完整的代码来对ScriptX留下一个整体印象。

代码语言：javascript复制
EngineScope enter(engine);try {  engine->eval("function fibo(x) { if (x<=2 ) return 1; else return fibo(x-1)   fibo(x-2) }");  Local<Function> fibo = engine->get("fibo").asFunction();  Local<Value> ret = fibo.call({}, 10);  ret.asNumber().toInt32() == 55;
  auto log = Function::newFunction(      [](const std::string& msg) {        std::cerr << "[log]: " << msg << std::endl;      });  // or use: Function::newFunction(std::puts);  engine->set("log", log);  engine->eval("log('hello world');");
  auto json = engine->eval(R"( JSON.parse('{"length":1,"info":{"version": "1.18","time":132}}'); )")                  .asObject();  json.get("length").asNumber().toInt32() == 1;
  auto info = json.get("info").asObject();  info.get("version").asString().toString() ==  "1.18";  info.get("time").asNumber().toInt32() == 132;
  Local<Object> bind = engine->eval("...").asObject();  MyBind* ptr = engine->getNativeInstance<MyBind>(bind);  ptr->callCppFunction();
} catch (Exception& e) {  FAIL() << e.message() << e.stacktrace();  // or FAIL() << e;}
  1. 使用 EngineScope 进入引擎环境
  2. 绝大多是API可以接受C 原生类型作为参数，内部自动转换类型
  3. 可以从C/C 函数直接创建脚本函数（native     绑定）
  4. 支持脚本的异常处理
  5. API强类型 

代码质量

代码质量高标准要求

  1. 上百个测试用例，单测覆盖率达87%
  2. 圈复杂度仅1.18。
  3. 借助clang-format保证代码格式统一。
  4. 使用clang-tidy发现潜在问题。
  5. 在clang和MSVC编译器上都打开了"warning as error"级别的错误信息。

https://github.com/Tencent/ScriptX

（点击文末阅读原文直接访问）

请给项目 一个 Star !

欢迎提出你的 issue 和 PR！

国内镜像地址：

https://git.code.tencent.com/Tencent_Open_Source/ScriptX

（登录后才能访问公开项目）

腾讯工蜂源码系统为开源开发者提供完整、最新的腾讯开源项目国内镜像

api c++ 性能测试 腾讯云测试服务

0 人点赞