8.3 KiB
Cargo Target
Cargo 项目中包含有一些对象，它们包含的源代码文件可以被编译成相应的包，这些对象被称之为 Cargo Target。例如之前章节提到的库对象 Library 、二进制对象 Binary、示例对象 Examples、测试对象 Tests 和 基准性能对象 Benches 都是 Cargo Target。
本章节我们一起来看看该如何在 Cargo.toml 清单中配置这些对象，当然，大部分时候都无需手动配置，因为默认的配置通常由项目目录的布局自动推断出来。
对象介绍
在开始讲解如何配置对象前，我们先来看看这些对象究竟是什么，估计还有些同学对此有些迷糊 :)
库对象(Library)
库对象用于定义一个库，该库可以被其它的库或者可执行文件所链接。该对象包含的默认文件名是 src/lib.rs，且默认情况下，库对象的名称跟项目名是一致的，
一个工程只能有一个库对象，因此也只能有一个 src/lib.rs 文件，以下是一种自定义配置:
# 一个简单的例子：在 Cargo.toml 中定制化库对象
[lib]
crate-type = ["cdylib"]
bench = false
二进制对象(Binaries)
二进制对象在被编译后可以生成可执行的文件，默认的文件名是 src/main.rs，二进制对象的名称跟项目名也是相同的。
大家应该还记得，一个项目拥有多个二进制文件，因此一个项目可以拥有多个二进制对象。当拥有多个对象时，对象的文件默认会被放在 src/bin/ 目录下。
二进制对象可以使用库对象提供的公共 API，也可以通过 [dependencies] 来引入外部的依赖库。
我们可以使用 cargo run --bin <bin-name> 的方式来运行指定的二进制对象，以下是二进制对象的配置示例：
# Example of customizing binaries in Cargo.toml.
[[bin]]
name = "cool-tool"
test = false
bench = false
[[bin]]
name = "frobnicator"
required-features = ["frobnicate"]
示例对象(Examples)
示例对象的文件在根目录下的 examples 目录中。既然是示例，自然是使用项目中的库对象的功能进行演示。示例对象编译后的文件会存储在 target/debug/examples 目录下。
如上所示，示例对象可以使用库对象的公共 API，也可以通过 [dependencies] 来引入外部的依赖库。
默认情况下，示例对象都是可执行的二进制文件( 带有 fn main() 函数入口)，毕竟例子是用来测试和演示我们的库对象，是用来运行的。而你完全可以将示例对象改成库的类型:
[[example]]
name = "foo"
crate-type = ["staticlib"]
如果想要指定运行某个示例对象，可以使用 cargo run --example <example-name> 命令。如果是库类型的示例对象，则可以使用 cargo build --example <example-name> 进行构建。
与此类似，还可以使用 cargo install --example <example-name> 来将示例对象编译出的可执行文件安装到默认的目录中，将该目录添加到 $PATH 环境变量中，就可以直接全局运行安装的可执行文件。
最后，cargo test 命令默认会对示例对象进行编译，以防止示例代码因为长久没运行，导致严重过期以至于无法运行。
测试对象(Tests)
测试对象的文件位于根目录下的 tests 目录中，如果大家还有印象的话，就知道该目录是集成测试所使用的。
当运行 cargo test 时，里面的每个文件都会被编译成独立的包，然后被执行。
测试对象可以使用库对象提供的公共 API，也可以通过 [dependencies] 来引入外部的依赖库。
基准性能对象(Benches)
该对象的文件位于 benches 目录下，可以通过 cargo bench 命令来运行，关于基准测试，可以通过这篇文章了解更多。
配置一个对象
我们可以通过 Cargo.toml 中的 [lib]、[[bin]]、[[example]]、[[test]] 和 [[bench]] 部分对以上对象进行配置。
大家可能会疑惑
[lib]和[[bin]]的写法为何不一致，原因是这种语法是TOML提供的数组特性，[[bin]]这种写法意味着我们可以在 Cargo.toml 中创建多个[[bin]]，每一个对应一个二进制文件上文提到过，我们只能指定一个库对象，因此这里只能使用
[lib]形式
由于它们的配置内容都是相似的，因此我们以 [lib] 为例来说明相应的配置项:
[lib]
name = "foo" # 对象名称: 库对象、`src/main.rs` 二进制对象的名称默认是项目名
path = "src/lib.rs" # 对象的源文件路径
test = true # 能否被测试，默认是 true
doctest = true # 文档测试是否开启，默认是 true
bench = true # 基准测试是否开启
doc = true # 文档功能是否开启
plugin = false # 是否可以用于编译器插件(deprecated).
proc-macro = false # 是否是过程宏类型的库
harness = true # 是否使用libtest harness : https://doc.rust-lang.org/stable/rustc/tests/index.html
edition = "2015" # 对象使用的 Rust Edition
crate-type = ["lib"] # 生成的包类型
required-features = [] # 构建对象所需的 Cargo Features (N/A for lib).
name
对于库对象和默认的二进制对象( src/main.rs )，默认的名称是项目的名称( package.name )。
对于其它类型的对象，默认是目录或文件名。
除了 [lib] 外，name 字段对于其他对象都是必须的。
proc-macro
该字段的使用方式在过程宏章节有详细的介绍。
edition
对使用的 Rust Edition 版本进行设置。
如果没有设置，则默认使用 [package] 中配置的 package.edition，通常来说，这个字段不应该被单独设置，只有在一些特殊场景中才可能用到：例如将一个大型项目逐步升级为新的 edition 版本。
crate-type
该字段定义了对象生成的包类型。它是一个数组，因此为同一个对象指定多个包类型。
需要注意的是，只有库对象和示例对象可以被指定，因为其他的二进制、测试和基准测试对象只能是 bin 这个包类型。
默认的包类型如下:
| 对象 | 包类型 |
|---|---|
| 正常的库对象 | "lib" |
| 过程宏的库对象 | "proc-macro" |
| 示例对象 | "bin" |
可用的选项包括 bin、lib、rlib、dylib、cdylib、staticlib 和 proc-macro ，如果大家想了解更多，可以看下官方的参考手册。
required-features
该字段用于指定在构建对象时所需的 features 列表。
该字段只对 [[bin]]、 [[bench]]、 [[test]] 和 [[example]] 有效，对于 [lib] 没有任何效果。
[features]
# ...
postgres = []
sqlite = []
tools = []
[[bin]]
name = "my-pg-tool"
required-features = ["postgres", "tools"]
对象自动发现
默认情况下，Cargo 会基于项目的目录文件布局自动发现和确定对象，而之前的配置项则允许我们对其进行手动的配置修改(若项目布局跟标准的不一样时)。
而这种自动发现对象的设定可以通过以下配置来禁用:
[package]
# ...
autobins = false
autoexamples = false
autotests = false
autobenches = false
只有在特定场景下才应该禁用自动对象发现。例如，你有一个模块想要命名为 bin，目录结构如下:
├── Cargo.toml
└── src
├── lib.rs
└── bin
└── mod.rs
这在默认情况下会导致问题，因为 Cargo 会使用 src/bin 作为存放二进制对象的地方。
为了阻止这一点，可以设置 autobins = false :
├── Cargo.toml
└── src
├── lib.rs
└── bin
└── mod.rs