Next.js

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

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

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

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

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

创建前端

Next.js 是一款支持服务端渲染 (SSR) 和静态网站生成 (SSG) 的 React 框架。 由于 Tauri 仅能接受 Next.js 所生成的静态文件，我们将使用 Next.js 的静态网站生成模式。

Next.js 自带的脚手架工具类似于 create-tauri-app，可以从许多预定义模板中快速创建新项目。在本指南中，我们将使用建议的默认设置来解决所有问题，包括 TypeScript 支持和 v13.4 中稳定的新 App Router 功能。如果您使用旧的 routes/ 目录代替或在 app/ 目录之上使用，您仍然需要按照 Next.js静态导出Next.js 静态导出部分的说明更改配置，但您使用Tauri特定 JS API 的方式将与下文所述不同。

1. Project name
   这将是项目的名称。它与本实用程序将创建的文件夹名称相对应，但对应用程序没有其他影响。 您可以在此处填写任何您想要的名称。

Next.js静态导出

由于 Tauri 没有 Node.js 运行时，因此必须将 Next.js 设置为 SSG/SPA 模式。这通常会加快页面加载速度，但也有一些需要注意的地方，因此我们建议您仔细阅读 Next.js 关于静态导出的官方文档。

这些文档还显示了 Tauri + Next.js 应用程序必须进行的一项配置更改。为此，请编辑项目根目录中的 next.config.js 文件并添加以下内容：

/** @type {import('next').NextConfig} */
const nextConfig = {
  output: 'export',
}

module.exports = nextConfig

这将改变next build的行为，生成一个包含应用程序 HTML/CSS/JS 资产的 out/ 文件夹，而不是将它们写入 Next.js 运行时专用的 .next/ 目录。

还有一些可能的配置选项，请务必阅读上述静态导出文档，并根据项目需要调整配置文件。

创建 Rust 项目

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

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

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

它会向您询问几个问题：

1. 您应用的名字是什么？
   这将会是您打包后和操作系统会调用的应用名称。 您可以在此处填写任何您想要的名称。
2. 窗口标题叫什么？
   这将会是您主窗口的默认标题。 您可以在此处填写任何您想要的名称。
3. 前端页面资源 (HTML/CSS/JS) 相对于 <current dir>/src-tauri/tauri.conf.json 文件将被创建的位置？
   这是 生产环境时tauri加载web前端资源的目录.
   此值使用../out。
4. 开发环境时的加载路径?
   可以是一个网络地址也可以是一个文件路径 开发.
   此值使用http://localhost:3000。
5. 你将使用什么命令来开发前端页面？
   这是启动前端开发服务器的命令。
   此值使用npm run dev(请确保将其调整为使用您选择的软件包管理器)。
6. 你将使用什么命令来构建前端页面？
   这是构建前端文件的命令。

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

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

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

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

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

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

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

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

现在我们的前端已经构建完成，Rust 项目也已初始化完毕。您马上就可以运行您的应用了！ 您的 tauri.conf.json 文件看起来像这样：

{
  "build": {
    "beforeBuildCommand": "npm run build",
    "beforeDevCommand": "npm run dev",
    "devPath": "http://localhost:3000",
    "distDir": "../out"
  },

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

调用指令

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

以下是一个简单示例：

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

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

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

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 包管理器来安装。

需要注意的重要一点是，所有 Tauri 的 JS API 都需要访问浏览器专用 API，这意味着它们只能在客户端组件中使用。如果你不需要服务器组件，你可以在 app/page.tsx 文件的顶部添加'use client'，但在本指南中，我们将创建一个单独的组件，这样就不必转换整个应用程序。

'use client'

import { useEffect } from 'react'
import { invoke } from '@tauri-apps/api/tauri'

export default function Greet() {
  useEffect(() => {
    invoke<string>('greet', { name: 'Next.js' })
      .then(console.log)
      .catch(console.error)
  }, [])

  // Necessary because we will have to use Greet as a component later.
  return <></>
}

现在，我们将在 app/page.tsx 中的默认Home组件中使用该组件。请注意，它必须位于实际的组件树中，而且只要父组件（在本例中是Home组件）是服务器组件，它就不能是一个简单的函数调用。

// ...
import Greet from './greet'

export default function Home() {
  return (
    <main className="flex min-h-screen flex-col items-center justify-between p-24">
      <Greet />
      ...
    </main>
  )
}