跳到正文
Code Review
← 规则库/语言与脚本

评审检查清单

Rust

语言与脚本41 个检查项10 个章节
**/*.rs
01

明显的拼写错误

2 项
  • 类型名、函数名、变量名、枚举变体名、trait 名或模块名在声明处的拼写错误;不要报告调用点处的拼写错误
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 日志消息、panic 消息、错误消息或公开诊断信息中影响可读性的拼写错误
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

02

所有权与生命周期正确性

4 项
  • 错误返回的引用、借用值逃逸出其有效作用域,或使 API 不健全(unsound)或不可用的生命周期关系
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 为满足借用约束而引入过多或不必要的 clone() 调用,而此时借用、迭代器、Cow 或所有权转移更清晰且开销更低
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 在没有真实共享可变性需求时,使用内部可变性(RefCell、Cell、Mutex)来绕开所有权限制
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • Rc<RefCell<T>> 或 Arc<Mutex<T>> 形成引用循环,而本应使用 Weak 来打破所有权环
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

03

错误处理与 panic

4 项
  • RUST-ERROR-HANDLING-001状态加载中
    在生产/库代码路径中使用 unwrap()、expect()、panic!、todo! 或 unimplemented!,而该失败本可恢复或可用 Result 传播
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-ERROR-HANDLING-002状态加载中
    错误过早转换为字符串,或被不带上下文地丢弃;应保留原始错误并在边界处添加可操作的上下文
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-ERROR-HANDLING-003状态加载中
    Result 或 Option 的值被忽略、吞掉,或映射为具有误导性的默认值
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-ERROR-HANDLING-004状态加载中
    公共 API 对普通非法输入直接 panic 而非返回类型化错误,除非该 panic 记录了明确的编程不变式
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

04

unsafe 代码边界

5 项
  • RUST-UNSAFE-CODE-BOUNDARIES-001状态加载中
    unsafe 块范围超出必要,或隐藏了多个互不相关的不变式
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-UNSAFE-CODE-BOUNDARIES-002状态加载中
    unsafe 块、unsafe fn、unsafe impl Send 或 unsafe impl Sync 缺少安全性说明,或说明已过时
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-UNSAFE-CODE-BOUNDARIES-003状态加载中
    裸指针解引用缺少明确的有效性、对齐、初始化、别名与生命周期保证
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-UNSAFE-CODE-BOUNDARIES-004状态加载中
    FFI 边界未校验空指针、缓冲区长度、所有权转移、字符串编码或分配器兼容性
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-UNSAFE-CODE-BOUNDARIES-005状态加载中
    使用 static mut、未检查的 transmute、MaybeUninit、mem::zeroed 或手写 drop 逻辑时,缺少使该操作健全的成文不变式
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

05

并发与共享状态

5 项
  • RUST-CONCURRENCY-001状态加载中
    持有 Mutex、RwLock 或 RefCell 守卫的时间超出必要,尤其是在跨用户代码调用或潜在阻塞操作期间
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-CONCURRENCY-002状态加载中
    跨 .await 持有同步锁;或直接在异步任务中使用阻塞 I/O、休眠或 CPU 密集型工作
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-CONCURRENCY-003状态加载中
    围绕共享状态、缓存初始化、文件创建或原子操作的先检查后执行(check-then-act)竞态
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-CONCURRENCY-004状态加载中
    原子操作的内存序对被保护数据而言过弱,或过强的内存序掩盖了预期的同步契约
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-CONCURRENCY-005状态加载中
    不安全的 Send 或 Sync 实现未证明在既定不变式下所有内部状态都是线程安全的
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

06

异步与取消安全性

4 项
  • RUST-ASYNC-001状态加载中
    派生任务的 JoinHandle 被丢弃,而失败、取消或关闭仍需被观察
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-ASYNC-002状态加载中
    在部分写入、锁获取、事务或资源清理方面不具备取消安全性的 Future
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-ASYNC-003状态加载中
    异步函数在请求/工作路径中使用同步文件系统、网络或进程 API,可能阻塞运行时
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-ASYNC-004状态加载中
    重试循环缺少退避、超时、取消传播或次数上限
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

07

集合、迭代器与性能

4 项
  • 避免在热点路径中产生不必要的分配,例如在借用或流式处理即可满足时反复构造 String、调用 format!、collect() 或 to_vec()
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 当迭代器适配器和标准库集合 API 能让所有权与复杂度更清晰时优先使用;避免过密的迭代器链掩盖错误处理或副作用
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 在预期大小已知且增长开销可观时,确保哈希 map、vector 和字符串进行了预分配
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 当 HashMap、HashSet、排序或索引策略能明显降低复杂度时,避免嵌套循环带来的 O(n^2) 查找
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

08

类型与 API 设计

4 项
  • RUST-TYPE-AND-API-DESIGN-001状态加载中
    当布尔值、字符串或原始整数会让非法状态可表示时,用枚举、newtype 和类型化 ID 建模领域状态
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-TYPE-AND-API-DESIGN-002状态加载中
    设计可复用 API 时优先使用标准转换与借用 trait(From、TryFrom、AsRef、Borrow、IntoIterator)
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-TYPE-AND-API-DESIGN-003状态加载中
    公共 struct、enum、trait 和错误应具备与 crate 边界相称的有意义的名称、可见性、trait 派生和文档
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-TYPE-AND-API-DESIGN-004状态加载中
    当切片、迭代器、trait 或更窄的抽象足以保持灵活性时,避免在公共 API 中暴露具体集合或同步类型
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

09

宏与元编程

5 项

仅当 diff 确实定义了 macro_rules! 或过程宏时才标记;不要针对普通的宏调用作报告。

  • RUST-MACROS-AND-METAPROGRAMMING-001状态加载中
    $x:expr 片段在展开式中被插值多次,导致调用方的表达式及任何副作用执行多次;应在展开式内先用 let 绑定一次
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-MACROS-AND-METAPROGRAMMING-002状态加载中
    被导出或公开使用的宏在引用条目时未加 $crate::,导致宏从其他 crate 调用时名称解析失败或绑定到错误的条目
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-MACROS-AND-METAPROGRAMMING-003状态加载中
    token 树($t:tt)片段被再次输出时未加括号,运算符优先级可能静默改变预期含义;这仅适用于 token 级(tt)插值,因为 :expr 片段和完整展开式各自都会被解析为一个完整的表达式
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-MACROS-AND-METAPROGRAMMING-004状态加载中
    过程宏对畸形输入直接 unwrap()、expect() 或 panic!,而不是发出带有有效 span 的 syn::Error / compile_error!
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-MACROS-AND-METAPROGRAMMING-005状态加载中
    被打破的宏卫生(hygiene)假定:生成的标识符依赖调用点作用域中的名称;或同一模块中多次调用宏时条目发生冲突
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

10

安全敏感代码

4 项
  • RUST-SECURITY-001状态加载中
    使用前校验路径、URL、命令、SQL 与序列化输入;不要用未检查的字符串拼接构造 shell 命令或 SQL
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-SECURITY-002状态加载中
    不要将密钥、令牌、凭据、私钥或个人可识别信息写入日志
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-SECURITY-003状态加载中
    检查整数转换、字节切片和长度运算中的溢出、截断与 UTF-8 边界错误
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • RUST-SECURITY-004状态加载中
    密码学、随机数、认证与授权代码必须使用经过充分评审的 crate 和显式的错误处理;标记临时拼凑的实现
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

返回本页顶部 ↑继续浏览规则库

手动复制规则链接

浏览器未允许自动复制,请选中下方链接复制。