125、掌握Rust代码审查与重构：Clippy与rustfmt工具指南

最新推荐文章于 2024-05-03 12:34:11 发布

多多的编程笔记

最新推荐文章于 2024-05-03 12:34:11 发布

阅读量1.1k

点赞数 8

分类专栏： Rust之Web开发文章标签： rust 重构开发语言

本文链接：https://blog.csdn.net/silenceallat/article/details/138260064

版权

Rust之Web开发专栏收录该内容

74 篇文章 5 订阅

订阅专栏

Rust代码审查与重构：学会使用Clippy、rustfmt等工具进行代码审查和风格统一

本文将介绍如何使用Clippy和rustfmt等工具对Rust代码进行审查和风格统一，帮助你提高代码质量。

1. 简介

在软件开发过程中，代码审查和风格统一是非常重要的环节。代码审查可以帮助我们发现潜在的问题，提高代码的可读性和可维护性；而风格统一则可以使得代码更加美观，降低阅读难度。
Rust作为一种注重安全性和性能的编程语言，提供了多种工具来帮助我们进行代码审查和风格统一。其中最常用的工具就是Clippy和rustfmt。
Clippy是一个轻量级的 Rust 代码分析工具，可以帮助开发人员发现潜在的代码问题。rustfmt则是一个用于格式化 Rust 代码的工具，可以帮助我们实现代码风格统一。
本文将详细介绍如何使用这两个工具进行代码审查和风格统一，并给出一些实用的技巧和案例。

2. Clippy 使用入门

2.1 安装

Clippy 是一个由 Rust 社区维护的 Lint 工具，可以通过 crates.io 进行安装。

cargo install clippy

安装完成后，你可以在命令行中使用 clippy 命令来运行它。

2.2 使用

Clippy 的使用非常简单，你只需要在命令行中输入 clippy 命令，它会自动分析你的项目并给出建议。
例如：

clippy

运行这个命令后，Clippy 会输出一些警告和建议，例如：

warning: consider using `std::convert::Infallible` instead of `()` for the error type in a conversion function
 --> src/main.rs:5:5
  |
5 | /     fn main() {
6 | |         let result = Ok(());
7 | |         assert_eq!(result, Ok(()));
8 | |     }
  | |_____^ consider using `std::convert::Infallible`
note: lint level defined here
 --> src/main.rs:1:9
  |
1 | #![deny(warnings)]
  |         ^^^^^^^^^^^^^

这个警告告诉我们，可以使用 std::convert::Infallible 来代替 () 作为转换函数的错误类型，以提高代码的可读性。

2.3 实用技巧

忽略某些警告：如果你不想看到某些特定的警告，你可以在 Cargo.toml 文件中使用 deny 和 warn 属性来忽略它们。
例如，如果你想忽略所有警告，你可以使用：

[package]
name = "your_package"
version = "0.1.0"
edition = "2018"
[dependencies]
[dev-dependencies]
clippy = "0.0.212"
[features]
default = ["clippy"]
[lib]
crate-type = ["cdylib"]

如果你想忽略特定的警告，你可以使用：

[package]
name = "your_package"
version = "0.1.0"
edition = "2018"
[dependencies]
[dev-dependencies]
clippy = "0.0.212"
[features]
default = ["clippy"]
[lib]
crate-type = ["cdylib"]
[metadata.clippy.unused_mut]
level = "allow"

自定义配置：Clippy 还支持自定义配置，你可以通过编辑 Cargo.toml 文件来设置你喜欢的选项。例如，你可以设置是否启用某个 Lint：

[dependencies]
clippy = { version = "0.0.212", features = ["custom-lints"] }
[dev-dependencies]
clippy = "0.0.212"
[features]
custom-lints = ["my_lint"]

在代码中，你可以使用 #![allow(my_lint)] 来忽略这个 Lint。

## 3. rustfmt 使用入门

3.1 安装

rustfmt 是 Rust 的官方代码格式化工具，它可以帮助你统一项目的代码风格。安装 rustfmt 非常简单，只需要运行以下命令：

cargo install rustfmt

安装后，你可以在项目目录中使用 rustfmt 命令来格式化你的 Rust 代码。

3.2 使用

使用 rustfmt 非常直接，你可以在命令行中运行以下命令来格式化你的代码：

rustfmt

这个命令会自动格式化你的 src 目录下的所有 Rust 文件。如果你想对特定的文件或者文件夹应用格式化，你可以使用 -p 参数 followed by the path to the file or directory.
例如，要格式化 src/main.rs 文件：

rustfmt -p src/main.rs

3.3 实用技巧

自动格式化：你可以在 .cargo/config 文件中配置 rustfmt 以便在构建过程中自动格式化你的代码。这样，每次你运行 cargo build 或 cargo check 时，rustfmt 都会自动执行。

[build]
 rustfmt = true

自定义配置：rustfmt 也有自己的配置文件 rustfmt.toml，你可以在其中设置各种格式化选项，比如缩进大小、空格与制表符的使用等。

[rustfmt]
edition = "2018"
omit_trailing_comma = true

集成到编辑器：许多编辑器和 IDE 支持 rustfmt，比如 VSCode 和 Visual Studio。你可以安装相应的插件，这样在编辑器中就可以直接对代码进行格式化。

4. 综合应用：代码审查与风格统一

在进行代码审查和风格统一时，你可以结合使用 clippy 和 rustfmt。这样，你不仅能够发现潜在的问题，还能确保代码的格式是统一的。
以下是一个简单的例子，展示如何在一个 Rust 项目中同时使用这两个工具：

首先，运行 clippy 来检查代码中可能的问题：

clippy

然后，运行 rustfmt 来格式化代码，确保风格统一：

rustfmt

如果你的编辑器或 IDE 支持 rustfmt，你还可以配置它们在保存文件时自动格式化代码。

5. 结论

使用 clippy 和 rustfmt 可以显著提高 Rust 代码的质量。通过代码审查，我们可以发现并修复潜在的问题，而通过风格统一，我们能够提高代码的可读性和可维护性。
作为软件开发人员，我们应该养成良好的代码习惯，定期进行代码审查和风格统一，这样不仅能够提高自己的工作效率，也能让其他人更容易理解和维护我们的代码。## 6. 进阶使用

6.1 忽略特定文件或目录

有时候，你可能不想对某些文件或目录应用 rustfmt，比如第三方库或者测试代码。你可以通过 --exclude 参数来忽略这些文件：

rustfmt --exclude="target/,tests/"

这个命令会忽略位于 target/ 和 tests/ 目录下的所有文件。

6.2 自定义配置文件

rustfmt 允许你创建一个自定义配置文件来覆盖默认的格式化规则。这可以通过在项目根目录下创建 rustfmt.toml 文件来实现：

[config]
max_width = 100
break_string_literals = true

在这个配置文件中，max_width 设置了单行代码的最大宽度，而 break_string_literals 则决定了是否在长字符串 literal 中添加换行。

6.3 在 CI/CD 流程中集成

为了确保代码质量，你可以在 CI/CD 流程中集成 clippy 和 rustfmt。这样，每次代码提交或合并请求时，都会自动运行这些工具来检查代码质量。
你可以在 CI/CD 配置文件中添加相应的步骤，例如在 GitHub Actions 中：

name: Rust CI
on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Set up Rust
      uses: rust-lang/rust-setup-action@v1
    - name: Install Clippy and Rustfmt
      run: cargo install clippy rustfmt --locked
    - name: Run Clippy
      run: clippy --all-features -- -D warnings
    - name: Run Rustfmt
      run: rustfmt --check --all

在这个例子中，每当有新的提交或 pull request 时，都会运行 clippy 和 rustfmt。如果发现任何问题，CI/CD 流程将会失败，这样可以确保只有通过了代码审查和格式化的代码才会被合并。

6.4 处理自定义 Lints

Clippy 支持自定义 Lints，你可以通过创建一个 clippy.toml 文件来定义自己的 Lint。例如，如果你想创建一个检查空字符串的 Lint：

[dependencies]
clippy = "0.0.212"
[features]
custom-lints = ["empty_string_literal"]

然后，在你的 clippy.toml 文件中：

[lints]
empty_string_literal = { level = "warn", message = "使用空字符串 literal，建议使用 `""`" }

这样，每当你的代码中出现空字符串 literal 时，Clippy 就会发出警告。

7. 总结

通过使用 clippy 和 rustfmt，你可以更加轻松地维护代码质量。在代码审查和风格统一方面，这两个工具提供了强大的功能和灵活的配置选项。
作为 Rust 开发者，我们应该熟练掌握这些工具，并将它们集成到我们的开发流程中。这样，我们不仅能够提高代码的质量，还能提高开发效率，让我们的项目更加健壮和可维护。

如果觉得文章对您有帮助，可以关注同名公众号『随笔闲谈』，获取更多内容。欢迎在评论区留言，我会尽力回复每一条留言。如果您希望持续关注我的文章，请关注我的博客。您的点赞和关注是我持续写作的动力，谢谢您的支持！

多多的编程笔记

关注

8
点赞
踩
14

收藏

觉得还不错? 一键收藏
0
评论
125、掌握Rust代码审查与重构：Clippy与rustfmt工具指南

本文介绍了如何使用Clippy和rustfmt这两个Rust编程语言的代码审查和风格统一工具。Clippy能够帮助开发者发现潜在的代码问题，而rustfmt则能自动格式化代码以保持一致性。文章详细阐述了如何配置和使用这两个工具，包括如何忽略特定文件、自定义配置以及将它们集成到CI/CD流程中。最后，我们强调了作为Rust开发者，掌握这些工具的重要性，以提高代码质量和开发效率。
复制链接

扫一扫