开发工具【免费下载链接】wasm-bindgenFacilitating high-level interactions between Wasm modules and JavaScript项目地址https://gitcode.com/gh_mirrors/wa/wasm-bindgen点击查看免费下载本文是 wasm-bindgen 设计系列guide/src/contributing/design/index.md中的一篇聚焦于 Rust/JS 两侧类型信息是如何被编码、传输并最终被wasm-bindgenCLI 工具还原的。读完本文你将完整掌握#[wasm_bindgen]宏如何把类型签名编译为可执行函数、如何通过__wbindgen_describe导入把一串u32送达宿主侧以及enum Descriptor如何把这条流式编码重新解析成 CLI 可用的完整类型树。一、问题背景为什么类型信息必须运行时传递在 Rust 与 JS 之间转换类型时最棘手的问题不是转换本身而是如何把类型信息从 Rust 编译器这边传达到 wasm-bindgen CLI 那边。#[wasm_bindgen]宏运行在 Rust 代码的**语法层syntactical、未解析的结构**之上它需要生成信息供后续的wasm-bindgenCLI 工具读取。这里存在两个天然的障碍编译期不可知像关联类型投影associated type projections和 typedef 这类东西它们的具体是什么类型要等编译器推进到很后面的阶段才能确定宏在语法层根本拿不到完整答案类型很富CLI 需要理解诸如FnMut(String, Foo, JsValue)这样的组合类型这类带闭包、带结构体、带引用语义的签名靠简单的文本或名称列表根本无法表达。因此 wasm-bindgen 采取了一个略微不走寻常路unconventional的方案静态信息用 JSON 序列化写入 Wasm 可执行文件的 custom section而动态类型信息则通过可执行函数来携带。这就是本文的主角WasmDescribetrait 与 descriptor描述符机制。从源码结构看这条管线的两端分别位于Rust 侧宏生成 trait 实现src/describe.rs —— 定义WasmDescribetrait 及其各种基础类型的实现CLI 侧解析还原crates/cli-support/src/descriptor.rs —— 定义enum Descriptor及流式解码逻辑以及 crates/cli-support/src/descriptors.rs —— 执行并收集所有描述符函数的结果。二、WasmDescribetrait为每个类型写一份签名程序整个机制的核心是一个看似朴素实则关键的 traitpub trait WasmDescribe { fn describe(); }这个定义位于 src/describe.rs。它没有返回值、没有参数唯一的作用是在被调用时把当前类型的编码信息逐个写入宿主。配合一个底层入口函数#[inline(always)] pub fn inform(a: u32) { unsafe { super::__wbindgen_describe(a) } }inform把每一个u32通过__wbindgen_describe这个 Wasm 导入传给宿主即 CLI 侧的wasm-interpreter。所有基础类型都以极其直接的方式实现该 traitsimple! { i8 I8 u8 U8 i16 I16 u16 U16 i32 I32 u32 U32 i64 I64 u64 U64 i128 I128 u128 U128 f32 F32 f64 F64 bool BOOLEAN char CHAR JsValue EXTERNREF }完整映射见 src/describe.rs。注意这里存在一个架构相关的分支isize/usize在 wasm32 上映射为I32/U32在 wasm64 上则映射为I64_AS_F64/U64_AS_F64见 src/describe.rs。字符串也随 feature 开关变化开启enable-interning时str/String映射为CACHED_STRING否则为STRINGsrc/describe.rs。复合类型的递归描述真正体现设计巧思的是复合类型描述不是拍平的一串数字而是带结构的递归调用。例如引用T先发REF再递归描述Tmut T同理发REFMUTsrc/describe.rs切片[T]先发SLICE再递归描述Tsrc/describe.rs向量VecT/Box[T]经由WasmDescribeVector先发VECTOR再递归src/describe.rs可选值OptionT先发OPTIONAL再递归src/describe.rs结果ResultT, E先发RESULT再递归描述成功分支src/describe.rs钳制数ClampedT先发CLAMPED再递归src/describe.rs。也就是说describe()的执行过程本身就是一个深度优先遍历每个inform(u32)是一次编码动作递归调用则展开子类型。最终宿主编译器拿到的就是一条前序遍历产生的扁平u32流。三、宏如何生成__wbindgen_describe_*函数除了前文提到的 JS shim 之外宏还会为每个导出/导入额外生成一个描述函数。以文档中的导出为例#[wasm_bindgen] fn greet(a: str) { // ... }宏在生成普通 shim 的同时还会生成类似这样的东西#[no_mangle] pub extern C fn __wbindgen_describe_greet() { dyn Fn(str)::describe(); }这段示意代码来自设计文档原文。实际代码生成逻辑在 crates/macro-support/src/codegen.rs描述函数的命名规则是__wbindgen_describe_前缀拼接 wasm 符号名CLI 侧通过剥离前缀来把描述符与对应的 shim 关联起来见 crates/macro-support/src/codegen.rs 与 crates/cli-support/src/descriptors.rs。描述函数的生成覆盖了完整的功能面导出函数对每个参数依次ty as WasmDescribe::describe()对返回值调用ret_ty as WasmDescribe::describe()与inner_ret_ty as WasmDescribe::describe()后者是内部返回类型见 crates/macro-support/src/codegen.rs导入函数同样的模式参数描述见 crates/macro-support/src/codegen.rs导入类型class为每个导入的 JS 类实现WasmDescribecrates/macro-support/src/codegen.rsRust 结构体导出为#[wasm_bindgen]导出的结构体实现WasmDescribecrates/macro-support/src/codegen.rs枚举与字符串枚举生成描述实现crates/macro-support/src/codegen.rs、crates/macro-support/src/codegen.rsgetter/setter字段访问器也各自带一个描述函数crates/macro-support/src/codegen.rs。除此之外还有一类**按单态化per-monomorphisation**生成的描述函数泛型导入与wbg_cast恒等适配器通过__wbindgen_describe_generic_import标记导入把(func 指针, ABI 参数指针)传给宿主src/describe.rs让 CLI 能按每个具体单态实例制造 JS 绑定crates/cli-support/src/wit/mod.rs。四、__wbindgen_describe导入一条通往宿主的u32流当wasm-bindgenCLI 运行时它会执行这些描述函数。执行的落地机制是每次调用__wbindgen_describe会向宿主传递一个u32多次调用累积起来就等效于得到一条Vecu32。这条Vecu32随后被重新解析成enum Descriptor从而完整地描述一个类型。这里要强调的是这些执行发生在 CLI 侧的 Wasm 解释器interpreter中而不是浏览器或 Node 里。从 crates/cli-support/src/descriptors.rs 的模块注释可以看到整个流程拿到 rustc 产出的原始 Wasm 模块找出所有以__wbindgen_describe_为前缀的导出函数逐个解释执行execute_exportscrates/cli-support/src/descriptors.rs同时扫描所有直接调用__wbindgen_describe_generic_import标记的函数execute_generic_importscrates/cli-support/src/descriptors.rs用Descriptor::decode把每条u32流还原成描述符crates/cli-support/src/descriptor.rs把结果放进一个新的 custom sectionWasmBindgenDescriptorsSectioncrates/cli-support/src/descriptors.rs随后 CLI 在处理程序时按需取用crates/cli-support/src/wit/mod.rs。值得注意的是宏还通过#[link_section __wasm_bindgen_unstable]写入了一个 custom section用于存放 JSON 序列化的静态结构信息schema 版本、AST 编码等见 crates/macro-support/src/codegen.rs。五、enum Descriptor解码后的类型树CLI 侧的解码目标是一个庞大的判别式枚举完整定义在 crates/cli-support/src/descriptor.rspub enum Descriptor { I8, U8, ClampedU8, I16, U16, I32, U32, I64, U64, I64AsF64, U64AsF64, I128, U128, F32, F64, Boolean, Function(BoxFunction), Closure(BoxClosure), Ref(BoxDescriptor), RefMut(BoxDescriptor), Slice(BoxDescriptor), Vector(BoxDescriptor), CachedString, String, Externref, NamedExternref(String), Enum { name: String, hole: u32, unique_crate_identifier: String }, StringEnum { name: String, invalid: u32, hole: u32 }, DynamicUnion { name: String, variant_types: VecDescriptor }, RustStruct { name: String, unique_crate_identifier: String }, Char, Option(BoxDescriptor), Result(BoxDescriptor), Unit, NonNull, RawPointer, }可以看到它和 Rust 侧的inform(u32)编码一一对应每个变体要么是标量要么携带递归子描述符形成一棵类型树。带名称的类型枚举、结构体、命名 externref还会携带name与unique_crate_identifier用于在后续阶段解析为最终的 JS 标识见 crates/cli-support/src/descriptor.rs 的visit_named_types_mut。Function与Closure是树中最复杂的节点pub struct Function { pub arguments: VecDescriptor, pub shim_idx: u32, pub ret: Descriptor, pub inner_ret: OptionDescriptor, } pub struct Closure { pub owned: bool, pub function: Function, pub mutable: bool, }crates/cli-support/src/descriptor.rs。Function携带参数表、shim 索引、返回类型及内部返回类型这让 CLI 能还原出FnMut(String, Foo, JsValue)这样的富类型签名——闭包描述符额外记录所有权与可变性。流式解码算法解码是一个简单的递归前序消费过程_decodecrates/cli-support/src/descriptor.rs读一个u32作为标签匹配到对应变体标量类型直接结束复合类型REF/REFMUT/SLICE/VECTOR/OPTIONAL/RESULT继续递归读取一个子描述符带名称的类型继续读长度前缀的字符串get_string先读字符数再逐个读u32字符crates/cli-support/src/descriptor.rsCLAMPED会设置一个clamped标志后递归使内层的U8被解码为ClampedU8crates/cli-support/src/descriptor.rs解码结束后断言数据已消费完毕assert!(data.is_empty(), ...)任何未知标签都会触发panic!(unknown descriptor: {other})——这说明宏与 CLI 之间依赖严格的协议对齐。编码标签本身定义在共享 crate 中crates/shared/src/tys.rs 用宏连续编号生成全部 31 个常量I8, U8, ..., RAW_POINTER。宏侧写inform($d)、CLI 侧读u32标签两侧共用同一份常量表从协议层面保证了编码/解码的一致性。六、执行代价为零描述函数最终被裁剪设计文档特别强调了这个机制的一个关键特性整体上这套方案有些迂回roundabout但对生成代码和运行时没有任何影响。所有描述函数都会从最终产出的 Wasm 文件中被裁剪掉。从源码可以确认这句话的落实execute()在解释完所有描述函数后会把它们从模块中删除crates/cli-support/src/descriptors.rs 删除导出项模块注释亦说明All descriptor functions are removed after this pass runs搜索结果中 crates/cli-support/src/wit/mod.rs 检查模块中是否存在以__wbindgen_describe开头的导出项用于校验逻辑CLI 会删除__wbindgen_describe与__wbindgen_describe_generic_import这两个特殊导入crates/cli-support/src/wit/mod.rs。因此描述机制是纯编译期/工具链期的存在它只影响wasm-bindgen工具对中间产物的后处理用户最终拿到的foo.jsfoo_bg.wasm中完全不含这些描述函数的痕迹。七、整条管线串联从 Rust 源码到 JS 绑定把以上各部分串起来一个#[wasm_bindgen]函数从写出来到被 JS 调用的完整数据流是宏展开#[wasm_bindgen]宏在语法层解析函数签名生成三类产物——普通 JS shim、__wbindgen_describe_name描述函数、以及 JSON 编码的 AST 静态信息写入__wasm_bindgen_unstablecustom section见 crates/macro-support/src/codegen.rs编译rustc 产出 Wasm 文件其中描述函数以#[no_mangle]导出符号存在其函数体是对WasmDescribe::describe()的一连串调用CLI 解释执行wasm-bindgen工具用内置的 Wasm 解释器逐个执行这些描述函数__wbindgen_describe导入把每个u32交给宿主侧累积成Vecu32解码建树Descriptor::decode把u32流还原为enum Descriptor类型树存入WasmBindgenDescriptorsSectioncustom section消费与裁剪CLI 在处理导入/导出时按 shim 名取出对应描述符self.descriptors.remove(wasm_name)crates/cli-support/src/wit/mod.rs据此生成正确的 JS 绑定与 ABI 适配代码最后删除全部描述函数和描述相关导入。测试方面仓库在 crates/cli-support/src/descriptor.rs 提供了一个单元测试vector_kind_accepts_memory64_scalar_descriptors验证 wasm64 场景下U64AsF64/I64AsF64标量描述符也能被vector_kind()正确识别为U64/I64向量——可以直接运行cargo test -p wasm-bindgen-cli-support来验证解码逻辑。八、小结WasmDescribe机制是 wasm-bindgen 架构中最具独创性的一环它把类型签名这种编译期无法穷尽的动态信息编码为一组可以执行的描述函数借助一个朴素的u32通道传送到 CLI再用一棵递归的Descriptor树还原出完整、精确、可机读的类型结构。这一设计既绕开了宏只能看到语法层的限制又完全避免了描述代码对最终产物的任何运行期影响——执行完即裁剪静默而高效。如果想深入体系地理解 wasm-bindgen 的设计可以继续阅读同目录下的姊妹篇rust-type-conversions.mdRust 类型转换与 index.md整体设计导览guide/src/contributing/design/exporting-rust.md 与 guide/src/contributing/design/importing-js.md 则分别从导出、导入视角展示宏生成的完整图景。赞分享开发工具【免费下载链接】wasm-bindgenFacilitating high-level interactions between Wasm modules and JavaScript项目地址https://gitcode.com/gh_mirrors/wa/wasm-bindgen点击查看免费下载相关推荐Ruff 描述符协议Descriptor Protocol类型推断深度解析Ruff 描述符协议Descriptor Protocol类型推断深度解析 导读 本文以 Ruff 仓库中类型检查器ty的类型推断测试规范文档 desc开发工具Lint格式化静态分析CLIGel/EdgeDB 二进制协议类型描述符Type Descriptor完全解析从 CommandDataDescription 到编解码器Gel/EdgeDB 二进制协议类型描述符Type Descriptor完全解析从 CommandDataDescription 到编解码器 本指南系统讲数据库图数据库关系型数据库RenderDoc 描述符与绑定深度解析从 Descriptor Abstraction 到各 API 底层实现RenderDoc 描述符与绑定深度解析从 Descriptor Abstraction 到各 API 底层实现 导读 本文基于 RenderDoc 官方 P开发工具调试器图形学GPU上一篇免费把老视频修成4KVideo2X超分完整指南下一篇Video2X 免费教程如何用 AI 快速把老视频超分到 4K创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考