Tauri插件tauri-plugin-deep-link使用指南

插件概述

tauri-plugin-deep-link是一个用于Tauri应用程序的插件，支持深度链接处理和自定义URL协议注册。它允许您的应用响应系统级的URL调用，实现从外部应用或浏览器直接打开您的Tauri应用特定功能。

主要功能

• 注册自定义URL协议（如：myapp://）
• 处理深度链接调用
• 跨平台支持（Windows、macOS、Linux）
• 监听URL打开事件

安装方法

1. 添加依赖

在Cargo.toml中添加：

[dependencies]
tauri-plugin-deep-link = "0.1"
serde = { version = "1.0", features = ["derive"] }

2. 注册插件

在src/main.rs中：

use tauri_plugin_deep_link;

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_deep_link::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

基本使用方法

1. 注册自定义协议

use tauri::Manager;
use tauri_plugin_deep_link::DeepLinkExt;

#[tauri::command]
async fn register_protocol(app_handle: tauri::AppHandle) -> Result<(), String> {
    app_handle.deep_link().register("myapp").map_err(|e| e.to_string())
}

2. 监听深度链接事件

use tauri::{Manager, Window};
use tauri_plugin_deep_link::DeepLinkExt;

fn setup_deep_link_listener(app: &tauri::App) -> Result<(), Box<dyn std::error::Error>> {
    let app_handle = app.handle();
    let window = app.get_window("main").unwrap();
    
    app_handle.deep_link()
        .on_open(move |url| {
            println!("Received deep link: {}", url);
            // 处理URL逻辑
            handle_deep_link(url, &window);
        });
    
    Ok(())
}

fn handle_deep_link(url: String, window: &Window) {
    // 解析URL并执行相应操作
    if url.starts_with("myapp://open/") {
        let path = url.replace("myapp://open/", "");
        window.eval(&format!("window.location.hash = '#/{}'", path)).unwrap();
    }
}

3. 完整示例

use tauri::{Manager, Window};
use tauri_plugin_deep_link::DeepLinkExt;

#[tauri::command]
async fn init_deep_link(app_handle: tauri::AppHandle, window: Window) -> Result<(), String> {
    // 注册协议
    app_handle.deep_link()
        .register("myapp")
        .map_err(|e| e.to_string())?;
    
    // 设置监听器
    let window_clone = window.clone();
    app_handle.deep_link()
        .on_open(move |url| {
            println!("Deep link received: {}", url);
            
            if let Some(query) = url.strip_prefix("myapp://") {
                match query {
                    "home" => {
                        window_clone.eval("window.location.hash = '#/home'").unwrap();
                    }
                    "settings" => {
                        window_clone.eval("window.location.hash = '#/settings'").unwrap();
                    }
                    _ if query.starts_with("product/") => {
                        let product_id = query.replace("product/", "");
                        window_clone.eval(&format!(
                            "window.location.hash = '#/product/{}'", 
                            product_id
                        )).unwrap();
                    }
                    _ => {}
                }
            }
        });
    
    Ok(())
}

平台特定配置

macOS配置

在tauri.conf.json中添加：

{
  "tauri": {
    "bundle": {
      "macOS": {
        "category": "public.app-category.productivity"
      }
    }
  }
}

Windows配置

在tauri.conf.json中添加协议注册：

{
  "tauri": {
    "bundle": {
      "windows": {
        "protocols": [
          {
            "name": "MyApp",
            "schemes": ["myapp"]
          }
        ]
      }
    }
  }
}

错误处理

use tauri_plugin_deep_link::DeepLinkError;

fn handle_deep_link_errors() -> Result<(), DeepLinkError> {
    // 错误处理示例
    match app_handle.deep_link().register("myapp") {
        Ok(_) => println!("Protocol registered successfully"),
        Err(DeepLinkError::ProtocolAlreadyRegistered) => {
            eprintln!("Protocol is already registered");
        }
        Err(e) => return Err(e),
    }
    Ok(())
}

注意事项

1. 在macOS上，需要在应用首次运行时请求权限
2. Windows需要管理员权限才能注册协议
3. 协议名称应该保持唯一性，避免与其他应用冲突
4. 处理完深度链接后应该及时释放资源

这个插件为Tauri应用提供了完整的深度链接解决方案，让您的应用能够更好地与其他应用和系统集成。

完整示例demo

以下是一个完整的Tauri应用示例，展示了如何使用tauri-plugin-deep-link插件：

// src/main.rs
use tauri::{Manager, Window};
use tauri_plugin_deep_link::DeepLinkExt;

// 前端命令：初始化深度链接
#[tauri::command]
async fn init_deep_link(app_handle: tauri::AppHandle, window: Window) -> Result<(), String> {
    // 注册自定义协议
    app_handle.deep_link()
        .register("myapp")
        .map_err(|e| e.to_string())?;
    
    // 克隆窗口用于闭包
    let window_clone = window.clone();
    
    // 设置深度链接监听器
    app_handle.deep_link()
        .on_open(move |url| {
            println!("接收到深度链接: {}", url);
            
            // 解析URL并执行相应操作
            if let Some(query) = url.strip_prefix("myapp://") {
                match query {
                    "home" => {
                        // 导航到首页
                        window_clone.eval("window.location.hash = '#/home'").unwrap();
                    }
                    "settings" => {
                        // 导航到设置页
                        window_clone.eval("window.location.hash = '#/settings'").unwrap();
                    }
                    _ if query.starts_with("product/") => {
                        // 导航到产品详情页
                        let product_id = query.replace("product/", "");
                        window_clone.eval(&format!(
                            "window.location.hash = '#/product/{}'", 
                            product_id
                        )).unwrap();
                    }
                    _ => {
                        // 处理未知链接
                        println!("未知的深度链接: {}", url);
                    }
                }
            }
        });
    
    Ok(())
}

fn main() {
    tauri::Builder::default()
        // 注册深度链接插件
        .plugin(tauri_plugin_deep_link::init())
        // 注册前端命令
        .invoke_handler(tauri::generate_handler![init_deep_link])
        .setup(|app| {
            // 获取主窗口
            let window = app.get_window("main").unwrap();
            
            // 初始化深度链接
            let app_handle = app.handle();
            app_handle.deep_link()
                .register("myapp")
                .expect("无法注册协议");
            
            // 设置深度链接监听器
            let window_clone = window.clone();
            app_handle.deep_link()
                .on_open(move |url| {
                    println!("应用启动时接收到深度链接: {}", url);
                    handle_deep_link(url, &window_clone);
                });
            
            Ok(())
        })
        .run(tauri::generate_context!())
        .expect("运行Tauri应用时出错");
}

// 处理深度链接的辅助函数
fn handle_deep_link(url: String, window: &Window) {
    if let Some(query) = url.strip_prefix("myapp://") {
        match query {
            "home" => {
                window.eval("window.location.hash = '#/home'").unwrap();
            }
            "settings" => {
                window.eval("window.location.hash = '#/settings'").unwrap();
            }
            _ if query.starts_with("open/") => {
                let path = query.replace("open/", "");
                window.eval(&format!("window.location.hash = '#/{}'", path)).unwrap();
            }
            _ => {
                println!("未处理的深度链接: {}", url);
            }
        }
    }
}

# Cargo.toml
[package]
name = "my-tauri-app"
version = "0.1.0"
description = "A Tauri app with deep link support"
authors = ["Your Name"]
license = "MIT"
edition = "2021"

[dependencies]
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
tauri = { version = "1.0", features = ["api-all"] }
tauri-plugin-deep-link = "0.1"

[build-dependencies]
tauri-build = { version = "1.0" }

// tauri.conf.json
{
  "build": {
    "beforeBuildCommand": "",
    "beforeDevCommand": "",
    "devPath": "../dist",
    "distDir": "../dist"
  },
  "package": {
    "productName": "My Tauri App",
    "version": "0.1.0"
  },
  "tauri": {
    "allowlist": {
      "all": false,
      "deep-link": {
        "all": true,
        "register": true,
        "unregister": true,
        "on-open": true
      }
    },
    "bundle": {
      "active": true,
      "category": "DeveloperTool",
      "copyright": "",
      "deb": {
        "depends": []
      },
      "externalBin": [],
      "icon": [
        "icons/32x32.png",
        "icons/128x128.png",
        "icons/128x128@2x.png",
        "icons/icon.icns",
        "icons/icon.ico"
      ],
      "identifier": "com.example.my-tauri-app",
      "macOS": {
        "category": "public.app-category.productivity"
      },
      "windows": {
        "certificateThumbprint": null,
        "digestAlgorithm": "sha256",
        "timestampUrl": "",
        "protocols": [
          {
            "name": "MyApp",
            "schemes": ["myapp"]
          }
        ]
      }
    },
    "security": {
      "csp": null
    },
    "updater": {
      "active": false
    },
    "windows": [
      {
        "fullscreen": false,
        "height": 600,
        "resizable": true,
        "title": "My Tauri App",
        "width": 800
      }
    ]
  }
}

这个完整示例展示了如何在Tauri应用中集成深度链接功能，包括协议注册、链接监听和相应的页面导航处理。