深入了解 cargo new 命令：创建 Rust 项目的利器

朱雀 2024-02-25 04:04 20阅读 0赞

Cargo 是 Rust 编程语言的默认构建工具和包管理器。cargo new 是 Cargo 提供的一个命令，用于创建一个新的 Rust 项目。在这篇文章中，我们将深入探讨 cargo new 命令的作用、语法以及如何使用它来创建 Rust 项目。我们还将讨论 Rust 项目的组织结构，以及如何开始编写和构建您的 Rust 代码。

**目录**

1.什么是 cargo new 命令？

2.为什么 cargo new 命令重要？

1. 初始化项目结构

2. 管理依赖

3. 提高开发效率

3.基本语法

4.描述说明

5.选项说明

新选项

显示选项

通用选项

6.环境变量

7.退出状态

8如何使用 cargo new 命令？

1. 创建新项目

2.查看项目结构

3.编译和运行项目

9项目结构

10.cargo new 在 Rust 生态系统中的重要性和用途

11.关于 Rust 项目的管理和维护的一些建议

12.结论

--------------------

## 1.什么是 cargo new 命令？ ##

cargo new是 Rust 编程语言的 Cargo 工具的子命令之一，用于创建新的 Rust 项目。Rust 社区非常强调代码组织和可维护性，因此创建一个新项目时，使用 cargo new 命令可以帮助开发者初始化一个基本的项目结构。

## 2.为什么 cargo new 命令重要？ ##

cargo new 命令在 Rust 开发中非常重要，原因如下：

#### 1. 初始化项目结构 ####

Rust 项目通常具有特定的文件和目录结构，包括 src 目录（用于源代码）、Cargo.toml 文件（用于定义项目的依赖和元信息）等。使用 cargo new 命令可以轻松初始化这些结构，而无需手动创建文件和目录。

#### 2. 管理依赖 ####

Rust 社区使用 Cargo 来管理依赖项。通过使用 cargo new 命令，您可以在项目初始化时指定依赖项，这样您就可以轻松地开始使用其他库和工具，而无需手动编辑 Cargo.toml 文件。

#### 3. 提高开发效率 ####

cargo new 命令可以帮助开发者快速启动新项目，节省了创建项目结构和初始化过程的时间。这使得开发者可以更专注于编写代码，而不是配置项目。

## 3.基本语法 ##

cargo new 命令的基本语法如下：

cargo new [OPTIONS] <PROJECT_NAME>

其中：

*  OPTIONS ：可选的标志，用于配置项目的创建。
 *  <PROJECT\_NAME> ：要创建的项目的名称。

## 4.描述说明 ##

这个命令将在指定的目录中创建一个新的 Cargo 包。这包括一个包含了 Cargo.toml 清单、示例源文件和一个版本控制系统忽略文件的简单模板。如果该目录尚未处于版本控制系统仓库中，那么将会创建一个新的仓库（参见下面的 --vcs 选项）。

有关在现有目录中创建新清单的类似命令，请参阅 [cargo init 命令][cargo init]。

## 5.选项说明 ##

#### **新选项** ####

*  \--bin：创建一个可执行文件项目（src/main.rs）（默认行为）。
 *  \--lib：创建一个库项目（src/lib.rs）。
 *  \--edition edition：指定要使用的 Rust 版本。默认为 2021。可能的值为：2015、2018、2021。
 *  \--name name：设置要使用的项目名。默认为目录名称。
 *  \--vcs vcs：为给定的版本控制系统（git、hg、pijul 或 fossil）初始化一个新的版本控制系统仓库，或者不初始化任何版本控制系统（none）。如果未指定，默认为 git 或配置值 cargo-new.vcs，如果已经位于版本控制系统仓库中，则默认为 none。
 *  \--registry registry：将 Cargo.toml 中的 publish 字段设置为给定的注册表名称，这将限制仅发布到该注册表。 注册表名称在 [Cargo 配置文件][Cargo]中定义。如果未指定，默认使用由 registry.default 配置键定义的默认注册表。如果未设置默认注册表且未使用 --registry，则不会设置 publish 字段，这意味着发布不会受到限制。

例如，要创建一个库项目并指定 Rust 2018 版本，可以使用以下命令：

cargo new --lib --edition 2018 my_library

#### 显示选项 ####

*  \-v 或 --verbose：显示详细的创建过程。
 *  \-q 或 --quiet：不打印 cargo 日志消息。也可以与 term.quiet 配置值一起使用。
 *  \--color when：控制何时使用带颜色的输出。有效值为：
    
     *  auto（默认）：自动检测终端是否支持颜色。
     *  always：始终显示颜色。
     *  never：从不显示颜色。 也可以与 term.color [配置值][Cargo]一起使用。

#### 通用选项 ####

*  \+toolchain：如果使用 rustup 安装了 Cargo，并且 cargo 的第一个参数以 + 开头，它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖的更多信息，请参阅 [rustup 文档][rustup]。
 *  \--config KEY=VALUE 或 PATH：覆盖 Cargo 配置值。参数应以 KEY=VALUE 的 TOML 语法提供，或者以额外配置文件的路径提供。可以多次指定此标志。有关更多信息，请参阅[命令行覆盖部分][Link 1]。
 *  \-C PATH：在执行任何指定操作之前更改当前工作目录。这会影响 Cargo 默认查找项目清单（Cargo.toml）的位置，以及用于发现 .cargo/config.toml 的目录，例如。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。此选项仅在[夜间通道][Link 2]上可用，需要 -Z unstable-options 标志启用（请参阅[＃10098][10098]）。
 *  \-h 或 --help：打印帮助信息。
 *  \-Z flag：Cargo 的不稳定（仅夜间）标志。运行 cargo -Z help 以获取详细信息。

## 6.环境变量 ##

请查看[参考文档][Link 3]以获取 Cargo 读取的环境变量的详细信息。

## 7.退出状态 ##

0：Cargo 成功执行。  
101：Cargo 未能完成执行。

## 8如何使用 cargo new 命令？ ##

现在让我们看看如何使用 cargo new 命令来创建一个新的 Rust 项目。

#### 1. 创建新项目 ####

要创建一个新的 Rust 项目，只需在终端中运行以下命令：

cargo new my_project

这将在当前目录下创建一个名为 "my\_project" 的新项目。您可以将项目名称替换为您喜欢的任何名称。

#### 2.查看项目结构 ####

一旦项目创建成功，您可以使用 ls 命令来查看项目的文件和目录结构。通常情况下，您将看到以下内容：

my_project/
    ├── Cargo.toml
    └── src/
        └── main.rs

*  Cargo.toml 文件是项目的元信息文件，用于定义依赖项和其他配置。
 *  src/ 目录包含项目的 Rust 源代码，通常包括一个 main.rs 文件，作为项目的入口点。

#### 3.编译和运行项目 ####

一旦项目创建成功，您可以使用以下命令来构建和运行项目：

cd my_project
    cargo build  # 构建项目
    cargo run    # 运行项目

cargo build 命令将编译项目，而 cargo run 命令将运行编译后的可执行文件。

## 9项目结构 ##

cargo new 命令的核心功能是创建一个新的项目结构，其中包含了一个标准的 Rust 项目布局。这个项目结构通常包括以下内容：

*  Cargo.toml：项目的元数据和依赖配置文件。
 *  src 目录：包含 Rust 代码的目录。
 *  src/main.rs 或 src/lib.rs：项目的入口文件，取决于是可执行文件项目还是库项目。
 *  .gitignore：用于忽略版本控制的文件列表。
 *  .git 目录（如果你使用 Git 进行版本控制）：包含 Git 版本控制的相关文件。

根据项目的复杂性和需求，您可以在 src/ 目录下创建更多的 Rust 源代码文件，以划分不同的模块和功能。这有助于保持代码的组织性和可维护性。

## 10.cargo new 在 Rust 生态系统中的重要性和用途 ##

cargo new 是 Rust 编程语言中一个非常重要的命令，它简化了创建新项目的过程。Rust 社区强调了项目的可维护性和模块化设计，而 cargo new 命令有助于确保新项目遵循这些最佳实践。通过自动生成标准的项目结构，它减少了初始设置的复杂性，使得开发人员可以更快地开始编写代码。

此外，Cargo.toml 文件是 Rust 项目的核心配置文件，它包含了项目的元数据信息以及依赖关系。cargo new 命令创建的项目已经包含了一个最小的 Cargo.toml 文件，你可以在其中添加和管理项目的依赖，这对于 Rust 生态系统中的库和工具的使用至关重要。

## 11.关于 Rust 项目的管理和维护的一些建议 ##

一旦使用 cargo new 创建了一个 Rust 项目，项目的管理和维护就变得至关重要。以下是一些建议：

*  定期更新依赖：使用 Cargo.toml 文件来管理项目的依赖关系，并定期运行 cargo update 命令来更新依赖版本。
 *  编写测试：Rust 鼓励编写单元测试和集成测试，以确保项目的稳定性和可靠性。
 *  使用版本控制：将项目放入版本控制系统（如 Git）中，以便跟踪和管理代码的变化。
 *  阅读 Rust 文档：Rust 社区提供了丰富的文档和教程，可以帮助你更好地理解和使用 Rust。
 *  参与社区：Rust 社区非常活跃，参与社区讨论和贡献开源项目可以帮助你学习和成长。

## 12.结论 ##

`cargo new` 命令是创建 Rust 项目的一个重要工具。通过使用这个命令，您可以快速初始化一个新的 Rust 项目，并开始编写代码。了解项目的组织结构以及如何自定义项目模板可以帮助您更好地管理和开发 Rust 项目。希望本文能帮助您更好地理解和使用 `cargo new` 命令。如果您想深入了解 Rust 编程语言和 Cargo 工具，建议查阅 Rust 官方文档以获取更多信息。

[cargo init]: https://doc.rust-lang.org/cargo/commands/cargo-init.html
[Cargo]: https://doc.rust-lang.org/cargo/reference/config.html
[rustup]: https://rust-lang.github.io/rustup/overrides.html
[Link 1]: https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides
[Link 2]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
[10098]: https://github.com/rust-lang/cargo/issues/10098
[Link 3]: https://doc.rust-lang.org/cargo/reference/environment-variables.html