嵌入外部二进制文件

您可能需要嵌入依赖的二进制文件才能使您的应用程序正常工作，或防止用户安装额外的依赖项（例如，Node.js 或 Python）。我们将此二进制文件称为sidecar。

要捆绑您选择的二进制文件，您可以将externalBin属性添加到tauri.conf.json文件中的tauri > bundle对象中。

在此处查看更多关于tauri.conf.json配置的信息 这里。

externalBin 期望一个字符串列表，用于指定具有绝对路径或相对路径的二进制文件。

以下示例说明了配置。这不是完整的tauri.conf.json文件

{
  "tauri": {
    "bundle": {
      "externalBin": [
        "/absolute/path/to/sidecar",
        "relative/path/to/binary",
        "binaries/my-sidecar"
      ]
    },
    "allowlist": {
      "shell": {
        "sidecar": true,
        "scope": [
          { "name": "/absolute/path/to/sidecar", "sidecar": true },
          { "name": "relative/path/to/binary", "sidecar": true },
          { "name": "binaries/my-sidecar", "sidecar": true }
        ]
      }
    }
  }
}

在指定路径上必须存在一个名称相同且带有-$TARGET_TRIPLE后缀的二进制文件。例如，"externalBin": ["binaries/my-sidecar"] 在 Linux 上需要一个src-tauri/binaries/my-sidecar-x86_64-unknown-linux-gnu 可执行文件。您可以通过查看rustc -Vv命令报告的host:属性来查找**当前**平台的目标三元组。

如果grep和cut命令可用（大多数 Unix 系统上都应该可用），您可以使用以下命令直接提取目标三元组

rustc -Vv | grep host | cut -f2 -d' '

在 Windows 上，您可以使用 PowerShell。

rustc -Vv | Select-String "host:" | ForEach-Object {$_.Line.split(" ")[1]}

这是一个用于将目标三元组附加到二进制文件的 Node.js 脚本

const execa = require('execa')
const fs = require('fs')

let extension = ''
if (process.platform === 'win32') {
  extension = '.exe'
}

async function main() {
  const rustInfo = (await execa('rustc', ['-vV'])).stdout
  const targetTriple = /host: (\S+)/g.exec(rustInfo)[1]
  if (!targetTriple) {
    console.error('Failed to determine platform target triple')
  }
  fs.renameSync(
    `src-tauri/binaries/sidecar${extension}`,
    `src-tauri/binaries/sidecar-${targetTriple}${extension}`
  )
}

main().catch((e) => {
  throw e
})

从 JavaScript 中运行

在 JavaScript 代码中，导入shell模块上的Command类并使用sidecar静态方法。

请注意，您必须配置允许列表以启用shell > sidecar并配置shell > scope中的所有二进制文件。

import { Command } from '@tauri-apps/api/shell'
// alternatively, use `window.__TAURI__.shell.Command`
// `binaries/my-sidecar` is the EXACT value specified on `tauri.conf.json > tauri > bundle > externalBin`
const command = Command.sidecar('binaries/my-sidecar')
const output = await command.execute()

从 Rust 中运行

在 Rust 端，从tauri::api::process模块导入Command结构体

// `new_sidecar()` expects just the filename, NOT the whole path like in JavaScript
let (mut rx, mut child) = Command::new_sidecar("my-sidecar")
  .expect("failed to create `my-sidecar` binary command")
  .spawn()
  .expect("Failed to spawn sidecar");

tauri::async_runtime::spawn(async move {
  // read events such as stdout
  while let Some(event) = rx.recv().await {
    if let CommandEvent::Stdout(line) = event {
      window
        .emit("message", Some(format!("'{}'", line)))
        .expect("failed to emit event");
      // write to stdin
      child.write("message from Rust\n".as_bytes()).unwrap();
    }
  }
});

请注意，您必须启用**process-command-api** Cargo 功能（一旦您更改了配置，Tauri 的 CLI 会为您执行此操作）

# Cargo.toml
[dependencies]
tauri = { version = "1", features = ["process-command-api", ...] }

传递参数

您可以像运行普通Command一样向 Sidecar 命令传递参数（参见 限制对命令 API 的访问）。

首先，在tauri.conf.json中定义需要传递给 Sidecar 命令的参数

{
  "tauri": {
    "bundle": {
      "externalBin": [
        "/absolute/path/to/sidecar",
        "relative/path/to/binary",
        "binaries/my-sidecar"
      ]
    },
    "allowlist": {
      "shell": {
        "sidecar": true,
        "scope": [
          {
            "name": "binaries/my-sidecar",
            "sidecar": true,
            "args": [
              "arg1",
              "-a",
              "--arg2",
              {
                "validator": "\\S+"
              }
            ]
          }
        ]
      }
    }
  }
}

然后，要调用 sidecar 命令，只需将**所有**参数作为数组传递。

import { Command } from '@tauri-apps/api/shell'
// alternatively, use `window.__TAURI__.shell.Command`
// `binaries/my-sidecar` is the EXACT value specified on `tauri.conf.json > tauri > bundle > externalBin`
// notice that the args array matches EXACTLY what is specified on `tauri.conf.json`.
const command = Command.sidecar('binaries/my-sidecar', [
  'arg1',
  '-a',
  '--arg2',
  'any-string-that-matches-the-validator',
])
const output = await command.execute()

在 Sidecar 上使用 Node.js

Tauri sidecar 示例 演示了如何使用 sidecar API 在 Tauri 上运行 Node.js 应用程序。它使用 pkg 编译 Node.js 代码，并使用上面的脚本运行它。