Hello, World!

ch01-02-hello-world.md
commit 4f2dc564851dc04b271a2260c834643dfd86c724

Rust 已安好,让我们来编写第一个程序。当学习一门新语言的时候,使用该语言在屏幕上打印 “Hello, world!” 是一项传统,我们将遵循这个传统。

注意:本书假设你熟悉基本的命令行操作。对于你的编辑器、工具,以及你的代码存在何处,Rust 并没有特殊要求,如果你更喜欢 IDE,请随意。

创建项目文件夹

首先,创建一个存放代码的文件夹。Rust 并不关心它的位置,不过在本书中,我们建议你在 home 目录中创建一个 projects 目录,并把你的所有项目放在这。打开一个终端,输入如下命令来创建一个文件夹:

Linux 和 Mac:

$ mkdir ~/projects
$ cd ~/projects
$ mkdir hello_world
$ cd hello_world

Windows:

> mkdir %USERPROFILE%\projects
> cd %USERPROFILE%\projects
> mkdir hello_world
> cd hello_world

编写并运行 Rust 程序

接下来,新建一个叫做 main.rs 的文件。Rust 源代码总是以 .rs 后缀结尾。如果文件名包含多个单词,使用下划线分隔它们。例如 my_program.rs,而不是 myprogram.rs

现在打开刚创建的 main.rs 文件,输入如下代码:

Filename: main.rs

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

保存文件,并回到终端窗口。在 Linux 或 OSX 上,输入如下命令:

$ rustc main.rs
$ ./main
Hello, world!

在 Windows 上,运行 .\main.exe,而不是./main。不管使用何种系统,你应该在终端看到 Hello, world! 字样。如果你做到了,恭喜你!你已经正式编写了一个 Rust 程序,成为一名 Rust 程序员!

分析 Rust 程序

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

fn main() {

}

这几行定义了一个 Rust 函数。一个叫 main 的函数,没有参数也没有返回值。如果有参数的话,它们应该出现在括弧中,()之间。main 函数是特殊的:它是每一个可执行的 Rust 程序的入口点。

还须注意函数体被包裹在花括号中,{} 之间。所有函数体都要用花括号包裹起来(译者注:有些语言,当函数体只有一行时可以省略花括号,但 Rust 中是不行的)。一般来说,将左花括号与函数声明置于一行,并以空格分隔,是良好的代码风格。

main() 函数中:

    println!("Hello, world!");

一行代码完成这个小程序的所有工作:在屏幕上打印文本。这里有很多细节需要注意。首先 Rust 使用 4 个空格的缩进风格,而不是 1 个制表符(tab)。

第二个重要的部分是println!()。这是 ,Rust 元编程(metaprogramming)的关键所在。而调用一个函数,则要像这样:println(没有!)。我们将在 21 章 E 小节中更加详细的讨论宏,现在你只需记住,当看到符号 ! 的时候,调用的是宏而不是普通函数。

接下来,"Hello, world!" 是一个 字符串。我们把这个字符串作为一个参数传递给println!,它负责在屏幕上打印这个字符串。轻松加愉快!(⊙o⊙)

该行以分号结尾(;)。; 代表一个表达式的结束和下一个表达式的开始。大部分 Rust 代码行以 ; 结尾。

编译和运行是两个步骤

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

运行一个 Rust 程序之前,必须先编译它。可以通过 rustc 命令来使用 Rust 编译器,并传递源文件的名字给它,如下:

$ rustc main.rs

如果你有 C 或 C++ 背景,就会发现这与 gccclang 类似。编译成功后,Rust 应该会输出一个二进制可执行文件,在 Linux 或 OSX 上在 shell 中你可以通过ls命令看到如下:

$ ls
main  main.rs

在 Windows 上,输入:

> dir /B %= the /B option says to only show the file names =%
main.exe
main.rs

这表示我们有两个文件:.rs 后缀的源文件,和可执行文件(在 Windows下是 main.exe,其它平台是 main)。然后运行 mainmain.exe 文件,像这样:

$ ./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 实现(运行时环境,VM),不过你只需要一句命令就可以编译和执行程序。这一切都是语言设计上的权衡取舍。

使用 rustc 编译简单程序是没问题的,不过随着项目的增长,你可能需要控制你项目的方方面面,并且更容易地将代码分享给其它人或项目。所以接下来,我们要介绍一个叫做 Cargo 的工具,它会帮助你编写真实世界中的 Rust 程序。

Hello, Cargo!

Cargo 是 Rust 的构建系统和包管理工具,同时 Rustacean 们使用 Cargo 来管理他们的 Rust 项目,它使得很多任务变得更轻松。例如,Cargo 负责构建代码、下载依赖库并编译。我们把代码需要的库叫做 依赖dependencies)。

最简单的 Rust 程序,比如我们刚刚编写的,并没有任何依赖,所以我们只使用了 Cargo 构建代码的功能。随着更复杂程序的编写,你会想要添加依赖,如果你使用 Cargo 开始的话,这将会变得简单许多。

由于绝大部分 Rust 项目使用 Cargo,本书接下来的部分将假设你使用它。如果使用之前介绍的官方安装包的话,它自带 Cargo。如果通过其他方式安装的话,可以在终端输入如下命令,检查是否安装了 Cargo:

$ cargo --version

如果出现了版本号,一切 OK!如果出现类似“command not found”的错误,你应该查看安装文档以确定如何单独安装 Cargo。

使用 Cargo 创建项目

让我们使用 Cargo 来创建一个新项目,然后看看与上面的hello_world项目有什么不同。回到 projects 目录(或者任何你放置代码的目录):

Linux 和 Mac:

$ cd ~/projects

Windows:

> cd %USERPROFILE%\projects

并在任何操作系统运行:

$ cargo new hello_cargo --bin
$ cd hello_cargo

我们向 cargo new 传递了 --bin,因为我们的目标是生成一个可执行程序,而不是一个库。可执行程序是二进制可执行文件,通常就叫做 二进制文件binaries)。项目的名称被定为hello_cargo,同时 Cargo 在一个同名目录中创建它的文件,接着我们可以进入查看。

如果列出 hello_cargo 目录中的文件,将会看到 Cargo 生成了一个文件和一个目录:一个 Cargo.toml 文件和一个 src 目录,main.rs 文件位于目录中。它也在 hello_cargo 目录初始化了一个 git 仓库,以及一个 .gitignore 文件;你可以通过--vcs参数,切换到其它版本控制系统(VCS),或者不使用 VCS。

使用文本编辑器(IDE)打开 Cargo.toml 文件。它应该看起来像这样:

Filename: Cargo.toml

[package]
name = "hello_cargo"
version = "0.1.0"
authors = ["Your Name <you@example.com>"]

[dependencies]

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

第一行,[package],是一个段落标题,表明下面的语句用来配置一个包。随着我们在这个文件增加更多的信息,还将增加其他段落。

最后一行,[dependencies],是项目依赖的 crates(Rust 代码包)的段落的开始,这样 Cargo 就知道下载和编译它们了。这个项目并不需要任何其他的 crate,不过在下一章猜猜看教程会需要。

现在看看 src/main.rs

Filename: src/main.rs

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

Cargo 为你生成了一个“Hello World!”,正如我们之前编写的那个!目前为止,之前项目与 Cargo 生成项目区别有:

  • 代码位于 src 目录
  • 项目根目录包含一个 Cargo.toml 配置文件

Cargo 期望源文件位于 src 目录,将项目根目录留给 README、license 信息、配置文件和其他跟代码无关的文件。这样,Cargo 帮助你保持项目干净整洁,一切井井有条。

如果没有用 Cargo 创建项目,比如 hello_world 目录中的项目,可以通过将代码放入 src 目录,并创建一个合适的 Cargo.toml,将其转化为一个 Cargo 项目。

构建并运行 Cargo 项目

现在让我们看看通过 Cargo 构建和运行 Hello World 程序有什么不同。为此,输入如下命令:

$ cargo build
   Compiling hello_cargo v0.1.0 (file:///projects/hello_cargo)

这应该创建 target/debug/hello_cargo(或者在 Windows 上是 target\debug\hello_cargo.exe)可执行文件,可以通过这个命令运行:

$ ./target/debug/hello_cargo # or .\target\debug\hello_cargo.exe on Windows
Hello, world!

好的!如果一切顺利,Hello, world!应该再次打印在终端上。

首次运行 cargo build 的时候,Cargo 会在项目根目录创建一个新文件,Cargo.lock,它看起来像这样:

Filename: Cargo.lock

[root]
name = "hello_cargo"
version = "0.1.0"

Cargo 使用 Cargo.lock 来记录程序的依赖。这个项目并没有依赖,所以内容比较少。事实上,你自己永远也不需要碰这个文件,让 Cargo 处理它就行了。

我们刚刚使用 cargo build 构建了项目并使用 ./target/debug/hello_cargo 运行了它,也可以使用 cargo run 编译并运行:

$ cargo run
     Running `target/debug/hello_cargo`
Hello, world!

注意这一次并没有出现“正在编译 hello_cargo”的输出。Cargo 发现文件并没有被改变,直接运行了二进制文件。如果修改了源文件的话,将会出现像这样的输出:

$ cargo run
   Compiling hello_cargo v0.1.0 (file:///projects/hello_cargo)
     Running `target/debug/hello_cargo`
Hello, world!

所以现在又出现更多的不同:

  • 使用 cargo build 构建项目(或使用 cargo run 一步构建并运行),而不是使用rustc
  • 有别于将构建结果放在源码目录,Cargo 将它放到 target/debug 目录。

Cargo 的另一个优点是,不管你使用什么操作系统,它的命令都是一样的,所以之后我们将不再为 Linux 和 Mac 以及 Windows 提供相应的命令。

发布构建

当项目最终准备好发布了,可以使用 cargo build --release 来优化编译项目。这会在 target/release 下生成可执行文件,而不是 target/debug。优化可以让 Rust 代码运行的更快,然而也需要更长的编译时间。因此产生了两种不同的配置:一种为了开发,你需要快速重新构建;另一种构建给用户的最终程序,不会重新构建,并且程序运行得越快越好。如果你在测试代码的运行时间,请确保运行 cargo build --release 并使用 target/release 下的可执行文件。

把 Cargo 当作习惯

对于简单项目, Cargo 并不比 rustc 更有价值,不过随着开发的进行终将体现它的价值。对于拥有多个 crate 的复杂项目,让 Cargo 来协调构建将更简单。有了 Cargo,只需运行cargo build,然后一切将有序运行。即便这个项目很简单,也它使用了很多你之后的 Rust 生涯将会用得上的实用工具。其实你可以开始任何你想要从事的项目,使用下面的命令:

$ git clone someurl.com/someproject
$ cd someproject
$ cargo build

注意:如果想要了解 Cargo 更多的细节,请阅读官方的 Cargo guide,它覆盖了所有的功能。