SvelteKit

本指南将引导您使用 SvelteKit 框架创建您的第一款 Tauri 应用程序。

信息

Before we continue, make sure you have completed the prerequisites to have a working development environment.

Tauri 由一个可搭配任何前端来构建桌面应用的框架和 Rust 核心构成。 每个应用均由两个部分组成：

1. 创建窗口并向其提供原生功能支持的 Rust 二进制文件
2. 由您选择的前端框架，用于编写窗口内的用户界面

接下来，我们会先搭建好前端框架，然后设置一个Rust工程，最后向你展示这两者之间如何通信。

这是我们将要构建的内容的预览：

创建前端

SvelteKit is a Svelte Frontend that is primarily designed for Server-Side Rendering (SSR). 为了使 SvelteKit 和 Tauri 正常工作，需要关闭 SSR 并且使用 @sveltejs/adapter-static 创建基于前端的静态页面生成 (SSG).

SvelteKit comes with a scaffolding utility similar to create-tauri-app that can quickly set up a new project with many customization options. For this guide, we will select the TypeScript template, with ESLint and Prettier enabled.

npm

npm create svelte@latest

Yarn

yarn create svelte

pnpm

pnpm create svelte

1. 项目名称
   这将是您的 JavaScript 项目的名称。 对应此工具将创建的文件夹的名称，但在其他方面对你的应用没有影响。 您可以在此处填写任何您想要的名称。

2. App template
   We will select the Skeleton project for a barebones template. 如果你想要使用一个更完整的 SwelteKit 示例体验，你可以选择 SwelteKit 演示应用程序。

3. 输入检查
   您是否想要在您的项目中通过 JSDoc 或 TypeScript 进行类型检查。 对于本指南，我们假设您选择 TypeScript。

4. Code linting and formatting
   Whether you want to start your project with ESLint for code linting and Prettier for code formatting. 在本指南中不会有关于这个问题的其他提及，但我们建议启用这两个选项。

5. 浏览器测试
   SwelteKit 为浏览器测试提供内置的 Playwright 支持。 既然 Tauri API 不适用于 Playwright，我们建议不要添加它。 Check out our WebDriver documentation for alternatives using Selenium or WebdriverIO instead of Playwright.

在 SvelteKit 使用 SSG 模式

First, we need to install @sveltejs/adapter-static:

npm

npm install --save-dev @sveltejs/adapter-static@next

Yarn

yarn add -D @sveltejs/adapter-static@next

pnpm

pnpm add -D @sveltejs/adapter-static@next

然后更新 适配器 导入到 svelte.config.js 文件：

svelte.config.js

import adapter from '@sveltejs/adapter-static' // 这将会通过 adapter-auto 更改
import preprocess from 'svelte-preprocess'

/** @type {import('@sveltejs/kit').Config} */
const config = {
  // 查询 https://github.com/sveltejs/svelte-preprocess
  // 以了解更多关于预处理器的信息
  preprocess: preprocess(),

  kit: {
    adapter: adapter(),
  },
}

export default config

Lastly, we need to disable SSR and enable prerendering by adding a root +layout.ts file (or +layout.js if you are not using TypeScript) with these contents:

src/routes/+layout.ts

export const prerender = true
export const ssr = false

Note that static-adapter doesn't require you to disable SSR for the whole app but it makes it possible to use APIs that depend on the global window object (like Tauri's API) without Client-side checks.

此外，如果您喜欢单页应用程序模式（SPA）而不是 SSG，您可以根据 适配器文档 更改适配器配置和 +layout.ts。

创建 Rust 项目

每款 Tauri 应用的核心都是由一个管理窗口的 Rust 二进制文件、WebView 和进行系统调用的 tauri Rust 包构成。 此项目使用官方的软件包管理器及 Rust 通用构建工具 Cargo 来管理。

我们的 Tauri CLI 工具会在底层自动调用 Cargo，所以您大部分情况下无需和其交互。 Cargo 有诸多我们的 CLI 工具所未提供的有用功能，包括测试、分析及格式化工具。请参阅其官方文档来了解更多。

安装 Tauri CLI

如果你还没有安装Tauri CLI，你可以使用下面的一个命令进行安装。 不确定该用哪个？ 请参阅常见问题。

npm

npm install --save-dev @tauri-apps/cli@">1.0.0"

For npm to detect Tauri correctly you need to add it to the "scripts" section in your package.json file:

package.json

"scripts": {
  "tauri": "tauri"
}

Yarn

yarn add -D @tauri-apps/cli@^1.0.0

pnpm

pnpm add -D @tauri-apps/cli@1

Bun

bun add -D @tauri-apps/cli@1.0.0

Cargo

cargo install tauri-cli --version "^1.0.0"

要搭建一个使用 Tauri 的简单 Rust 项目，请打开终端并运行如下命令：

npm

npm run tauri init

Yarn

yarn tauri init

pnpm

pnpm tauri init

Cargo

cargo tauri init

它会向您询问几个问题：

1. 您应用的名字是什么？
   这将会是您打包后和操作系统会调用的应用名称。 您可以在此处填写任何您想要的名称。


2. 窗口标题叫什么？
   这将会是您主窗口的默认标题。 您可以在此处填写任何您想要的名称。


3. 前端页面资源 (HTML/CSS/JS) 相对于 <current dir>/src-tauri/tauri.conf.json 文件将被创建的位置？
   这是 production环境时tauri加载web前端资源的目录.
   Use ../build for this value.


4. 开发环境时的加载路径?
   可以是一个网络地址也可以是一个文件路径 development.
   Use http://localhost:5173 for this value.


5. 你将使用什么命令来开发前端页面？
   这是启动前端开发服务器的命令。
   Use npm run dev (make sure to adapt this to use the package manager of your choice).


6. 你将使用什么命令来构建前端页面？
   这是构建前端文件的命令。

信息

若您已熟悉 Rust，您会发现 tauri init 看起来很像 cargo init 命令。 若您想自己设置，您完全可以使用 cargo init 替代此命令，并手动添加 Tauri 依赖。

tauri init 命令将生成 src-tauri 文件夹。 传统上，Tauri 应用会将其核心相关的文件放置于此文件夹中。 让我们快速过一下此文件夹中的内容：

• Cargo.toml
  Cargo 的清单文件。 您可以声明您应用所依赖的 Rust 包和应用的元数据等等。 要查看所有可修改的值，请参阅 Cargo 清单格式。

• tauri.conf.json
  此文件可让您自定义 Tauri 应用的各方各面，包括应用名称到允许的 API 列表。 请参阅 Tauri 的 API 配置来深入了解每个支持的选项。

• src/main.rs
  这是你的 Rust 程序的入口，也是我们启动 Tauri 的地方。 您可以发现它由两个部分组成：

  src/main.rs

   #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
  
  fn main() {
  tauri::Builder::default()
     .run(tauri::generate_context!())
     .expect("error while running tauri application");
  }

  The line beginning with the cfg! 宏所开始的一行仅有一个目的：关闭构建好的应用在 Windows 上运行时一般会出现的控制台窗口。 若您是 Windows 用户，您可以试试去掉这行看看会发生什么。

  main 函数是您程序的入口点，也是运行时调用的第一个函数。

• icons
  您可能想为自己的应用整一个漂亮的图标！ 为了帮助您快速开发，我们为您提供了一套默认图标。 您应该在发布前把这些图标换成您自己的图标。 您可以在 Tauri 的图标功能指南中了解有关多种图标格式的信息。

现在我们已经搭建好了前端并初始化了Rust项目，创建的 tauri.conf.json 文件应该如下所示：

src-tauri/tauri.conf.json

{
  "build": {
    // 当你运行 `tauri build` 时，将会执行这个命令。
    "beforeBuildCommand": "npm run build",
    // This command will execute when you run `tauri dev`
    "beforeDevCommand": "npm run dev",
    "devPath": "http://localhost:5173",
    "distDir": "../build"
  },

就是这样！ 现在您可以在您的终端中运行接下来的命令来开始您的应用程序的开发构建：

npm

npm run tauri dev

Yarn

yarn tauri dev

pnpm

pnpm tauri dev

bun

bunx tauri dev

Cargo

cargo tauri dev

调用指令

Tauri 为您的前端开发提供了其他系统原生功能。 我们将其称作指令，这使得您可以从 JavaScript 前端调用由 Rust 编写的函数。 由此，您可以使用性能飞快的 Rust 代码处理繁重的任务或系统调用。

以下是一个简单示例：

src-tauri/src/main.rs

#[tauri::command]
fn greet(name: &str) -> String {
   format!("Hello, {}!", name)
}

一个指令等于一个普通的 Rust 函数，只是还加上了 #[tauri::command] 宏来让其与您的 JavaScript 环境交互。

最后，我们需要让 Tauri 知悉您刚创建的指令才能让其调用。 我们需要使用 .invoke_handler() 函数及 Generate_handler![] 宏来注册指令：

src-tauri/src/main.rs

fn main() {
  tauri::Builder::default()
    .invoke_handler(tauri::generate_handler![greet])
    .run(tauri::generate_context!())
    .expect("error while running tauri application");
}

现在您的前端可以调用刚注册的指令了！

使用 @tauri-apps/api JavaScript 库来调用新创建的命令， 通过 JavaScript 访问诸如窗口、文件系统等核心功能， 您可以使用自己喜欢的 JavaScript 包管理器来安装。

npm

npm install @tauri-apps/api@">1.0.0"

Yarn

yarn add @tauri-apps/api@^1.0.0

pnpm

pnpm add @tauri-apps/api@1

Bun

bun add @tauri-apps/api@1.0.0

安装依赖库后，我们现在可以创建一个新的 Svelte 组件。 我们将在 src/lib/Greet.svelte 中创建它：

src/lib/Greet.svelte

<script>
  import { invoke } from '@tauri-apps/api/tauri'

  let name = ''
  let greetMsg = ''

  async function greet() {
    greetMsg = await invoke('greet', { name })
  }
</script>

<div>
  <input id="greet-input" placeholder="Enter a name..." bind:value="{name}" />
  <button on:click="{greet}">Greet</button>
  <p>{greetMsg}</p>
</div>

您现在可以将此组件添加到 src/routes/+page.svelte:

src/routes/+page.svelte

<script>
  import Greet from '../lib/Greet.svelte'
</script>

<h1>Welcome to SvelteKit</h1>
<Greet />

You can now run this with npm run tauri dev and see the result:

提示

若您想要了解更多有关 Rust 和 JavaScript 之间通信的信息，请参阅 Tauri 进程间通信指南。