Rust Clippy 开发：如何实现跨表达式状态追踪的 Lint 检查

在 Rust Clippy 开发过程中，实现一个需要跨多个表达式追踪变量状态的 Lint 检查是一个常见需求。本文将通过一个实际案例，详细介绍如何正确实现这种类型的 Lint。

问题场景

假设我们需要开发一个 Lint，用于检测直接从标准输入读取的变量在作为文件路径使用时是否经过验证。这个 Lint 需要：

1. 识别所有从标准输入读取的变量
2. 追踪这些变量的使用情况
3. 当这些变量作为文件路径使用时，检查是否经过了验证函数处理

常见误区

新手开发者通常会尝试在每个表达式的检查中创建新的状态对象：

fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'tcx>) {
    let mut state = TaintState::default();  // 错误：每次检查都会重置状态
    // ...
}

这种方法会导致状态无法在多个表达式之间保持，因为每次检查都会创建一个新的状态对象。

正确实现方式

1. 定义包含状态的结构体

首先，我们需要定义一个包含状态的结构体，并将其作为 Lint 实现的一部分：

#[derive(Default)]
struct ProtectAgainstFileNameInjection {
    tainted_vars: HashSet<HirId>,
}

2. 使用 impl_lint_pass 宏

不要使用 declare_lint_pass! 宏，而是使用 impl_lint_pass! 宏来创建我们的 Lint 实现：

impl_lint_pass!(ProtectAgainstFileNameInjection => [PROTECT_AGAINST_FILE_NAME_INJECTION]);

3. 实现 LateLintPass trait

在实现 LateLintPass trait 时，我们可以直接访问结构体中的状态：

impl<'tcx> LateLintPass<'tcx> for ProtectAgainstFileNameInjection {
    fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'tcx>) {
        // 可以直接使用 self.tainted_vars 来访问和修改状态
        // ...
    }
}

4. 正确识别变量

在识别被污染的变量时，需要注意：

if let ExprKind::MethodCall(path, receiver, args, _) = &expr.kind {
    if path.ident.name.as_str() == "read_line" {
        // 注意：receiver.hir_id 是方法调用者的 HirId
        // 我们需要获取的是变量本身的 HirId
        if let Some(arg) = args.first() {
            if let Some(hir_id) = path_to_local(arg) {
                self.tainted_vars.insert(hir_id);
            }
        }
    }
}

这里使用了 clippy_utils::path_to_local 函数来正确获取变量的 HirId。

5. 检查文件操作

在检查文件操作时，我们可以直接使用保存的状态：

if let ExprKind::MethodCall(path, _, args, _) = &expr.kind {
    if path.ident.name.as_str() == "open" {
        if let Some(path_expr) = args.first() {
            if let Some(hir_id) = path_to_local(path_expr) {
                if self.tainted_vars.contains(&hir_id) {
                    if !is_validated(path_expr) {
                        // 发出警告
                    }
                }
            }
        }
    }
}

完整实现要点

1. 状态持久化：将状态保存在 Lint 结构体中，而不是每次检查时创建
2. 正确识别变量：使用 path_to_local 获取变量的 HirId
3. 跨表达式追踪：利用 Rust 的所有权机制，确保状态在整个检查过程中持续存在
4. 验证函数检查：实现 is_validated 函数来检查变量是否经过了验证处理

总结

开发需要跨表达式追踪状态的 Lint 时，关键在于正确设计 Lint 的结构体，将状态保存在结构体字段中，而不是在每次检查时创建新状态。这种方法不仅适用于文件路径验证的 Lint，也适用于其他需要追踪变量状态的静态分析场景。

通过这种方式，我们可以实现复杂的静态分析检查，帮助开发者发现潜在的安全问题和不良编码实践。