You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

7.9 KiB

认识Cargo

但凡经历过C/C++、Go语言1.10版本之前的用户都知道,一个好的包管理工具有多么的重要!!我那个时候是如此的渴望类似nodejs的npm包管理工具但是却求而不得包管理工具最重要的意义就是任何用户拿到你的代码,都能运行起来"而不会因为各种包版本依赖焦头烂额Go语言在1.10版本之前所有的包都是在github.com下存放导致了所有的项目都公用一套依赖代码在本地项目复杂后这简直是一种灾难。

说多了都是泪笔者目前还有一个早期Go的项目(15年写的),用到了iris(一个坑爹http服务),结果现在运行不起来了,因为找不到iris当时的那个版本!!

作为一门现代化语言,Rust吸收了多个语言的包管理优点,为大家提供超级大杀器:cargo,真的,再挑剔的开发者,都对它赞不绝口。

总而言之,cargo提供了一系列的工具从项目的建立、构建到测试、运行直至部署为Rust项目的管理提供尽可能完整的手段同时与Rust语言及其编译器rustc紧密结合,可以说用了后就忘不掉,如同初恋般的感觉。

创建一个"你好,世界"项目

又见"你好,世界",肯定有读者在批评了:你就不能有点创意吗?"世界,你好"难道不配?你是读者,你说了算,那我们就来创建一个"世界,你好"。

上文提到Rust语言的包管理工具是cargo好在我们无需手动安装在之前安装Rust的时候就一并安装如果你在终端无法使用这个命令考虑一下环境变量是否正确的设置:把cargo可执行文件所在的目录添加到环境变量中。

终于到了紧张刺激的new new new环节:

$ cargo new world_hello

上面的命令使用cargo new创建一个项目,项目名是world_hello(向读者势力低头的项目名称,泪奔),该项目的结构和配置文件都是由cargo生成,意味着我们的项目被cargo所管理

早期的cargo在创建项目时必须添加--bin的参数,如下所示:

$ cargo new world_hello --bin

现在的版本,已经无需此参数,cargo默认就创建bin类型的项目顺便说一句Rust项目主要分为两个类型binlib,前者是一个可运行的项目,后者是一个依赖库项目。

下面来看看创建的项目结构:

.
├── .git
├── .gitignore
├── Cargo.toml
└── src
    └── main.rs

是的连git都给你创建了不仅令人感叹不是女儿胜似女儿比小棉袄还体贴。

运行项目

有两种方式可以运行项目,先来看看第一种.

cargo run

一码胜似千言:

$ cargo run
   Compiling world_hello v0.1.0 (/Users/sunfei/development/rust/world_hello)
    Finished dev [unoptimized + debuginfo] target(s) in 0.43s
     Running `target/debug/world_hello`
Hello, world!

好了,你已经看到程序的输出: "Hello, world", 可能有读者不愿意了,说好了"世界,你好"呢? 别急,在下一节,我们再对代码进行修改。认真想来,"你好,世界“强调的是我对世界说你好,而"世界,你好“是世界对我说你好,明显是后者更有包容性和国际范儿,读者真·好眼光.

上述代码,cargo run首先对项目进行编译,然后再运行,因此它实际上等同于运行了两个指令,如同我们下面将做的

手动编译和运行项目

编译

$ cargo build
    Finished dev [unoptimized + debuginfo] target(s) in 0.00s

运行

$ ./target/debug/world_hello 
Hello, world!

行云流水,但谈不上一气呵成. 细心的读者可能已经发现,在调用的时候,路径./target/debug/world_hello中有一个明晃晃的debug字段,没错我们运行的是debug模式,在这种模式下,代码的编译速度会非常快,可是福兮祸所依,运行速度就慢了. 原因是,在debug模式下Rust编译器不会做任何的优化只为了尽快的编译完成让你的开发流程更加顺畅。

作为尊贵的读者,咱自然可以要求更多,比如你想要高性能的代码怎么办? 简单,添加--release来编译:

  • cargo run --release
  • cargo build --release

运行我们的高性能relese程序:

$ ./target/release/world_hello 
Hello, world!

cargo check

当项目大了后,cargo runcargo build不可避免的会变慢,那么有没有更快的方式来验证代码的正确性呢?大杀器来了,接着!

cargo check是我们在代码开发过程中最常用的命令,它的作用很简单:快速的检查一下代码能否编译通过. 因此该命令速度会非常快,能节省大量的编译时间.

$ cargo check
    Checking world_hello v0.1.0 (/Users/sunfei/development/rust/world_hello)
    Finished dev [unoptimized + debuginfo] target(s) in 0.06s

Rust虽然编译速度还行但是还是不能Go语言相提并论因为Rust需要做很多复杂的编译优化和语言特性解析, 甚至连如何优化编译速度都成了一门学问优化编译速度

cargo.toml 和 cargo.lock

cargo.tomlcargo.lockcargo的核心文件,它的所有活动均基于此二者。

cargo.toml是cargo特有的项目数据描述文件存储了项目的所有元配置信息如果rust开发者希望rust项目能够按照期望的方式进行构建、测试和运行那么必须按照合理的方式构建cargo.toml

cargo.lock文件是cargo工具根据同一项目的toml文件生成的项目依赖详细清单因此我们一般不用修改它只需要对着cargo.toml文件撸就行了。

什么情况下该把cargo.lock上传到git仓库里很简单当你的项目是一个可运行的程序时就上传cargo.lock,如果是一个依赖库项目,那么请把它添加到.gitignore

现在用Vscode打开上面创建的"世界,你好"项目,然后进入根目录的cargo.toml文件,该文件包含不少信息。

package配置段落

package中记录了项目的描述信息,典型的如下:

[package]
name = "world_hello"
version = "0.1.0"
edition = "2021"

name字段定义了项目名称,version字段定义当前版本,新项目默认是0.1.0edition字段定义了我们使用的Rust大版本因为本书很新(不仅仅是现在新未来也将及时修订跟得上Rust的小步伐),所以使用的是Rust edition 2021大版本,详情见Rust版本详解.

定义项目依赖

使用cargo工具的最大优势就在于,能够对该项目的各种依赖项进行方便、统一和灵活的管理。在cargo.toml中,主要通过各种依赖段落来描述该项目的各种依赖项:

  • 基于rust官方仓库crates.io通过版本说明来描述
  • 基于项目源代码的git仓库地址通过URL来描述
  • 基于本地项目的绝对路径或者相对路径通过类Unix模式的路径来描述

这三种形式具体写法如下:

[dependencies]
rand = "0.3"
hammer = { version = "0.5.0"}
color = { git = "https://github.com/bjz/color-rs" }
geometry = { path = "crates/geometry" }

相信聪明的读者已经能看懂该如何引入外部依赖库,这里就不再赘述。

详细的说明参见此章:Cargo依赖管理,但是不建议大家现在去看,只要按照目录浏览,拨云见雾只可待。

基于cargo的项目组织结构

前文有提到cargo默认生成的项目结构但是真实的项目还有所不同但是在目前的学习阶段还无需关注感兴趣的同学可以移步Cargo项目结构

至此大家对Rust项目的创建和管理已经有了初步的了解那么来完善刚才的"世界,你好"项目吧。