附录 D - 有用的开发工具


在本附录中，我们讨论了 Rust 项目提供的一些有用的开发工具。我们将介绍自动格式化、应用警告修复的快速方法、linter 以及与 IDE 的集成。


使用 rustfmt 自动格式化


rustfmt 工具根据社区代码样式重新格式化您的代码。许多协作项目使用 rustfmt 来防止在编写 Rust 时关于使用哪种样式的争论：每个人都使用该工具格式化他们的代码。


要安装 rustfmt，请输入以下内容：

$ rustup component add rustfmt


这个命令给你 rustfmt 和 cargo-fmt，类似于 Rust 给你 rustc 和 cargo 的方式。要格式化任何 Cargo 项目，请输入以下内容：


$ 货物 fmt


运行此命令会重新格式化当前 crate 中的所有 Rust 代码。这应该只会更改代码样式，而不会更改代码语义。有关 rustfmt 的更多信息，请参阅其文档。


使用 rustfix 修复您的代码


rustfix 工具包含在 Rust 安装中，可以自动修复编译器警告，这些警告具有明确的方法来纠正您可能想要的问题。您以前可能已经看到过编译器警告。例如，请考虑以下代码：


文件名： src/main.rs

fn do_something() {}

fn main() {
    for i in 0..100 {
        do_something();
    }
}


在这里，我们调用 do_something 函数 100 次，但我们从未在 for 循环的主体中使用变量 i。Rust 警告我们：

$ cargo build
   Compiling myprogram v0.1.0 (file:///projects/myprogram)
warning: unused variable: `i`
 --> src/main.rs:4:9
  |
4 |     for i in 0..100 {
  |         ^ help: consider using `_i` instead
  |
  = note: #[warn(unused_variables)] on by default

    Finished dev [unoptimized + debuginfo] target(s) in 0.50s


该警告建议我们改用 _i 作为名称：下划线表示我们打算不使用此变量。我们可以通过运行 cargo fix 命令来使用 rustfix 工具自动应用该建议：

$ cargo fix
    Checking myprogram v0.1.0 (file:///projects/myprogram)
      Fixing src/main.rs (1 fix)
    Finished dev [unoptimized + debuginfo] target(s) in 0.59s


当我们再次查看 src/main.rs 时，我们会看到 cargo fix 改变了代码：


文件名： src/main.rs

fn do_something() {}

fn main() {
    for _i in 0..100 {
        do_something();
    }
}


for 循环变量现在命名为 _i，并且不再显示警告。


您还可以使用 cargo fix 命令在不同的 Rust 版本之间转换代码。附录 E 中介绍了各个版本。


使用 Clippy 进行更多 lints


Clippy 工具是一组 lint 来分析您的代码，以便您可以捕获常见错误并改进 Rust 代码。


要安装 Clippy，请输入以下内容：

$ rustup component add clippy


要在任何 Cargo 项目上运行 Clippy 的 lints，请输入以下内容：


$ 货物 clippy


例如，假设您编写一个程序，该程序使用数学常数的近似值（如 pi），就像这个程序一样：


文件名： src/main.rs

fn main() {
    let x = 3.1415;
    let r = 8.0;
    println!("the area of the circle is {}", x * r * r);
}


在此项目上运行 cargo clippy 会导致此错误：

error: approximate value of `f{32, 64}::consts::PI` found
 --> src/main.rs:2:13
  |
2 |     let x = 3.1415;
  |             ^^^^^^
  |
  = note: `#[deny(clippy::approx_constant)]` on by default
  = help: consider using the constant directly
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#approx_constant


此错误让您知道 Rust 已经定义了更精确的 PI 常数，并且如果您使用该常数，您的程序会更正确。然后，您将更改代码以使用 PI 常数。以下代码不会导致 Clippy 出现任何错误或警告：


文件名： src/main.rs

fn main() {
    let x = std::f64::consts::PI;
    let r = 8.0;
    println!("the area of the circle is {}", x * r * r);
}


有关 Clippy 的更多信息，请参阅其文档。


使用 rust-analyzer 的 IDE 集成


为了帮助 IDE 集成，Rust 社区建议使用 rust-analyzer 的该工具是一组以编译器为中心的实用程序，它使用语言服务器协议，该协议是 IDE 和编程语言相互通信的规范。不同的客户端可以使用 rust-analyzer，例如 适用于 Visual Studio Code 的 Rust 分析器插件。


访问 rust-analyzer 项目的主页 有关安装说明，请在 特定的 IDE。您的 IDE 将获得自动补全、跳转到 定义和内联错误。