在 Visual Studio Code 中使用 Rust

Rust 是一种功能强大的编程语言，常用于系统编程，其中性能和正确性是高度优先考虑的事项。如果您是 Rust 新手并想了解更多信息，在线书籍《Rust 编程语言》是一个很好的入门资源。本主题将详细介绍如何在 Visual Studio Code 中设置和使用 Rust，以及 rust-analyzer 扩展。

安装

1. 安装 Rust

首先，您需要在计算机上安装 Rust 工具集。Rust 通过 rustup 安装程序安装，该程序支持在 Windows、macOS 和 Linux 上安装。请按照适用于您平台的 rustup 安装指南进行操作，注意安装构建和运行 Rust 程序所需的任何额外工具。

2. 安装 rust-analyzer 扩展

您可以通过 VS Code 中的“扩展”视图（⇧⌘X (Windows、Linux Ctrl+Shift+X)）搜索“rust-analyzer”来查找和安装 rust-analyzer 扩展。您应该安装发布版本。

我们将在本主题中讨论许多 rust-analyzer 功能，但您也可以参考扩展的文档：https://rust-analyzer.github.io。

检查您的安装

安装 Rust 后，您可以打开新的终端/命令提示符并键入以下内容来检查是否一切都已正确安装：

rustc --version

这将输出 Rust 编译器的版本。如果您想要更多详细信息，可以添加 --verbose 参数。如果您遇到问题，可以查阅 Rust 安装指南。

您可以通过运行以下命令使 Rust 安装保持最新版本：

rustup update

Rust 每 6 周发布一次新的稳定版本，因此这是一个好习惯。

本地 Rust 文档

安装 Rust 时，您还会获得完整 Rust 文档集的本地安装，您可以通过键入 rustup doc 进行查看。Rust 文档，包括《Rust 编程语言》和《Cargo Book》，将在您的本地浏览器中打开，以便您在离线时继续您的 Rust 之旅。

Hello World

Cargo

当您使用 rustup 安装 Rust 时，工具集包括 rustc 编译器、rustfmt 源代码格式化程序和 clippy Rust linter。您还会获得 Cargo（Rust 包管理器），以帮助下载 Rust 依赖项以及构建和运行 Rust 程序。您会发现使用 Rust 时几乎所有事情都会用到 cargo。

Cargo new

创建第一个 Rust 程序的好方法是使用 Cargo 来搭建新项目框架，方法是键入 cargo new。这将创建一个简单的 Hello World 程序以及默认的 Cargo.toml 依赖项文件。您将要创建项目的文件夹传递给 cargo new。

让我们创建 Hello World。导航到您想要创建项目的文件夹并键入：

cargo new hello_world

要在 VS Code 中打开新项目，请导航到新文件夹并通过 code . 启动 VS Code

cd hello_world
code .

cargo new 创建一个简单的 Hello World 项目，其中包含一个 main.rs 源代码文件和一个 Cargo.toml Cargo 清单文件。

src\
    main.rs
.gitignore
Cargo.toml

main.rs 包含程序的入口函数 main()，并使用 println! 向控制台打印“Hello, world!”。

fn main() {
    println!("Hello, world!");
}

这个简单的 Hello World 程序没有任何依赖项，但您可以在 [dependencies] 下添加 Rust 包（crate）引用。

Cargo build

Cargo 可用于构建您的 Rust 项目。打开新的 VS Code 集成终端（⌃⇧` (Windows、Linux Ctrl+Shift+`)）并键入 cargo build。

cargo build

您现在将有一个 target\debug 文件夹，其中包含构建输出，包括一个名为 hello_world.exe 的可执行文件。

运行 Hello World

Cargo 也可以通过 cargo run 来运行您的 Rust 项目。

cargo run

您也可以通过在终端中键入 .\target\debug\hello_world 来手动运行 hello_world.exe。

IntelliSense

IntelliSense 功能由 Rust 语言服务器 rust-analyzer 提供，它提供详细的代码信息和智能建议。

当您第一次打开 Rust 项目时，可以在状态栏左下角查看 rust-analyzer 的进度。您需要等待 rust-analyzer 完全审阅完项目，才能获得语言服务器的全部功能。

内联提示

您可能首先注意到的是 rust-analyzer 提供内嵌提示，在编辑器中以浅色文本显示推断类型、返回值和命名参数。

虽然内嵌提示有助于理解代码，但您也可以通过编辑器 > 内嵌提示：启用设置（editor.inlayHints.enabled）配置此功能。

悬停信息

将鼠标悬停在任何变量、函数、类型或关键字上都会为您提供有关该项的信息，例如文档、签名等。您也可以跳转到您自己的代码或标准 Rust 库中的类型定义。

自动完成

当您在 Rust 文件中键入时，IntelliSense 会为您提供建议的完成和参数提示。

语义语法高亮

由于 rust-analyzer 对项目源代码的深入理解，它能够使用语义语法高亮显示和样式设置。例如，您可能已经注意到可变变量在编辑器中带有下划线。

能够快速判断哪些 Rust 变量是可变或不可变的有助于您理解源代码，但您也可以使用 VS Code editor.semanticTokenColorCustomizations 设置在您的用户设置中更改样式。

在 settings.json 中，您将添加：

{
  "editor.semanticTokenColorCustomizations": {
    "rules": {
      "*.mutable": {
        "fontStyle": "", // set to empty string to disable underline, which is the default
      },
    }
  },
}

您可以在 rust-analyzer 文档的编辑器功能部分了解有关 rust-analyzer 语义语法自定义的更多信息。

代码导航

代码导航功能可在编辑器的上下文菜单中找到。

• 转到定义 F12 - 转到类型定义的源代码。
• 查看定义 ⌥F12 (Windows Alt+F12, Linux Ctrl+Shift+F10) - 打开一个包含类型定义的查看窗口。
• 转到引用 ⇧F12 (Windows、Linux Shift+F12) - 显示该类型的所有引用。
• 显示调用层次结构 ⇧⌥H (Windows、Linux Shift+Alt+H) - 显示从函数或对函数的所有调用。

您可以通过命令面板 (⇧⌘P (Windows、Linux 为 Ctrl+Shift+P)) 中的转到符号命令来进行符号搜索导航。

• 转到文件中的符号 - ⇧⌘O (Windows、Linux Ctrl+Shift+O)
• 转到工作区中的符号 - ⌘T (Windows、Linux Ctrl+T)

代码检查

Rust 工具集包括由 rustc 和 clippy 提供的 linting，用于检测源代码中的问题。

默认启用的 rustc linter 可检测基本的 Rust 错误，但您可以使用 clippy 来获得更多 lint。要在 rust-analyzer 中启用 clippy 集成，请将Rust-analyzer > Check: Command (rust-analyzer.check.command) 设置更改为 clippy 而不是默认的 check。rust-analyzer 扩展现在将在您保存文件时运行 cargo clippy，并在编辑器和“问题”视图中直接显示 clippy 警告和错误。

快速修复

当 linter 在源代码中发现错误和警告时，rust-analyzer 通常可以提供建议的快速修复（也称为代码操作），可通过编辑器中的灯泡悬停获得。您可以通过 ⌘. (Windows、Linux Ctrl+.) 快速打开可用的快速修复。

此外，代码操作小组件：包含附近的快速修复 (editor.codeActionWidget.includeNearbyQuickFixes) 是一个默认启用的设置，它会从 ⌘. (Windows、Linux 为 Ctrl+.) (命令 ID editor.action.quickFix) 激活一行中最近的快速修复，无论您的光标在该行的哪个位置。

该命令会突出显示将通过快速修复进行重构或修复的源代码。普通代码操作和非修复重构仍可在光标位置激活。

重构

由于 rust-analyzer 对源代码的语义理解，它还可以在您的 Rust 文件中提供智能重命名。将光标放在变量上，从上下文菜单、命令面板或通过 F2 选择重命名符号。

rust-analyzer 扩展还支持其他代码重构和代码生成，扩展称之为辅助。

这里只是可用重构中的几个

• 将 if 语句转换为带守卫的返回
• 内联变量
• 提取函数
• 添加返回类型
• 添加导入

格式化

Rust 工具集包括一个格式化程序 rustfmt，它可以格式化您的源代码以符合 Rust 约定。您可以使用 ⇧⌥F (Windows Shift+Alt+F, Linux Ctrl+Shift+I) 格式化您的 Rust 文件，或通过命令面板或编辑器中的上下文菜单运行格式化文档命令。

您还可以选择在每次保存（Editor: Format On Save）或粘贴（Format On Paste）时运行格式化程序，以便在您工作时自动保持 Rust 代码正确格式化。

调试

rust-analyzer 扩展支持在 VS Code 中调试 Rust。

安装调试支持

要开始调试，您首先需要安装以下两个具有调试支持的语言扩展之一：

• Microsoft C++ (ms-vscode.cpptools) – 在 Windows 上
• CodeLLDB (vadimcn.vscode-lldb) – 在 macOS/Linux 上

如果您忘记安装其中一个扩展，当您尝试开始调试会话时，rust-analyzer 将提供一个通知，其中包含指向 VS Code Marketplace 的链接。

使用 Rust Analyzer: Debug

rust-analyzer 扩展通过Rust Analyzer: Debug命令提供基本的调试支持，该命令可在命令面板（⇧⌘P (Windows、Linux Ctrl+Shift+P)）和编辑器中的运行|调试 CodeLens 中获得。

让我们调试我们之前创建的 Hello World 程序。首先，我们将在 main.rs 中设置一个断点。

1. 您需要启用设置Debug: Allow Breakpoints Everywhere，您可以在设置编辑器中（⌘, (Windows、Linux Ctrl+,)）通过搜索“everywhere”找到。

   

2. 打开 main.rs 并在编辑器的左侧装订线单击，在 println! 行设置一个断点。它应该显示为一个红点。

   

3. 要开始调试，请使用Rust Analyzer: Debug命令或选择 main() 上方的Debug CodeLens。

   

后续步骤

这是对 VS Code 中 rust-analyzer 扩展功能的简要概述。有关更多信息，请参阅 Rust Analyzer 扩展用户手册中提供的详细信息，包括如何调整特定的 VS Code 编辑器配置。

要了解 rust-analyzer 扩展的最新功能/错误修复，请参阅更新日志。您还可以通过在“扩展”视图的安装下拉列表中安装 rust-analyzer 预发布版本来试用新功能和修复。

如果您有任何问题或功能请求，请随时在 rust-analyzer 扩展 GitHub 仓库中记录它们。

如果您想了解更多关于 VS Code 的信息，请尝试以下主题：

• 基本编辑 - 快速介绍 VS Code 编辑器的基础知识。
• 安装扩展 - 了解在市场中可用的其他扩展。
• 代码导航 - 快速浏览您的源代码。

常见问题

链接器错误

如果您在尝试构建 Rust 程序时看到链接器错误，例如"error: linker link.exe not found"，则您可能缺少必要的 C/C++ 工具集。根据您的平台，您需要安装一个包含 C/C++ 链接器的工具集来组合 Rust 编译器输出。

Windows

在 Windows 上，您还需要安装 Microsoft C++ Build Tools 才能获得 C/C++ 链接器 link.exe。请务必在运行 Visual Studio 安装程序时选择使用 C++ 的桌面开发。

macOS

您可能需要通过在终端中运行 xcode-select --install 来安装 XCode 工具集。

Linux

您可能需要通过在终端中运行 sudo apt-get install build-essential 来安装 GCC 工具集（通过 build-essential 包）。

有关进一步的故障排除建议，请参阅 Rust 安装指南。