从 Tauri 1.0 升级

本指南将引导您将 Tauri 1.0 应用程序升级到 Tauri 2.0。

为移动端做准备

Tauri 的移动端接口要求您的项目输出一个共享库。如果您的现有应用程序要面向移动端，则必须将 crate 更改为除了桌面可执行文件之外，还生成这种类型的 artifact。

1. 更改 Cargo 清单以生成库。追加以下块

src-tauri/Cargo.toml

[lib]
name = "app_lib"
crate-type = ["staticlib", "cdylib", "rlib"]

2. 将 src-tauri/src/main.rs 重命名为 src-tauri/src/lib.rs。此文件将由桌面和移动端目标共享。

3. 将 lib.rs 中的 main 函数头重命名为以下内容

src-tauri/src/lib.rs

#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
    // your code here
}

tauri::mobile_entry_point 宏将您的函数准备好在移动端执行。

4. 重新创建调用共享运行函数的 main.rs 文件

src-tauri/src/main.rs

#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]

fn main() {
  app_lib::run();
}

自动化迁移

危险

此命令不能替代本指南！无论您是否选择使用此命令，请务必阅读**整个**页面。

Tauri v2 CLI 包含一个 migrate 命令，该命令可自动化大部分过程并帮助您完成迁移。

npm

npm install @tauri-apps/cli@latest
npm run tauri migrate

yarn

yarn upgrade @tauri-apps/cli@latest
yarn tauri migrate

pnpm

pnpm update @tauri-apps/cli@latest
pnpm tauri migrate

cargo

cargo install tauri-cli --version "^2.0.0" --locked
cargo tauri migrate

在命令行界面参考中了解更多关于migrate命令的信息

变更总结

以下是 Tauri 1.0 到 Tauri 2.0 的变更摘要

Tauri 配置

• package > productName 和 package > version 移动到顶层对象。
• 二进制文件名称不再自动重命名以匹配 productName，因此您必须向顶层对象添加一个与 productName 匹配的 mainBinaryName 字符串。
• package 已移除。
• tauri 键重命名为 app。
• tauri > allowlist 已移除。请参阅迁移权限。
• tauri > allowlist > protocol > assetScope 移动到 app > security > assetProtocol > scope。
• tauri > cli 移动到 plugins > cli。
• tauri > windows > fileDropEnabled 重命名为 app > windows > dragDropEnabled。
• tauri > updater > active 已移除。
• tauri > updater > dialog 已移除。
• tauri > updater 移动到 plugins > updater。
• bundle > createUpdaterArtifacts 已添加，使用应用程序更新器时必须设置。
  • 从已分发的 v1 应用程序升级时，将其设置为 v1Compatible。有关更多信息，请参阅更新器指南。
• tauri > systemTray 重命名为 app > trayIcon。
• tauri > pattern 移动到 app > security > pattern。
• tauri > bundle 移动到顶层。
• tauri > bundle > identifier 移动到顶层对象。
• tauri > bundle > dmg 移动到 bundle > macOS > dmg
• tauri > bundle > deb 移动到 bundle > linux > deb
• tauri > bundle > appimage 移动到 bundle > linux > appimage
• tauri > bundle > macOS > license 已移除，请改用 bundle > licenseFile。
• tauri > bundle > windows > wix > license 已移除，请改用 bundle > licenseFile。
• tauri > bundle > windows > nsis > license 已移除，请改用 bundle > licenseFile。
• tauri > bundle > windows > webviewFixedRuntimePath 已移除，请改用 bundle > windows > webviewInstallMode。
• build > withGlobalTauri 移动到 app > withGlobalTauri。
• build > distDir 重命名为 frontendDist。
• build > devPath 重命名为 devUrl。

Tauri 2.0 配置 API 参考

新的 Cargo 特性

• linux-protocol-body：启用自定义协议请求体解析，允许 IPC 使用它。需要 webkit2gtk 2.40。

已移除的 Cargo 特性

• reqwest-client：reqwest 现在是唯一受支持的客户端。
• reqwest-native-tls-vendored：改用 native-tls-vendored。
• process-command-api：改用 shell 插件（请参阅下一节中的说明）。
• shell-open-api：改用 shell 插件（请参阅下一节中的说明）。
• windows7-compat：移动到 notification 插件。
• updater：更新器现在是一个插件。
• linux-protocol-headers：由于我们升级了最低 webkit2gtk 版本，现在默认启用。
• system-tray：重命名为 tray-icon。

Rust Crate 变更

• api 模块已移除。每个 API 模块都可以在 Tauri 插件中找到。
• api::dialog 模块已移除。改用 tauri-plugin-dialog。 迁移
• api::file 模块已移除。改用 Rust 的 std::fs。
• api::http 模块已移除。改用 tauri-plugin-http。 迁移
• api::ip 模块已重写并移动到 tauri::ipc。查看新的 API，特别是 tauri::ipc::Channel。
• api::path 模块函数和 tauri::PathResolved 移动到 tauri::Manager::path。 迁移
• api::process::Command、tauri::api::shell 和 tauri::Manager::shell_scope API 已移除。改用 tauri-plugin-shell。 迁移
• api::process::current_binary 和 tauri::api::process::restart 移动到 tauri::process。
• api::version 模块已移除。改用 semver crate。
• App::clipboard_manager 和 AppHandle::clipboard_manager 已移除。改用 tauri-plugin-clipboard。 迁移
• App::get_cli_matches 已移除。改用 tauri-plugin-cli。 迁移
• App::global_shortcut_manager 和 AppHandle::global_shortcut_manager 已移除。改用 tauri-plugin-global-shortcut。 迁移
• Manager::fs_scope 已移除。文件系统作用域可通过 tauri_plugin_fs::FsExt 访问。
• Plugin::PluginApi 现在将插件配置作为第二个参数接收。
• Plugin::setup_with_config 已移除。改用更新后的 tauri::Plugin::PluginApi。
• scope::ipc::RemoteDomainAccessScope::enable_tauri_api 和 scope::ipc::RemoteDomainAccessScope::enables_tauri_api 已移除。改用 scope::ipc::RemoteDomainAccessScope::add_plugin 独立启用每个核心插件。
• scope::IpcScope 已移除，改用 scope::ipc::Scope。
• scope::FsScope、scope::GlobPattern 和 scope::FsScopeEvent 已移除，分别改用 scope::fs::Scope、scope::fs::Pattern 和 scope::fs::Event。
• updater 模块已移除。改用 tauri-plugin-updater。 迁移
• Env.args 字段已移除，改用 Env.args_os 字段。
• Menu、MenuEvent、CustomMenuItem、Submenu、WindowMenuEvent、MenuItem 和 Builder::on_menu_event API 已移除。 迁移
• SystemTray、SystemTrayHandle、SystemTrayMenu、SystemTrayMenuItemHandle、SystemTraySubmenu、MenuEntry 和 SystemTrayMenuItem API 已移除。 迁移

JavaScript API 变更

@tauri-apps/api 包不再提供非核心模块。只有之前的 tauri（现在是 core）、path、event 和 window 模块被导出。所有其他模块都已移至插件。

• @tauri-apps/api/tauri 模块重命名为 @tauri-apps/api/core。 迁移
• @tauri-apps/api/cli 模块已移除。改用 @tauri-apps/plugin-cli。 迁移
• @tauri-apps/api/clipboard 模块已移除。改用 @tauri-apps/plugin-clipboard。 迁移
• @tauri-apps/api/dialog 模块已移除。改用 @tauri-apps/plugin-dialog。 迁移
• @tauri-apps/api/fs 模块已移除。改用 @tauri-apps/plugin-fs。 迁移
• @tauri-apps/api/global-shortcut 模块已移除。改用 @tauri-apps/plugin-global-shortcut。 迁移
• @tauri-apps/api/http 模块已移除。改用 @tauri-apps/plugin-http。 迁移
• @tauri-apps/api/os 模块已移除。改用 @tauri-apps/plugin-os。 迁移
• @tauri-apps/api/notification 模块已移除。改用 @tauri-apps/plugin-notification。 迁移
• @tauri-apps/api/process 模块已移除。改用 @tauri-apps/plugin-process。 迁移
• @tauri-apps/api/shell 模块已移除。改用 @tauri-apps/plugin-shell。 迁移
• @tauri-apps/api/updater 模块已移除。改用 @tauri-apps/plugin-updater 迁移
• @tauri-apps/api/window 模块重命名为 @tauri-apps/api/webviewWindow。 迁移

v1 插件现在以 @tauri-apps/plugin-<plugin-name> 的形式发布。以前它们是从 git 作为 tauri-plugin-<plugin-name>-api 提供的。

环境变量变更

Tauri CLI 读取和写入的大部分环境变量为了保持一致性和防止错误而被重命名

• TAURI_PRIVATE_KEY -> TAURI_SIGNING_PRIVATE_KEY
• TAURI_KEY_PASSWORD -> TAURI_SIGNING_PRIVATE_KEY_PASSWORD
• TAURI_SKIP_DEVSERVER_CHECK -> TAURI_CLI_NO_DEV_SERVER_WAIT
• TAURI_DEV_SERVER_PORT -> TAURI_CLI_PORT
• TAURI_PATH_DEPTH -> TAURI_CLI_CONFIG_DEPTH
• TAURI_FIPS_COMPLIANT -> TAURI_BUNDLER_WIX_FIPS_COMPLIANT
• TAURI_DEV_WATCHER_IGNORE_FILE -> TAURI_CLI_WATCHER_IGNORE_FILENAME
• TAURI_TRAY -> TAURI_LINUX_AYATANA_APPINDICATOR
• TAURI_APPLE_DEVELOPMENT_TEAM -> APPLE_DEVELOPMENT_TEAM
• TAURI_PLATFORM -> TAURI_ENV_PLATFORM
• TAURI_ARCH -> TAURI_ENV_ARCH
• TAURI_FAMILY -> TAURI_ENV_FAMILY
• TAURI_PLATFORM_VERSION -> TAURI_ENV_PLATFORM_VERSION
• TAURI_PLATFORM_TYPE -> TAURI_ENV_PLATFORM_TYPE
• TAURI_DEBUG -> TAURI_ENV_DEBUG

事件系统

事件系统经过重新设计，更易于使用。它不再依赖于事件源，而是采用更简单的实现，依赖于事件目标。

• emit 函数现在将事件发射到所有事件监听器。
• 添加了新的 emit_to/emitTo 函数，用于向特定目标触发事件。
• emit_filter 现在根据 EventTarget 而不是窗口进行过滤。
• 将 listen_global 重命名为 listen_any。它现在监听所有事件，无论其过滤器和目标如何。
• JavaScript: event.listen() 的行为类似于 listen_any。它现在监听所有事件，无论其过滤器和目标如何，除非在 Options 中设置了目标。
• JavaScript: WebviewWindow.listen 等只监听发送到相应 EventTarget 的事件。

多 WebView 支持

Tauri v2 引入了多 WebView 支持，目前它在 unstable 特性标志后面。为了支持它，我们将 Rust 的 Window 类型重命名为 WebviewWindow，将 Manager 的 get_window 函数重命名为 get_webview_window。

WebviewWindow JS API 类型现在从 @tauri-apps/api/webviewWindow 重新导出，而不是从 @tauri-apps/api/window 导出。

Windows 上新的源 URL

在 Windows 上，生产应用程序中的前端文件现在托管在 http://tauri.localhost 而不是 https://tauri.localhost。因此，IndexedDB、LocalStorage 和 Cookies 将被重置，除非在 v1 中使用了 dangerousUseHttpScheme。为了防止这种情况，您可以将 app > windows > useHttpsScheme 设置为 true 或使用 WebviewWindowBuilder::use_https_scheme 以继续使用 https 方案。

详细迁移步骤

将 Tauri 1.0 应用程序迁移到 Tauri 2.0 时可能会遇到的常见场景。

迁移到核心模块

@tauri-apps/api/tauri 模块已重命名为 @tauri-apps/api/core。只需重命名模块导入

import { invoke } from "@tauri-apps/api/tauri"
import { invoke } from "@tauri-apps/api/core"

迁移到 CLI 插件

Rust App::get_cli_matches JavaScript @tauri-apps/api/cli API 已移除。改用 @tauri-apps/plugin-cli 插件

1. 添加到 cargo 依赖项

Cargo.toml

[dependencies]
tauri-plugin-cli = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_cli::init())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-cli": "^2.0.0"
  }
}

import { getMatches } from '@tauri-apps/plugin-cli';
const matches = await getMatches();

Rust

fn main() {
    use tauri_plugin_cli::CliExt;
    tauri::Builder::default()
        .plugin(tauri_plugin_cli::init())
        .setup(|app| {
            let cli_matches = app.cli().matches()?;
            Ok(())
        })
}

迁移到剪贴板插件

Rust App::clipboard_manager 和 AppHandle::clipboard_manager 以及 JavaScript @tauri-apps/api/clipboard API 已移除。改用 @tauri-apps/plugin-clipboard-manager 插件

[dependencies]
tauri-plugin-clipboard-manager = "2"

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_clipboard_manager::init())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-clipboard-manager": "^2.0.0"
  }
}

import { writeText, readText } from '@tauri-apps/plugin-clipboard-manager';
await writeText('Tauri is awesome!');
assert(await readText(), 'Tauri is awesome!');

Rust

use tauri_plugin_clipboard::{ClipboardExt, ClipKind};
tauri::Builder::default()
    .plugin(tauri_plugin_clipboard::init())
    .setup(|app| {
        app.clipboard().write(ClipKind::PlainText {
            label: None,
            text: "Tauri is awesome!".into(),
        })?;
        Ok(())
    })

迁移到对话框插件

Rust tauri::api::dialog JavaScript @tauri-apps/api/dialog API 已移除。改用 @tauri-apps/plugin-dialog 插件

1. 添加到 cargo 依赖项

Cargo.toml

[dependencies]
tauri-plugin-dialog = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_dialog::init())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-dialog": "^2.0.0"
  }
}

import { save } from '@tauri-apps/plugin-dialog';
const filePath = await save({
  filters: [
    {
      name: 'Image',
      extensions: ['png', 'jpeg'],
    },
  ],
});

Rust

use tauri_plugin_dialog::DialogExt;
tauri::Builder::default()
    .plugin(tauri_plugin_dialog::init())
    .setup(|app| {
        app.dialog().file().pick_file(|file_path| {
            // do something with the optional file path here
            // the file path is `None` if the user closed the dialog
        });

        app.dialog().message("Tauri is Awesome!").show();
        Ok(())
     })

迁移到文件系统插件

Rust App::get_cli_matches JavaScript @tauri-apps/api/fs API 已移除。请改用 Rust 的 std::fs 和 JavaScript 的 @tauri-apps/plugin-fs 插件

1. 添加到 cargo 依赖项

Cargo.toml

[dependencies]
tauri-plugin-fs = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_fs::init())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-fs": "^2.0.0"
  }
}

import { mkdir, BaseDirectory } from '@tauri-apps/plugin-fs';
await mkdir('db', { baseDir: BaseDirectory.AppLocalData });

部分函数和类型已重命名或移除

• Dir 枚举别名已移除，请使用 BaseDirectory。
• FileEntry、FsBinaryFileOption、FsDirOptions、FsOptions、FsTextFileOption 和 BinaryFileContents 接口和类型别名已移除，并替换为适用于每个函数的新接口。
• createDir 重命名为 mkdir。
• readBinaryFile 重命名为 readFile。
• removeDir 已移除并替换为 remove。
• removeFile 已移除并替换为 remove。
• renameFile 已移除并替换为 rename。
• writeBinaryFile 重命名为 writeFile。

Rust

使用 Rust std::fs 函数。

迁移到全局快捷方式插件

Rust App::global_shortcut_manager 和 AppHandle::global_shortcut_manager 以及 JavaScript @tauri-apps/api/global-shortcut API 已移除。改用 @tauri-apps/plugin-global-shortcut 插件

1. 添加到 cargo 依赖项

Cargo.toml

[dependencies]
[target."cfg(not(any(target_os = \"android\", target_os = \"ios\")))".dependencies]
tauri-plugin-global-shortcut = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_global_shortcut::Builder::default().build())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-global-shortcut": "^2.0.0"
  }
}

import { register } from '@tauri-apps/plugin-global-shortcut';
await register('CommandOrControl+Shift+C', () => {
  console.log('Shortcut triggered');
});

Rust

use tauri_plugin_global_shortcut::GlobalShortcutExt;

tauri::Builder::default()
    .plugin(
        tauri_plugin_global_shortcut::Builder::new().with_handler(|app, shortcut| {
            println!("Shortcut triggered: {:?}", shortcut);
        })
        .build(),
    )
    .setup(|app| {
        // register a global shortcut
        // on macOS, the Cmd key is used
        // on Windows and Linux, the Ctrl key is used
        app.global_shortcut().register("CmdOrCtrl+Y")?;
        Ok(())
    })

迁移到 HTTP 插件

Rust tauri::api::http JavaScript @tauri-apps/api/http API 已移除。改用 @tauri-apps/plugin-http 插件

1. 添加到 cargo 依赖项

Cargo.toml

[dependencies]
tauri-plugin-http = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_http::init())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-http": "^2.0.0"
  }
}

import { fetch } from '@tauri-apps/plugin-http';
const response = await fetch(
  'https://raw.githubusercontent.com/tauri-apps/tauri/dev/package.json'
);

Rust

use tauri_plugin_http::reqwest;

tauri::Builder::default()
    .plugin(tauri_plugin_http::init())
    .setup(|app| {
        let response_data = tauri::async_runtime::block_on(async {
            let response = reqwest::get(
                "https://raw.githubusercontent.com/tauri-apps/tauri/dev/package.json",
            )
            .await
            .unwrap();
            response.text().await
        })?;
        Ok(())
    })

HTTP 插件重新导出了 reqwest，因此您可以查阅其文档以获取更多信息。

迁移到通知插件

Rust tauri::api::notification JavaScript @tauri-apps/api/notification API 已移除。改用 @tauri-apps/plugin-notification 插件

1. 添加到 cargo 依赖项

Cargo.toml

[dependencies]
tauri-plugin-notification = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_notification::init())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-notification": "^2.0.0"
  }
}

import { sendNotification } from '@tauri-apps/plugin-notification';
sendNotification('Tauri is awesome!');

Rust

use tauri_plugin_notification::NotificationExt;
use tauri::plugin::PermissionState;

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_notification::init())
        .setup(|app| {
            if app.notification().permission_state()? == PermissionState::Unknown {
                app.notification().request_permission()?;
            }
            if app.notification().permission_state()? == PermissionState::Granted {
                app.notification()
                    .builder()
                    .body("Tauri is awesome!")
                    .show()?;
            }
            Ok(())
        })
}

迁移到菜单模块

Rust Menu API 已移至 tauri::menu 模块并重构为使用 muda crate。

使用 tauri::menu::MenuBuilder

使用 tauri::menu::MenuBuilder 而不是 tauri::Menu。请注意，其构造函数将 Manager 实例（App、AppHandle 或 WebviewWindow 之一）作为参数

use tauri::menu::MenuBuilder;

tauri::Builder::default()
    .setup(|app| {
        let menu = MenuBuilder::new(app)
            .copy()
            .paste()
            .separator()
            .undo()
            .redo()
            .text("open-url", "Open URL")
            .check("toggle", "Toggle")
            .icon("show-app", "Show App", app.default_window_icon().cloned().unwrap())
            .build()?;
        Ok(())
    })

使用 tauri::menu::PredefinedMenuItem

使用 tauri::menu::PredefinedMenuItem 而不是 tauri::MenuItem

use tauri::menu::{MenuBuilder, PredefinedMenuItem};

tauri::Builder::default()
    .setup(|app| {
        let menu = MenuBuilder::new(app).item(&PredefinedMenuItem::copy(app)?).build()?;
        Ok(())
    })

提示

菜单生成器有专门的方法来添加每个预定义菜单项，因此您可以调用 .copy() 而不是 .item(&PredefinedMenuItem::copy(app, None)?)。

使用 tauri::menu::MenuItemBuilder

使用 tauri::menu::MenuItemBuilder 而不是 tauri::CustomMenuItem

use tauri::menu::MenuItemBuilder;

tauri::Builder::default()
    .setup(|app| {
        let toggle = MenuItemBuilder::new("Toggle").accelerator("Ctrl+Shift+T").build(app)?;
        Ok(())
    })

使用 tauri::menu::SubmenuBuilder

使用 tauri::menu::SubmenuBuilder 而不是 tauri::Submenu

use tauri::menu::{MenuBuilder, SubmenuBuilder};

tauri::Builder::default()
    .setup(|app| {
        let submenu = SubmenuBuilder::new(app, "Sub")
            .text("Tauri")
            .separator()
            .check("Is Awesome")
            .build()?;
        let menu = MenuBuilder::new(app).item(&submenu).build()?;
        Ok(())
    })

tauri::Builder::menu 现在接受一个闭包，因为菜单需要一个 Manager 实例才能构建。有关更多信息，请参阅文档。

菜单事件

Rust tauri::Builder::on_menu_event API 已移除。改用 tauri::App::on_menu_event 或 tauri::AppHandle::on_menu_event

use tauri::menu::{CheckMenuItemBuilder, MenuBuilder, MenuItemBuilder};

tauri::Builder::default()
    .setup(|app| {
        let toggle = MenuItemBuilder::with_id("toggle", "Toggle").build(app)?;
        let check = CheckMenuItemBuilder::new("Mark").build(app)?;
        let menu = MenuBuilder::new(app).items(&[&toggle, &check]).build()?;

        app.set_menu(menu)?;

        app.on_menu_event(move |app, event| {
            if event.id() == check.id() {
                println!("`check` triggered, do something! is checked? {}", check.is_checked().unwrap());
            } else if event.id() == "toggle" {
                println!("toggle triggered!");
            }
        });
        Ok(())
    })

请注意，有两种方法可以检查选择了哪个菜单项：将项移动到事件处理程序闭包并比较 ID，或者通过 with_id 构造函数为项定义自定义 ID 并使用该 ID 字符串进行比较。

提示

菜单项可以在菜单之间共享，并且菜单事件绑定到菜单项而不是菜单或窗口。如果您不希望在选择菜单项时触发所有侦听器，请不要共享菜单项，而是使用专用实例，您可以将其移动到 tauri::WebviewWindow/WebviewWindowBuilder::on_menu_event 闭包中。

迁移到 OS 插件

Rust tauri::api::os JavaScript @tauri-apps/api/os API 已移除。改用 @tauri-apps/plugin-os 插件

1. 添加到 cargo 依赖项

Cargo.toml

[dependencies]
tauri-plugin-os = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_os::init())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-os": "^2.0.0"
  }
}

import { arch } from '@tauri-apps/plugin-os';
const architecture = await arch();

Rust

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_os::init())
        .setup(|app| {
            let os_arch = tauri_plugin_os::arch();
            Ok(())
        })
}

迁移到进程插件

Rust tauri::api::process JavaScript @tauri-apps/api/process API 已移除。改用 @tauri-apps/plugin-process 插件

1. 添加到 cargo 依赖项

Cargo.toml

[dependencies]
tauri-plugin-process = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_process::init())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-process": "^2.0.0"
  }
}

import { exit, relaunch } from '@tauri-apps/plugin-process';
await exit(0);
await relaunch();

Rust

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_process::init())
        .setup(|app| {
            // exit the app with a status code
            app.handle().exit(1);
            // restart the app
            app.handle().restart();
            Ok(())
        })
}

迁移到 Shell 插件

Rust tauri::api::shell JavaScript @tauri-apps/api/shell API 已移除。改用 @tauri-apps/plugin-shell 插件

1. 添加到 cargo 依赖项

Cargo.toml

[dependencies]
tauri-plugin-shell = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_shell::init())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-shell": "^2.0.0"
  }
}

import { Command, open } from '@tauri-apps/plugin-shell';
const output = await Command.create('echo', 'message').execute();

await open('https://github.com/tauri-apps/tauri');

Rust

• 打开一个 URL

use tauri_plugin_shell::ShellExt;

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_shell::init())
        .setup(|app| {
            app.shell().open("https://github.com/tauri-apps/tauri", None)?;
            Ok(())
        })
}

• 生成一个子进程并获取状态码

use tauri_plugin_shell::ShellExt;

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_shell::init())
        .setup(|app| {
            let status = tauri::async_runtime::block_on(async move { app.shell().command("which").args(["ls"]).status().await.unwrap() });
            println!("`which` finished with status: {:?}", status.code());
            Ok(())
        })
}

• 生成一个子进程并捕获其输出

use tauri_plugin_shell::ShellExt;

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_shell::init())
        .setup(|app| {
            let output = tauri::async_runtime::block_on(async move { app.shell().command("echo").args(["TAURI"]).output().await.unwrap() });
            assert!(output.status.success());
            assert_eq!(String::from_utf8(output.stdout).unwrap(), "TAURI");
            Ok(())
        })
}

• 生成一个子进程并异步读取其事件

use tauri_plugin_shell::{ShellExt, process::CommandEvent};

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_shell::init())
        .setup(|app| {
            let handle = app.handle().clone();
            tauri::async_runtime::spawn(async move {
                let (mut rx, mut child) = handle.shell().command("cargo")
                    .args(["tauri", "dev"])
                    .spawn()
                    .expect("Failed to spawn cargo");

                let mut i = 0;
                while let Some(event) = rx.recv().await {
                    if let CommandEvent::Stdout(line) = event {
                        println!("got: {}", String::from_utf8(line).unwrap());
                       i += 1;
                       if i == 4 {
                           child.write("message from Rust\n".as_bytes()).unwrap();
                           i = 0;
                       }
                   }
                }
            });
            Ok(())
        })
}

迁移到托盘图标模块

Rust SystemTray API 已重命名为 TrayIcon 以保持一致性。新的 API 可以在 Rust tray 模块中找到。

使用 tauri::tray::TrayIconBuilder

使用 tauri::tray::TrayIconBuilder 而不是 tauri::SystemTray

let tray = tauri::tray::TrayIconBuilder::with_id("my-tray").build(app)?;

有关更多信息，请参阅 TrayIconBuilder。

迁移到菜单

使用 tauri::menu::Menu 而不是 tauri::SystemTrayMenu，tauri::menu::Submenu 而不是 tauri::SystemTraySubmenu，以及 tauri::menu::PredefinedMenuItem 而不是 tauri::SystemTrayMenuItem。

托盘事件

tauri::SystemTray::on_event 已拆分为 tauri::tray::TrayIconBuilder::on_menu_event 和 tauri::tray::TrayIconBuilder::on_tray_icon_event

use tauri::{
    menu::{MenuBuilder, MenuItemBuilder},
    tray::{MouseButton, MouseButtonState, TrayIconBuilder, TrayIconEvent},
};

tauri::Builder::default()
    .setup(|app| {
        let toggle = MenuItemBuilder::with_id("toggle", "Toggle").build(app)?;
        let menu = MenuBuilder::new(app).items(&[&toggle]).build()?;
        let tray = TrayIconBuilder::new()
            .menu(&menu)
            .on_menu_event(move |app, event| match event.id().as_ref() {
                "toggle" => {
                    println!("toggle clicked");
                }
                _ => (),
            })
            .on_tray_icon_event(|tray, event| {
                if let TrayIconEvent::Click {
                        button: MouseButton::Left,
                        button_state: MouseButtonState::Up,
                        ..
                } = event
                {
                    let app = tray.app_handle();
                    if let Some(webview_window) = app.get_webview_window("main") {
                       let _ = webview_window.unminimize();
                       let _ = webview_window.show();
                       let _ = webview_window.set_focus();
                    }
                }
            })
            .build(app)?;

        Ok(())
    })

迁移到更新器插件

默认行为更改

内置的带自动更新检查的对话框已移除，请改用 Rust 和 JS API 来检查和安装更新。不这样做将阻止您的用户获得进一步的更新！

Rust tauri::updater 和 JavaScript @tauri-apps/api-updater API 已移除。使用 @tauri-apps/plugin-updater 设置自定义更新器目标

1. 添加到 cargo 依赖项

[dependencies]
tauri-plugin-updater = "2"

2. 在 JavaScript 或 Rust 项目中使用

JavaScript

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_updater::Builder::new().build())
}

package.json

{
  "dependencies": {
    "@tauri-apps/plugin-updater": "^2.0.0"
  }
}

import { check } from '@tauri-apps/plugin-updater';
import { relaunch } from '@tauri-apps/plugin-process';

const update = await check();
if (update?.available) {
  console.log(`Update to ${update.version} available! Date: ${update.date}`);
  console.log(`Release notes: ${update.body}`);
  await update.downloadAndInstall();
  // requires the `process` plugin
  await relaunch();
}

Rust

检查更新

use tauri_plugin_updater::UpdaterExt;

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_updater::Builder::new().build())
        .setup(|app| {
            let handle = app.handle();
            tauri::async_runtime::spawn(async move {
                let response = handle.updater().check().await;
            });
            Ok(())
        })
}

设置自定义更新器目标

fn main() {
    let mut updater = tauri_plugin_updater::Builder::new();
    #[cfg(target_os = "macos")]
    {
        updater = updater.target("darwin-universal");
    }
    tauri::Builder::default()
        .plugin(updater.build())
}

将路径迁移到 Tauri 管理器

Rust tauri::api::path 模块函数和 tauri::PathResolver 已移动到 tauri::Manager::path

use tauri::{path::BaseDirectory, Manager};

tauri::Builder::default()
    .setup(|app| {
        let home_dir_path = app.path().home_dir().expect("failed to get home dir");

        let path = app.path().resolve("path/to/something", BaseDirectory::Config)?;

        Ok(())
  })

迁移到新的窗口 API

在 Rust 端，Window 已重命名为 WebviewWindow，其构建器 WindowBuilder 现在名为 WebviewWindowBuilder，WindowUrl 现在名为 WebviewUrl。

此外，Manager::get_window 函数已重命名为 get_webview_window，并且窗口的 parent_window API 已重命名为 parent_raw 以支持高级窗口父 API。

在 JavaScript 端，WebviewWindow 类现在在 @tauri-apps/api/webviewWindow 路径中导出。

onMenuClicked 函数已移除，您可以在 JavaScript 中创建菜单时拦截菜单事件。

迁移嵌入式附加文件（资源）

在 JavaScript 端，请确保您迁移到文件系统插件。此外，请注意迁移权限中对 v1 允许列表所做的更改。

在 Rust 端，请确保您将路径迁移到 Tauri Manager。

迁移嵌入式外部二进制文件（Sidecar）

在 Tauri v1 中，外部二进制文件及其参数在允许列表中定义。在 v2 中，请使用新的权限系统。有关更多信息，请阅读迁移权限。

在 JavaScript 端，请确保您迁移到 Shell 插件。

在 Rust 端，tauri::api::process API 已移除。请改用 tauri_plugin_shell::ShellExt 和 tauri_plugin_shell::process::CommandEvent API。请参阅嵌入外部二进制文件指南以了解如何操作。

“process-command-api”特性标志已在 v2 中移除。因此，运行外部二进制文件不再需要在 Tauri 配置中定义此特性。

迁移权限

v1 允许列表已重写为全新的权限系统，该系统适用于单个插件，并且对于多窗口和远程 URL 支持具有更高的可配置性。这个新系统的工作方式类似于访问控制列表（ACL），您可以允许或拒绝命令，为特定窗口和域集分配权限，并定义访问范围。

要为您的应用程序启用权限，您必须在 src-tauri/capabilities 文件夹中创建功能文件，Tauri 将自动为您配置所有其他内容。

migrate CLI 命令会自动解析您的 v1 允许列表并生成关联的功能文件。

要了解有关权限和功能的更多信息，请参阅安全文档。