准备

getting-started.md


commit ccb1d87d6faa9ff528d22b96595a0e2cbb16c0f2

本书的第一部分将带领大家了解 Rust 及其工具。在安装 Rust 之后，我们将开始编写经典的“Hello World”程序。最后将介绍 Cargo —— Rust 的构建系统以及包管理器。

我们将会展示很多使用终端的命令，并且这些行都以$开头。你并不需要真正输入$，在这里它们代表每行指令的开头。你会在网上看到很多使用这个惯例的教程和例子：$代表常规用户运行的命令，#代表以管理员身份运行的命令。

安装 Rust

使用 Rust 的第一步是安装它。总的来说，你需要联网执行本部分的命令，因为我们要从网上下载 Rust。

Rust 编译器可以运行和编译在许多平台上，不过在 x86 和 x86-64 CPU 构架的 Linux、Mac 和 Windows 平台上的支持是最好的。对于这些和其他一些平台提供官方构建的 Rust 编译器和标准库。关于官方平台支持的全部细节请查看这个网站。

安装 Rust

在 Unix 类系统如 Linux 和 macOS 上，你只需打开终端并输入：

  1. $ curl https://sh.rustup.rs -sSf | sh

这样会下载一个脚本并开始安装。如果一切顺利，你将会看到：

  1. Rust is installed now. Great!

在 Windows 上安装也同样简单：下载并运行 rustup-init.exe。其会在终端中开始安装并在成功时显示以上信息。

如需其他安装选项和信息，请访问 Rust 官网的 install 页面。

卸载

卸载 Rust 跟安装它一样容易：

  1. $ rustup self uninstall

疑难解答

安装完 Rust 以后，我们可以打开 shell，并输入：

  1. $ rustc --version

你应该能看到版本号、提交的 hash 值和提交时间。

若如是，则 Rust 已成功安装！恭喜你！

若无效，这可能意味着 PATH 环境变量并没有包含 Cargo 可执行程序的路径，其在类 Unix 系统下是~/.cargo/bin，在 Windows 下是%USERPROFILE%\.cargo\bin。这是存放 Rust 开发工具的路径，绝大多数 Rust 程序员将它放在 PATH 系统变量中，以便于在命令行运行 rustc。根据操作系统或命令行 shell 的不同，以及安装过程的 bug，你可能需要重启 shell，注销系统，或者为你的操作环境手动配置合适的 PATH。

Rust 并没有自己的连接器，所以你需要自己装一个。做法因特定的系统而有所不同。对于 Linux 系统，Rust 会尝试调用cc进行连接。对于windows-msvc（在 Windows 上使用 Microsoft Visual Studio 构建的 Rust），则需要安装Microsoft Visual C++ Build Tools。其并不需要位于%PATH%中，因为rustc会自动找到他们。一般来说，如果你的连接器位于一个不常见的位置，你需要调用rustc linker=/path/to/cc，其中/path/to/cc指向连接器的路径。

如果还是搞不定，我们有许多可以获取帮助的地方。最简单的是 irc.mozilla.org 上的 IRC 频道 #rust-beginners 和供一般讨论之用的 #rust，我们可以使用 Mibbit 访问之。然后我们就可以和其他能提供帮助的 Rustacean（我们这些人自称的愚蠢绰号）聊天了。其它给力的资源包括用户论坛和Stack Overflow。

安装程序也会在本地安装一份文档拷贝，你可以离线阅读它们。只需输入rustup doc即可！

Hello, world!

现在你已经安装好了 Rust，我们将帮助你编写你的第一个 Rust 程序。当学习一门新语言的时候编写一个在屏幕上打印 “Hello, world!” 文本的小程序是一个传统，而在这一部分，我们将遵循这个传统。

以这样一个简单的程序开始的好处是你可以快速的确认你的编译器已正确安装，并可以正常工作。在屏幕上打印信息也是一个非常常见的操作，所以早点实践一下是有好处的。

注意：本书假设你熟悉基本的命令行操作。Rust 本身并不对你的编辑器，工具和你的代码存放在何处有什么特定的要求，所以如果你比起命令行更喜欢 IDE，这里也有一个选择。你可能想要试试SolidOak，它专为 Rust 而设计。在 Rust 社区里有许许多多正在开发中的 IDE 插件。Rust 团队也发布了不同编辑器的插件。 配置编辑器或 IDE 已超出本教程的范畴，所以请查看你特定设置的文档。

创建项目文件

首先，创建一个文件来编写 Rust 代码。Rust 并不关心你的代码存放在哪里，不过在本书中，我们建议在你的 home 目录创建一个存放项目的目录，并把你的所有项目放在这。打开一个终端并输入如下命令来为这个项目创建一个文件夹：

  1. $ mkdir ~/projects
  2. $ cd ~/projects
  3. $ mkdir hello_world
  4. $ cd hello_world

如果你使用 Windows 并且没有用 PowerShell，~可能不指向你的用户目录。可以查询所使用的 Shell 的相关文档以获取更多信息。

编写并运行 Rust 程序

我们需要为我们的 Rust 程序创建一个源文件。Rust 代码文件总是使用 .rs 后缀，并且如果我们用的 Rust 文件名由多个单词组成，我们使用下划线分隔它们；例如，使用my_program.rs而不是myprogram.rs。

现在，创建一个名叫main.rs的新文件。打开并输入如下代码：

  1. fn main() {
  2.     println!("Hello, world!");
  3. }

保存文件，并回到你的命令行窗口。在 Linux 或 OSX 上，输入如下命令：

  1. $ rustc main.rs
  2. $ ./main
  3. Hello, world!

在 Windows 下，使用main.exe而不是main。不管你使用何种系统，你应该在终端看到Hello, world!字符串。如果你做到了，那么恭喜你！你已经正式编写了一个 Rust 程序。你是一名 Rust 程序员了！欢迎入坑。

分析 Rust 程序

现在，让我们回过头来仔细看看你的“Hello, world!”程序到底发生了什么。这里是拼图的第一片：

  1. fn main() {
  3. }

这几行定义了一个 Rust 函数。main 函数是特殊的：这是所有 Rust 程序的开始。第一行表示“定义一个叫 main 的函数，没有参数也没有返回值。”如果有参数的话，它们应该出现在括号（(和)）中。因为并没有返回值，所以我们可以省略整个返回值类型。

同时注意函数体被包裹在大括号（{和}）中。Rust 要求所有函数体都位于其中。将前一个大括号与函数声明置于一行，并留有一个空格被认为是一个好的代码风格。

在main()函数中：

  1.     println!("Hello, world!");

这行代码做了这个小程序的所有工作：它在屏幕上打印文本。这有很多重要的细节。第一个是使用 4 个空格缩进，而不是制表符。

第二个重要的部分是println!()这一行。这是一个 Rust 宏，是 Rust 元编程的关键所在。相反如果我们调用一个函数的话，它应该看起来像这样：println()（没有 !）。我们将在后面更加详细的讨论 Rust 宏，不过现在你只需记住当看到符号 ! 的时候，就代表调用了一个宏而不是一个普通的函数。

接下来，"Hello, world!" 是一个字符串。在一门系统级编程语言中，字符串是一个复杂得令人惊讶的话题。这是一个静态分配的字符串。这个语句将这个字符串作为参数传递给println! 宏，这个宏负责在屏幕（控制台）上打印字符串。是不是很简单啊(⊙o⊙)

这一行以一个分号结尾（;）。Rust是一门面向表达式的语言，也就是说大部分语句都是表达式。; 表示一个表达式的结束，另一个新表达式的开始。大部分 Rust 代码行以;结尾。

编译和运行是两个步骤

在“编写并运行一个 Rust 程序”，我们展示了如何运行一个新创建的程序。现在我们将拆分并检查每一个操作。

在运行一个 Rust 程序之前，你必须编译它。你可以输入rustc命令来使用 Rust 编译器并像这样传递你源文件的名字：

  1. $ rustc main.rs

如果你来自 C 或 C++ 背景，你会发现这与gcc和clang类似。编译成功后，Rust 应该会输出一个二进制可执行文件，在 Linux 或 OSX 下在shell 中通过如下ls命令你可以看到它：

  1. $ ls
  2. main  main.rs

在 Windows 下，输入：

  1. $ dir
  2. main.exe
  3. main.rs

这表示我们有两个文件：.rs后缀的源文件，和可执行文件（在 Windows下是main.exe，其它平台是main）。这里我们剩下的操作就只有运行main或main.exe文件了，像这样：

  1. $ ./main  # or .\main.exe on Windows

如果main.rs是我们的“Hello, world!”程序，它将会在你的终端上打印Hello, world!。

来自 Ruby、Python 或 JavaScript 这样的动态类型语言背景的同学，可能不太习惯这样将编译和执行分开。Rust 是一种 预编译语言（ahead-of-time compiled language），程序编译好后，把它给任何人，他们都不需要安装 Rust 就可运行。如果你给他们一个 .rb ， .py 或 .js 文件，他们需要先分别安装 Ruby，Python，JavaScript 实现，不过你只需要一句命令就可以编译和执行你的程序。这一切都是语言设计的权衡取舍。

仅仅使用rustc编译简单程序是没问题的，不过随着你的项目的增长，你将想要能够控制你项目拥有的所有选项，并易于分享你的代码给别人或别的项目。接下来，我们将介绍一个叫做 Cargo 的工具，它将帮助你编写现实生活中的 Rust 程序。

Hello, Cargo!

Cargo 是 Rust 的构建系统和包管理工具，同时 Rustacean 们使用 Cargo 来管理它们的 Rust 项目。Cargo 负责三个工作：构建你的代码，下载你代码依赖的库并编译这些库。我们把你代码需要的库叫做“依赖（dependencies）”因为你的代码依赖他们。

最简单的 Rust 程序并没有任何依赖，所以目前我们只使用它的第一部分功能。随着你编写更加复杂的 Rust 程序，你会想要添加依赖，那么如果你使用 Cargo 开始的话，这将会变得简单许多。

因为绝大部分 Rust 项目使用 Cargo，本书接下来的部分将假设你使用它。如果你使用官方安装包的话，Rust 自带 Cargo。如果你使用其他方式安装 Rust 的话，你可以在终端输入如下命令检查你是否安装了 Cargo：

  1. $ cargo --version

如果你看到了版本号，一切 OK！如果你一个类似“command not found”的错误，那么你应该去查看你安装 Rust 的系统的相关文档，来确定 Cargo 是否需要单独安装。

转换到 Cargo

让我们将 Hello World 程序迁移至 Cargo。为了 Cargo 化一个项目，需要做三件事：

  1. 将源文件放到正确的目录
  2. 删除旧的可执行文件（Windows下是main.exe，其他平台是main）。
  3. 创建一个 Cargo 配置文件

让我们开始吧！

创建源文件目录并移除旧的可执行文件

首先，回到你的终端，移动到你的hello_world目录，并输入如下命令：

  1. $ mkdir src
  2. $ mv main.rs src/main.rs # or 'move main.rs src/main.rs' on Windows
  3. $ rm main  # or 'del main.exe' on Windows

Cargo 期望源文件位于 src 目录，所以先做这个。这样将项目顶级目录（在这里，是 hello_world）留给 README，license 信息和其他跟代码无关的文件。这样，Cargo 帮助你保持项目干净整洁。一切井井有条。

现在，移动main.rs到src目录，并删除你用rustc创建的编译过的文件。像往常一样，如果你使用 Windows，用main.exe代替main。

例子中我们继续使用main.rs作为源文件名是因为它创建了一个可执行文件。如果你想要创建一个库文件，使用lib.rs作为文件名。Cargo 使用这个约定来正确编译你的项目，不过如果你愿意的话也可以覆盖它。

创建配置文件

下一步，在hello_world目录创建一个文件，叫做Cargo.toml。

确保Cargo.toml的C是大写的，否则 Cargo 不知道如何处理配置文件。

这个文件使用TOML（Tom’s Obvious, Minimal Language）格式。 TOML 类似于 INI，不过有一些额外的改进之处，并且被用作 Cargo 的配置文件。

在这个文件中，输入如下信息：

  1. [package]
  3. name = "hello_world"
  4. version = "0.0.1"
  5. authors = [ "Your name <you@example.com>" ]

第一行的[package]表明下面的语句用来配置一个包。随着我们在这个文件增加更多的信息，我们会增加其他部分，不过现在，我们只有包配置。

另外三行设置了 Cargo 编译你的程序所需要知道的三个配置：包的名字，版本，和作者。

当你在Cargo.toml中添加完这些信息后，保存它以完成配置文件的创建。

构建并运行 Cargo 项目

当Cargo.toml文件位于项目的根目录时，我们就准备好可以构建并运行 Hello World 程序了！为此，我们输入如下命令：

  1. $ cargo build
  2.    Compiling hello_world v0.0.1 (file:///home/yourname/projects/hello_world)
  3. $ ./target/debug/hello_world
  4. Hello, world!

如果一切顺利，你应该再次看到Hello, world!出现在终端里。

你刚刚用cargo build构建了一个程序并用./target/debug/hello_world运行了它，不过你也可以用如下的一步操作cargo run来完成这两步操作：

  1. $ cargo run
  2.      Running `target/debug/hello_world`
  3. Hello, world!

run命令在你需要快速迭代项目时显得很有用。

注意这个例子并没有重新构建项目。Cargo 发现文件并没有被修改，所以它只是运行了二进制文件。如果你修改了源文件，Cargo 会在运行前重新构建项目，这样你将看到像这样的输出：

  1. $ cargo run
  2.    Compiling hello_world v0.0.1 (file:///home/yourname/projects/hello_world)
  3.      Running `target/debug/hello_world`
  4. Hello, world!

Cargo 检查任何项目文件是否被修改，并且只会在你上次构建后修改了他们才重新构建。

对于简单的项目，Cargo 并不比使用rustc要好多少，不过将来它会变得有用。这在你开始使用 crate 时显得尤为正确；（crate）在其他语言中有“库（library）”或“包（package）”这样的同义词。对于包含多个 crate 的项目，让 Cargo 来协调构建将会轻松很多。有了 Cargo，你可以运行cargo build，而一切将有条不紊的运行。

发布构建

当你的项目准备好发布了，可以使用cargo build --release来优化编译项目。这些优化可以让 Rust 代码运行的更快，不过启用他们会让程序花更长的时间编译。这也是为何这是两种不同的配置，一个为了开发，另一个构建提供给用户的最终程序。

那个Cargo.lock是什么？

运行这个命令同时也会让 Cargo 创建一个叫做Cargo.lock的文件，它看起来像这样：

  1. [root]
  2. name = "hello_world"
  3. version = "0.0.1"

Cargo 用Cargo.lock文件跟踪你程序的依赖。这里是 Hello World 项目的Cargo.lock文件。这个项目并没有依赖，所以内容有一点稀少。事实上，你自己甚至都不需要碰这个文件；仅仅让 Cargo 处理它就行了。

就是这样！如果你一路跟过来了，你应该已经成功使用 Cargo 构建了hello_world。

虽然这个项目很简单，现在它使用了很多在你余下的 Rust 生涯中将会用到的实际的工具。事实上，你可以期望使用如下命令的变体开始所有的 Rust 项目：

  1. $ git clone someurl.com/foo
  2. $ cd foo
  3. $ cargo build

创建新 Cargo 项目的简单方法

你并不需要每次都过一遍上面的操作来开始一个新的项目！Cargo 可以快速创建一个骨架项目目录这样你就可以立即开始开发了。

用 Cargo 来开始一个新项目，在命令行输入cargo new：

  1. $ cargo new hello_world --bin

这个命令传递了--bin参数因为我们的目标是直接创建一个可执行程序，而不是一个库。可执行文件通常叫做二进制文件（因为它们位于/usr/bin，如果你使用 Unix 系统的话）。

Cargo 为我们创建了两个文件和一个目录：一个Cargo.toml和一个包含了main.rs文件的src目录。这应该看起来很眼熟，他们正好是我们在之前手动创建的那样。

这些输出是你开始所需要的一切。首先，打开Cargo.toml。它应该看起来像这样：

  1. [package]
  3. name = "hello_world"
  4. version = "0.1.0"
  5. authors = ["Your Name <you@example.com>"]
  7. [dependencies]

不要担心[dependencies]那一行，之后我们会讲到。

Cargo 已经根据你给出的参数和git全局配置给出了合理的默认配置。你可能会注意到 Cargo 也把hello_world目录初始化为了一个git仓库。

这是应该写入src/main.rs的代码：

  1. fn main() {
  2.     println!("Hello, world!");
  3. }

Cargo 已经为你生成了一个“Hello World!”，现在你已经准备好开始撸代码了！

注意：如果你想要查看 Cargo 的详细信息，请查看官方的Cargo 指导，它包含了所有这些功能。

写在最后

本章涵盖了将用于本书余下部分以及你之后 Rust 时光的基础知识。现在你获得了工具，我们将更多地介绍 Rust 语言本身。

接下来你有两个选择：在 “学习 Rust” 中深入研究一个项目，或者自下而上地学习 “语法和语义”。来自系统级编程语言的同学，你们可能倾向于选择 “学习 Rust”，而来自动态编程语言的同学，请根据自己的喜好来选择吧。人各有别，适合自己的才是最好的。