跳至主要内容

Tauri 插件

插件允许你连接到 Tauri 应用生命周期并引入新的命令。

使用插件​

要使用插件，只需将插件实例传递给 App 的 `plugin` 方法

fn main() {
  tauri::Builder::default()
    .plugin(my_awesome_plugin::init())
    .run(tauri::generate_context!())
    .expect("failed to run app");
}

编写插件​

插件是 Tauri API 的可重用扩展，用于解决常见问题。它们也是组织代码库的一种非常便捷的方式！

如果你打算与他人共享你的插件，我们提供了一个现成的模板！使用 Tauri 的 CLI 安装后，只需运行

npm run tauri plugin init -- --name awesome

API 包​

默认情况下，你的插件的使用者可以像这样调用提供的命令

import { invoke } from '@tauri-apps/api'
invoke('plugin:awesome|do_something')

其中 `awesome` 将被你的插件名称替换。

然而，这并不十分方便，因此插件通常提供所谓的*API 包*，这是一个提供便捷访问你的命令的 JavaScript 包。

一个例子是 tauri-plugin-store，它提供了一个方便的类结构来访问存储。你可以像这样搭建一个带有附加 JavaScript API 包的 Tauri 插件

npm run tauri plugin init -- --name awesome --api

编写插件​

使用 `tauri::plugin::Builder`，你可以定义类似于定义你的应用程序的插件

use tauri::{
  plugin::{Builder, TauriPlugin},
  Runtime,
};

// the plugin custom command handlers if you choose to extend the API:

#[tauri::command]
// this will be accessible with `invoke('plugin:awesome|initialize')`.
// where `awesome` is the plugin name.
fn initialize() {}

#[tauri::command]
// this will be accessible with `invoke('plugin:awesome|do_something')`.
fn do_something() {}

pub fn init<R: Runtime>() -> TauriPlugin<R> {
  Builder::new("awesome")
    .invoke_handler(tauri::generate_handler![initialize, do_something])
    .build()
}

插件可以设置和维护状态，就像你的应用程序一样

use tauri::{
  plugin::{Builder, TauriPlugin},
  AppHandle, Manager, Runtime, State,
};

#[derive(Default)]
struct MyState {}

#[tauri::command]
// this will be accessible with `invoke('plugin:awesome|do_something')`.
fn do_something<R: Runtime>(_app: AppHandle<R>, state: State<'_, MyState>) {
  // you can access `MyState` here!
}

pub fn init<R: Runtime>() -> TauriPlugin<R> {
  Builder::new("awesome")
    .invoke_handler(tauri::generate_handler![do_something])
    .setup(|app_handle| {
      // setup plugin specific state here
      app_handle.manage(MyState::default());
      Ok(())
    })
    .build()
}

约定​

  • 该板条箱导出一个 `init` 方法来创建插件。
  • 插件应该有一个清晰的名称，前缀为 `tauri-plugin-`。
  • 在 `Cargo.toml`/`package.json` 中包含 `tauri-plugin` 关键字。
  • 用英语编写你的插件文档。
  • 添加一个展示你的插件的示例应用程序。

高级​

不必依赖于 `tauri::plugin::Builder::build` 返回的 `tauri::plugin::TauriPlugin` 结构体，你可以自己实现 `tauri::plugin::Plugin`。这允许你完全控制相关数据。

请注意，`Plugin` 特性上的每个函数都是可选的，除了 `name` 函数。

use tauri::{plugin::{Plugin, Result as PluginResult}, Runtime, PageLoadPayload, Window, Invoke, AppHandle};

struct MyAwesomePlugin<R: Runtime> {
  invoke_handler: Box<dyn Fn(Invoke<R>) + Send + Sync>,
  // plugin state, configuration fields
}

// the plugin custom command handlers if you choose to extend the API.
#[tauri::command]
// this will be accessible with `invoke('plugin:awesome|initialize')`.
// where `awesome` is the plugin name.
fn initialize() {}

#[tauri::command]
// this will be accessible with `invoke('plugin:awesome|do_something')`.
fn do_something() {}

impl<R: Runtime> MyAwesomePlugin<R> {
  // you can add configuration fields here,
  // see https://doc.rust-lang.net.cn/1.0.0/style/ownership/builders.html
  pub fn new() -> Self {
    Self {
      invoke_handler: Box::new(tauri::generate_handler![initialize, do_something]),
    }
  }
}

impl<R: Runtime> Plugin<R> for MyAwesomePlugin<R> {
  /// The plugin name. Must be defined and used on the `invoke` calls.
  fn name(&self) -> &'static str {
    "awesome"
  }

  /// The JS script to evaluate on initialization.
  /// Useful when your plugin is accessible through `window`
  /// or needs to perform a JS task on app initialization
  /// e.g. "window.awesomePlugin = { ... the plugin interface }"
  fn initialization_script(&self) -> Option<String> {
    None
  }

  /// initialize plugin with the config provided on `tauri.conf.json > plugins > $yourPluginName` or the default value.
  fn initialize(&mut self, app: &AppHandle<R>, config: serde_json::Value) -> PluginResult<()> {
    Ok(())
  }

  /// Callback invoked when the Window is created.
  fn created(&mut self, window: Window<R>) {}

  /// Callback invoked when the webview performs navigation.
  fn on_page_load(&mut self, window: Window<R>, payload: PageLoadPayload) {}

  /// Extend the invoke handler.
  fn extend_api(&mut self, message: Invoke<R>) {
    (self.invoke_handler)(message)
  }
}