#桌面应用程序 #桌面 #跨平台GUI #Electron #API绑定 #WebKit

tauri-web-view

Rust 对 webview 的绑定,webview 是一个用于在桌面应用程序中渲染基于Web的GUI的小型跨平台库

1个不稳定版本

使用旧的Rust 2015

0.6.2 2020年6月25日

972GUI

MIT 许可证

400KB
3K SLoC

C 1.5K SLoC // 0.0% comments Rust 1K SLoC // 0.0% comments C++ 434 SLoC // 0.0% comments

web-view   .github/workflows/ci.yml 最新版本

重要:需要Rust 1.30稳定版或更高版本。

此库为webview的原始实现提供Rust绑定,webview是一个用于将Web-based GUI作为桌面应用程序渲染的小型跨平台库。

screenshot

通过external JS对象和webview.eval Rust函数,简化了您Rust和JavaScript代码之间的双向绑定。我们提供了完整的工作示例,但核心如下

// ... Simplified for the sake of brevity.
web_view::builder()    
    .invoke_handler(|webview, arg| {
        match arg {
            "test_one" => {
                // Do something in Rust!
            }
            "test_two" => {
                // Invoke a JavaScript function!
                webview.eval(&format!("myFunction({}, {})", 123, 456))
            }
            _ => unimplemented!(),
        };
    })
// Executes our "invoke_handler" - passing the value "test_one" as the second parameter.
external.invoke('test_one');

// Executes our "invoke_handler", which in turn calls "myFunction" below.
external.invoke('test_two');

function myFunction(paramOne, paramTwo) {
    console.log(paramOne);
    console.log(paramTwo);
}

此外,由于依赖于宿主操作系统的默认渲染引擎,与需要将Chromium捆绑到每个分发中的Electron等替代方案相比,您应该获得一个显著更轻的二进制文件进行分发。

您也应该看到相对较低的内存使用量,此部分将在适当的时候更新基准测试以突出这一点。

最后,支持的平台和您可以期望渲染您的应用程序内容的引擎如下

操作系统 使用的浏览器引擎
Windows MSHTML或EdgeHTML
Linux Gtk-webkit2
OSX Cocoa/WebKit

注意:默认情况下,Windows上使用MSHTML(IE)渲染引擎来显示应用程序。如果您想使用EdgeHTML(Edge),则需要通过功能开关启用它(参见安装和配置部分)。

先决条件

如果您计划针对Linux,您必须确保Webkit2gtk已经安装并可通过pkg-config命令查找。

如果您跳过此步骤,您将看到类似于以下格式的错误消息,通知您缺少什么

Compiling webview-sys v0.3.3
error: failed to run custom build command for `webview-sys v0.3.3`
Caused by:
process didn't exit successfully: `/home/username/rust-projects/my-project/target/debug/build/webview-sys-9020ddaf41e4df7d/build-script-build` (exit code: 101)
--- stderr
thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Command { command: "\"pkg-config\" \"--libs\" \"--cflags\" \"webkit2gtk-4.0\" \"webkit2gtk-4.0 >= 2.8\"", cause: Os { code: 2, kind: NotFound, message: "No such file or directory" } }', src/libcore/result.rs:1165:5

安装和配置

让我们从基本的Rust应用程序开始。在您选择的shell中运行cargo new my-project,然后切换到my-project目录。

由于该库可以在Rust社区注册表中找到,因此您要添加此依赖项,只需更新您的Cargo.toml文件,在依赖项部分添加以下内容

[dependencies]
web-view = { version = "0.5.4" }

如果您想在Windows环境中使用Edge,您需要通过Visual Studio安装程序安装Windows 10 SDK,并且您需要使用以下语法

[dependencies]
web-view = { version = "0.5.4", features = ["edge"] }

现在让我们编写一些利用库的Rust代码。使用您选择的编辑器打开main.rs文件

vim src/main.rs

并将内容替换为以下内容

use web_view::*;

fn main() {
    let html_content = "<html><body><h1>Hello, World!</h1></body></html>";
	
    web_view::builder()
        .title("My Project")
        .content(Content::Html(html_content))
        .size(320, 480)
        .resizable(false)
        .debug(true)
        .user_data(())
        .invoke_handler(|_webview, _arg| Ok(()))
        .run()
        .unwrap();
}

现在您应该能够运行cargo build并看到以下输出类似的内容

$ cargo build
Updating crates.io index
Compiling pkg-config v0.3.17
Compiling cc v1.0.47
Compiling boxfnonce v0.1.1
Compiling urlencoding v1.0.0
Compiling webview-sys v0.3.3
Compiling web-view v0.5.4
Compiling my-project v0.1.0 (C:\Users\Username\source\rust-projects\my-project)
Finished dev [unoptimized + debuginfo] target(s) in 8.36s

假设您构建成功,现在您只需运行它:cargo run。希望您将看到以下相同的内容

screenshot

有关更多信息,请参阅示例原始README

已知问题和限制

  • 在Windows 10上以Administrator运行时,Edge功能开关不起作用。这是#96中提出的问题的根本原因,这是由于Microsoft.Toolkit.Win32中的错误造成的,该错误在这里被跟踪

  • Edge沙箱限制。如果您决定使用嵌入式Web服务器来返回内容,您需要运行以下命令以绕过阻止与localhost通信的限制

    $ # Requires administrative privileges.
    $ CheckNetIsolation.exe LoopbackExempt -a -n="Microsoft.Win32WebViewHost_cw5n1h2txyewy"
    

    这通常用于Windows IoT Core,当允许两个进程之间的TCP/IP连接时。您可以在Microsoft文档中了解更多信息。

  • IE在传统兼容性格式中渲染内容。默认情况下,在Web浏览器控件内部渲染的内容将在兼容性模式下完成(具体为IE7)。要在Edge不可用的Windows系统上绕过这一点,您可以通过注册表修改强制使用已安装的最高版本的IE。

建议

  • 如果你喜欢类型安全,请用ElmPureScript*编写你的前端,或者使用编译为asm.js的Rust前端框架,例如yew
  • 使用parcel对你的前端代码进行打包和压缩。
  • 使用inline-assets将所有资产(CSS、JS、HTML)内联到一个index.html文件中,并用以下代码将其嵌入到你的Rust应用程序中:include_str!()
  • 如果你的应用程序在Windows上运行,请添加一个图标到你的Rust可执行文件,使其看起来更专业™
  • 使用自定义npm脚本或justcargo-make来自动化构建步骤。
  • 使用前端中的localStorage或后端的rustbreak来在会话之间持久化你的应用程序状态。
  • 顺便说一句,你还可以通过本地http服务器(例如,绑定到临时端口)来提供而不是通过js api注入应用程序资源。
  • 祝您编码愉快 :)

*免费的PureScript By Example书籍包含几个适合PureScript初学者的实用项目。

贡献机会

  • 对您的问题创建一个issue
  • 文档
  • 对该库的API和代码的反馈
  • 在非Windows平台上测试,报告您发现的任何问题
  • 展示您的应用程序
  • 添加一个使用Elm或Rust编译为asm.js的示例
  • 添加一个与后端进行双向通信的PureScript示例
  • 为原始webview库做出贡献:例如,在Windows上添加HDPI支持
  • 使创建webview窗口成为给定父窗口的子窗口成为可能。这将使webview能够用于Rust中的VST音频插件的GUI。

应用想法

  • Rust IDE(通过将xi-electron移植到web-view)
  • Rust的数据可视化/绘图库,使Rust在数据科学方面更有用
  • 加密货币钱包
  • IRC客户端,或其他聊天协议的客户端
  • MIDI歌曲编辑器,VJ控制器
  • Rust项目模板向导:通过用户友好的步骤从模板生成新的Rust项目
  • pijul的GUI
  • 使用web-viewclap-rs实现Gooey的替代方案

展示

如果您想在这里列出您的项目,请随时提交PR!

  • Juggernaut - 无坚不摧的程序员编辑器
  • FrakeGPS - 模拟简单的GPS设备
  • Compactor - Windows 10文件系统压缩实用程序
  • neutrino - 基于web-view的Rust GUI前端
  • SOUNDSENSE-RS - Dwarf Fortress的音效工具
  • Tauri - 将安全性引入webstack GUI,并为您提供最喜欢的JS框架的强大支持

欢迎贡献和反馈 :)


依赖关系

~0.3–1MB
~23K SLoC