如何快速在QuickJS中实现原生类:Opaque与ClassID的Point类案例精讲

发布时间:2026/8/22 14:36:25
如何快速在QuickJS中实现原生类:Opaque与ClassID的Point类案例精讲 如何快速在QuickJS中实现原生类Opaque与ClassID的Point类案例精讲【免费下载链接】QuickJSQuickJS is a small and embeddable Javascript engine. QuickJS sources are copyright Fabrice Bellard and Charlie Gordon.项目地址: https://gitcode.com/gh_mirrors/quick/QuickJSQuickJS 是一个小巧、可嵌入的 JavaScript 引擎支持用 C 语言扩展原生类。本文以仓库自带的 Point 类为例讲透 Opaque 数据与 ClassID 两大核心机制带你一步步看懂 QuickJS 原生类的完整实现流程。 先搞懂Opaque 与 ClassID 两个核心概念在看代码之前先理解支撑 QuickJS 原生类的两个机制概念作用常用 APIOpaque 数据把 C 结构体挂在 JS 对象上供原生方法读写JS_SetOpaque()/JS_GetOpaque2()ClassID 类标识全局唯一的类编号标识 Opaque 的数据类型并绑定 finalizerJS_NewClassID()/JS_NewClass()一句话总结ClassID 告诉引擎这个对象携带的是哪一类 C 数据Opaque 就是被挂载的 C 数据本身。对象被垃圾回收销毁时引擎会自动调用该类注册的 finalizer 释放内存。官方文档在doc/quickjs.texi的 JS Classes 一节约 L878–L900对此有完整说明。 案例拆解Point 类的 4 步实现示例源码位于examples/point.c它定义了一个二维坐标点类并以原生 ES 模块的形式暴露给 JavaScript。第 1 步定义 C 数据结构与 ClassIDtypedef struct { int x; int y; } JSPointData; static JSClassID js_point_class_id;数据结构只有两个整数ClassID 声明为静态全局变量留给模块初始化时分配examples/point.c第 31–36 行。第 2 步编写构造函数构造函数examples/point.c第 45–75 行只做三件事用js_mallocz()分配JSPointData并把参数解析为 x、y从new_target取prototype调用JS_NewObjectProtoClass()创建对象——这一步是未来 JS 端extends继承能正常工作的关键用JS_SetOpaque()把 C 数据挂到对象上返回该对象。任何一步失败都会走fail分支释放内存并返回JS_EXCEPTIONJS 侧因此能收到正常的异常。第 3 步定义属性与原型方法属性访问x和y使用JS_CGETSET_MAGIC_DEF宏定义 getter/setter第 77–101 行。两个属性共用同一对函数靠 magic 值 0/1 区分——非常省代码的惯用法原型方法norm()方法调用sqrt()计算点到原点的模长实现仅几行。注意所有访问器都先用JS_GetOpaque2()取数据并检查是否为 NULL防止访问未正确构造或已销毁的对象。第 4 步注册类并导出模块js_point_init()第 123–141 行的注册流程是固定四步建议直接记住这个骨架JS_NewClassID(js_point_class_id); // 1. 申请类ID JS_NewClass(JS_GetRuntime(ctx), js_point_class_id, js_point_class); // 2. 注册类定义含 finalizer JS_SetConstructor(ctx, point_class, point_proto); // 3. 关联构造函数与 prototype JS_SetClassProto(ctx, js_point_class_id, point_proto); // 4. 设置类的原型最后用JS_SetModuleExport()把 Point 导出为 ES 模块的导出项模块入口是第 143 行起的js_init_module()。 在 JavaScript 中使用与继承使用示例在examples/test_point.js。对 JS 开发者来说Point用起来和纯 JS 类没有任何区别const pt new Point(2, 3); pt.x 4; // setter 生效 pt.norm(); // 得到 5 class ColorPoint extends Point { ... } // 甚至可以直接继承示例中的ColorPoint第 13–21 行直接extends Point新增了一个color属性。之所以继承能正常工作正是构造函数里用new_target取原型这一步的功劳。 快速上手构建与运行git clone https://gitcode.com/gh_mirrors/quick/QuickJS cd QuickJS make ./qjs examples/test_point.jsMakefile第 158 行已把examples/point.so加入自动构建列表make test测试目标第 398 行也会实际运行这份 Point 示例。⚠️ 新手常见坑与最佳实践忘记检查 Opaque 是否为 NULL对象构造失败或已被回收时JS_GetOpaque2()返回 NULL必须立刻返回JS_EXCEPTION构造函数里忽略new_target写死原型对象会导致 JS 端extends继承断链分清 ClassID 与 JSClass 的作用域ClassID 全局分配所有 runtime 共享而JS_NewClass()需要在每个 JSRuntime 中分别调用失败路径也要释放内存构造函数中途失败要记得js_free()finalizer第 38–43 行里对s可能为 NULL 也做了显式防御值得借鉴。 延伸阅读examples/fib.c、examples/c_module.js更轻量的 C 模块入门示例bjson.c、quickjs-libc.c更大规模的真实原生模块官方文档推荐参考doc/quickjs.texiQuickJS 官方手册涵盖内存管理、异常处理、超时中断等进阶主题。小结QuickJS 原生类的配方很简单OpaqueC 数据 ClassID类型注册 原型方法 四行注册流程。掌握examples/point.c这个骨架后你就可以把任意 C 功能以类的形式优雅地暴露给 JavaScript并天然支持 JS 端的继承与扩展。【免费下载链接】QuickJSQuickJS is a small and embeddable Javascript engine. QuickJS sources are copyright Fabrice Bellard and Charlie Gordon.项目地址: https://gitcode.com/gh_mirrors/quick/QuickJS创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考