Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

1.3 Rust Cargo

1.3.0. 回顾

1.2. Rust的基本认识与打印“Hello World”文章的末尾提到了只有小型简单的Rust项目适合使用rustc来编译，大型项目需要Cargo,本篇就对Cargo进行详细的介绍

1.3.1. 什么是Cargo

Cargo是Rust的构建系统和包管理工具，它的功能有构建代码、下载依赖的库、构建这些库…

在安装Rust时就顺带安装了Cargo。判断Cargo是否正确地安装：在终端中输入命令cargo --version

1.3.2. 使用Cargo创建项目

RustRover中创建的项目都会自动配置Cargo，在左侧项目结构中就能看到叫做Cargo.toml文件

对于非RustRover用户，可以在终端中配置Cargo：

  • 复制想要Cargo所在的文件夹路径，打开终端，输入命令cd 想要的路径
  • 接着输入命令cargo new 想要的项目名来创建项目
  • 在IDE中打开这个路径即可，项目在你取的Cargo项目名文件夹下

最后的项目结构应该是这样： PS: 有一些IDE不会有target这个文件夹和 Cargo.lock这个文件，在第一次编译后才会出现

解析项目结构：

  • src是Source Code的缩写，这个文件夹下存储的是你的代码

  • .gitignore说明在创建这个项目的同时已经初始化了一个Git仓库。当然也可以使用其他VCS（Version Control System版本控制系统）或是不使用VCS，只需要在创建项目(cargo new 想要的项目名这一步)时加上--vcs进行设置即可

  • Cargo.toml的内容会在下文阐述

1.3.3. Cargo.toml

.toml(Tom’s Obvious, Minimal Language)格式是Cargo的配置文件格式

其内容如下：

内容解析:

  • [pakage]是一个区域标题，表示下方的内容是用来配置包(package)的

    • name指项目名
    • version指项目版本
    • authors指项目作者，可有可无这里没有，有的话这一行格式应为: authors = ["your_name <your_email@xxx.com>"]
    • edition是指使用的Rust版本

  • [dependencies]是另一个区域标题，下方内容是用来配置依赖项(dependencies)的,它会列出项目的依赖项。没有依赖项下边就是空的。

PS:在Rust里，代码的包(库)被称作crate

1.3.4. 项目结构的格式

  • 所有的源代码都应该在src目录下
  • Cargo.toml应在顶层目录下
  • 顶层目录可以放置的东西:README、许可证、配置文件等与源码无关的文件

1.3.5. 非Cargo项目转化为使用Cargo

  • 把源代码移动到src目录下
  • 创建Cargo.toml，然后根据源代码填写配置

1.3.6. 构建Cargo项目

  • 复制Cargo项目所在的文件夹路径，打开终端，输入命令cd Cargo项目路径

  • 输入命令cargo build。这个命令会创建可执行文件，在Windows上，其路径在target\debug\你的Cargo项目名.exe;在Linux/MacOS上，其路径在target/debug/你的Cargo项目名

  • 执行这个可执行文件，先确保你已执行第一步。对于Windows,在终端中输入.\target\debug\你的Cargo项目名.exe;对于Linux/MacOS，在终端中输入./target/debug/你的Cargo项目名

  • 第一次运行cargo build会在顶层目录生成cargo.lock文件

1.3.7. Cargo.lock

cargo.lock会在项目第一次编译后生成（有的IDE在第一次编译前就会自动生成），其内容如下: 这个文件的作用是追踪项目依赖的精确版本，如这个文件内的注释所说，不需要也不建议手动修改该文件。

1.3.8. 运行Cargo项目

  • 复制Cargo项目所在的文件夹路径，打开终端，输入命令cd Cargo项目路径
  • 输入命令cargo run

cargo run实际上是两步操作——编译代码+执行结果，先生成一个可执行文件，然后再运行这个可执行文件。如果之前编译成功过，并且源码没有改变，那就会直接运行可执行文件。

1.3.9. 代码的检查

cargo check的作用是检查代码确保能成功编译，但不会产生可执行文件。cargo check比cargo build的速度快很多，编写代码时可以反复使用cargo check，提高效率

用法：

  • 复制Cargo项目所在的文件夹路径，打开终端，输入命令cd Cargo项目路径
  • 输入命令cargo check

1.3.10. 为发布构建

cargo build这个命令是用于开发（调试） 时的，当你编写完代码想要发布时，这个时候就应该使用cargo build --release这个构建发布版的指令而不是cargo build。这两者对比起来，前者编译代码的时间会更长，但代码的运行速度会更快。前者生成的可执行文件会在target/release中而不是target/debug