初次体验Tauri和Sycamore(3)通道实现

embedded/2025/3/14 21:14:26/


原创作者:庄晓立(LIIGO)
原创时间:2025年03月10日(发布时间)
原创链接:https://blog.csdn.net/liigo/article/details/146159327
版权所有,转载请注明出处。

tauri-splash


20250310 LIIGO备注:本文源自系列文章第1篇《初次体验TauriSycamore (1)》,从中抽取出来独立成文(但并无更新和修订),专注于探究Tauri通道的底层实现(实际上也没有足够底层)。理由:1.原文已经很长,需要精简;2.原文主体是初级技术内容,仅这一节相对深入,显得格格不入。(如无意外,这将是本系列文章的终结。)


20241118 LIIGO补记:出于好奇,简单研究一下Tauri通道的底层实现。

在JS层,创建Channel对象生成通道ID,并关联onmessage处理函数;在传输层,通过invoke()调用后端Command,传入Channel对象作为参数(实质上是传入通道ID);在Rust层,根据通道ID构造后端Channel对象,向客户端指定的Channel发送Message。如何向通道发送Message是后续关注的重点。


JS层创建Channel的源码如下:

class Channel<T = unknown> {id: number// @ts-expect-error field used by the IPC serializerprivate readonly __TAURI_CHANNEL_MARKER__ = true#onmessage: (response: T) => void = () => {// no-op}#nextMessageId = 0#pendingMessages: Record<string, T> = {}constructor() {this.id = transformCallback(({ message, id }: { message: T; id: number }) => {// the id is used as a mechanism to preserve message orderif (id === this.#nextMessageId) {this.#nextMessageId = id + 1this.#onmessage(message) // 前端用户收到此message// process pending messages// ...} else {this.#pendingMessages[id.toString()] = message}});}// ...
}function transformCallback<T = unknown>(callback?: (response: T) => void, once = false): number {return window.__TAURI_INTERNALS__.transformCallback(callback, once)
}

JS层Channel构造函数内部,调用transformCallback为一个回调函数生成唯一ID(它基于Crypto.getRandomValues()的实现能保证ID唯一吗我存疑),并将二者关联至window对象:window['_回调ID'] = ({message, id})=>{ /*...*/};。此处生成的ID也称为通道ID,将被invoke函数传递给Rust层(参见上文前端调用Command)。后端数据通过通道到达前端后,可通过通道ID反查并调用该回调函数接收后端数据。注意区分通道ID、消息ID和后文的数据ID。


Rust层通过JavaScriptChannelId::channel_onChannel::new_with_id构造Channel对象实例。

impl JavaScriptChannelId {/// Gets a [`Channel`] for this channel ID on the given [`Webview`].pub fn channel_on<R: Runtime, TSend>(&self, webview: Webview<R>) -> Channel<TSend> {let callback_id = self.0;let counter = AtomicUsize::new(0);Channel::new_with_id(callback_id.0, move |body| {let i = counter.fetch_add(1, Ordering::Relaxed);if let Some(interceptor) = &webview.manager.channel_interceptor {if interceptor(&webview, callback_id, i, &body) {return Ok(());}}let data_id = CHANNEL_DATA_COUNTER.fetch_add(1, Ordering::Relaxed);webview.state::<ChannelDataIpcQueue>().0.lock().unwrap().insert(data_id, body);webview.eval(&format!("window.__TAURI_INTERNALS__.invoke('{FETCH_CHANNEL_DATA_COMMAND}', null, {{ headers: {{ '{CHANNEL_ID_HEADER_NAME}': '{data_id}' }} }}).then((response) => window['_' + {}]({{ message: response, id: {i} }})).catch(console.error)",callback_id.0))?;Ok(())})}
}

Channel::new_with_id有两个参数,一个是通道ID(或称callback_id),一个是向前端发送数据的on_message函数。这个on_message的命名有误导性,让人以为是接收函数,但看Channel::send()函数源码可以确认on_message是发送函数。

impl<TSend> Channel<TSend> {fn new_with_id<F: Fn(InvokeResponseBody) -> crate::Result<()> + Send + Sync + 'static>(id: u32,on_message: F,) -> Self {// ...}/// Sends the given data through the channel.pub fn send(&self, data: TSend) -> crate::Result<()> where TSend: IpcResponse, {(self.on_message)(data.body()?)}
}

RustChannel发送数据的实现代码就在上面JavaScriptChannelId::channel_on(webview)函数内部,即new_with_id()的on_message参数闭包函数内,它主要干了如下几件事:

  • 生成数据ID(data_id):let data_id = CHANNEL_DATA_COUNTER.fetch_add(1, Ordering::Relaxed);
  • 将要数据存入发送缓存队列并关联data_id:webview.state::<ChannelDataIpcQueue>()...insert(data_id, body)
  • 生成JS代码并提交给前端执行(分两步):webview.eval(JSCODE)
    • fetch: invoke('plugin:__TAURI_CHANNEL__|fetch', null, ...data_id...)
    • callback: window['_通道ID']({ message: response, id: {i} }) (调用JS端回调函数, {i}为此通道内消息ID,即序号)

再看一下fetch源码(上文invoke('plugin:__TAURI_CHANNEL__|fetch', ...)将调用此后端Command):

#[command(root = "crate")]
fn fetch(request: Request<'_>,cache: State<'_, ChannelDataIpcQueue>,
) -> Result<Response, &'static str> {if let Some(id) = request.headers().get(CHANNEL_ID_HEADER_NAME).and_then(|v| v.to_str().ok()).and_then(|id| id.parse().ok()){if let Some(data) = cache.0.lock().unwrap().remove(&id) {Ok(Response::new(data))} else {Err("data not found")}} else {Err("missing channel id header")}
}

fetch命令的作用是从发送缓存队列中取出与参数data_id关联的数据返回给前端,同时从发送缓存队列中移除。fetch执行后,通过通道发送的数据就从后端到了前端。注意时序,是后端主动提交JS代码让前端执行,前端才被动发起fetch调用,Tauri正是通过这种方式实现后端向前端“推送”数据。数据被推送至前端后,可能还要经历缓存阶段才提交给Channel用户,确保用户有序接收。


调用链:(JS层)创建Channel,发起调用后端某Command(传入通道ID),(Rust层)把通道ID反序列化为Channel,将待发送数据缓存,调度前端执行JS代码(webview.eval()),(JS层)通过fetchCommand拉取后端缓存数据,处理乱序数据接收,执行用户层onmessage回调,完成单次数据传输。

我原来猜测通道Channel是Command之外另一种更高效的数据传输方案,但事实证明我错了。通过上述源码分析可知,Channel实际上是基于Command实现的更高层的逻辑抽象。Tauri通道发送数据,本质上还是调用Command,只是经过封装之后更适合“后端推送流式数据”应用场景。相比使用普通无通道Command传输数据,其区别在于工作模式:无通道传输,是前端单次主动拉取;有通道传输,是后端多次主动推送,且保证有序送达。


http://www.ppmy.cn/embedded/172576.html

相关文章

使用自动导入后,eslint报错 eslint9

前提&#xff1a;使用pnpm create vuelatest创建vue应用&#xff0c;并且在创建项目时就勾选eslint和prettier&#xff0c;不然有些配置还需要手动配&#xff0c;比如解决eslint和prettier的冲突问题 1. 解决使用自动导入后Eslint报错问题 配置vite.config.ts // 自动导入api…

排序算法——归并排序(三)

文章目录 一、实现思路二、代码实现三、复杂度分析总结 一、实现思路 归并排序是使用分治思想解决问题的典型算法&#xff0c;对于一个庞大的乱序数组我们很难针对整体对其进行排序&#xff0c;但是对于微小的数组却很容易对其进行排序&#xff0c;有了数个有序的小数组&#…

国产编辑器EverEdit - 脚本(解锁文本编辑的无限可能)

1 脚本 1.1 应用场景 脚本是一种功能扩展代码&#xff0c;用于提供一些编辑器通用功能提供不了的功能&#xff0c;帮助用户在特定工作场景下提高工作效率&#xff0c;几乎所有主流的编辑器、IDE都支持脚本。   EverEdit的脚本支持js(语法与javascript类似)、VBScript两种编程…

Git Fast-forward 合并详解:原理、场景与最佳实践

在使用 Git 进行团队协作时&#xff0c;我们经常需要合并分支。合并方式有很多种&#xff0c;其中 Fast-forward&#xff08;快速合并&#xff09; 是一种最简单且无冲突的合并方式。本文将详细介绍 Fast-forward 的原理、适用场景、常见问题及最佳实践。 一、Fast-forward 合并…

Python 进程与线程-分布式进程

目录 分布式进程 小结 分布式进程 在Thread和Process中&#xff0c;应当优选Process&#xff0c;因为Process更稳定&#xff0c;而且&#xff0c;Process可以分布到多台机器上&#xff0c;而Thread最多只能分布到同一台机器的多个CPU上。 Python的multiprocessing模块不但支…

CUDA编程之OpenCV与CUDA结合使用

OpenCV与CUDA的结合使用可显著提升图像处理性能。 一、版本匹配与环境配置 CUDA与OpenCV版本兼容性‌ OpenCV各版本对CUDA的支持存在差异&#xff0c;例如OpenCV 4.5.4需搭配CUDA 10.0‌2&#xff0c;而较新的OpenCV 4.8.0需使用更高版本CUDA‌。 需注意部分模块&#xff08;…

文件上传复现

漏洞原理与技术演进 ​核心逻辑缺陷 未对上传文件的以下属性进行校验&#xff1a; 文件扩展名&#xff08;.php/.jsp/.asp&#xff09;MIME类型&#xff08;image/jpeg vs text/html&#xff09;文件头标识&#xff08;FFD8FF vs 3C3F706870&#xff09;文件内容&#xff08;是…

【数据挖掘】知识蒸馏(Knowledge Distillation, KD)

1. 概念 知识蒸馏&#xff08;Knowledge Distillation, KD&#xff09;是一种模型压缩和知识迁移技术&#xff0c;旨在将大型复杂模型&#xff08;称为教师模型&#xff09;中的知识传递给一个较小的模型&#xff08;称为学生模型&#xff09;&#xff0c;以减少计算成本&…