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

评审检查清单

Haskell

语言与脚本42 个检查项9 个章节
**/*.{hs,lhs}
精确优先于召回:仅在确信是真实缺陷时才提出问题,当周边上下文不明确时保持沉默——误报比漏报一个次要问题更损耗评审者的信任。将安全与正确性发现视为阻塞项,风格或惯用法建议视为非阻塞项。在报告他处定义的辅助函数的调用点之前,先确认其不变量以及严格性或全函数性保证。
01

明显的拼写错误

2 项
  • 模块、类型、数据构造器、typeclass、函数、字段或模式同义词名称在其声明处的拼写错误;不要报告使用处的拼写错误
    内置
    来源与改动说明

    来源

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

  • 面向用户的错误消息、日志输出、Haddock 注释或公开诊断信息中影响可读性的笔误
    内置
    来源与改动说明

    来源

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

02

全函数性、模式匹配与部分函数

5 项
  • 函数等式、case、lambda 或 do 绑定中的非穷尽模式匹配,且可达的构造器或空输入会在运行时导致失败
    内置
    来源与改动说明

    来源

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

  • 使用 head、tail、init、last、!!、foldl1、foldr1、minimum 或 maximum 等部分列表/容器操作,却缺少局部可证明的非空或在界内不变量;优先使用模式匹配、安全查找或 NonEmpty
    内置
    来源与改动说明

    来源

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

  • 在普通输入或可恢复路径上使用 fromJust、fromRight、read、toEnum、succ、pred、error 或 undefined;优先使用全函数替代方案,如 maybe、readMaybe、readEither 或显式错误类型
    内置
    来源与改动说明

    来源

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

  • 对和类型使用记录选择器,而该字段在某些可达构造器中并不存在
    内置
    来源与改动说明

    来源

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

  • 当同一函数已校验过该不变量、类型已编码该不变量,或失败被有意用于标记不可能的内部状态且有清晰说明时,不要报告部分操作
    内置
    来源与改动说明

    来源

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

03

惰性、严格性与空间占用

5 项
  • 对大型有限集合并配合严格累加操作使用 foldl,从而构建出 thunk 链;在求值顺序允许时改用 foldl' 或严格累加器
    内置
    来源与改动说明

    来源

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

  • 在消费惰性列表、ByteString、Text 或流式结构的尾部时保留其头部,无意间使整个输入保持存活
    内置
    来源与改动说明

    来源

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

  • 对可能无限或有意流式处理的值调用 length、last、严格转换或完整排序
    内置
    来源与改动说明

    来源

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

  • 反复进行惰性到严格的转换,或仅为检查前缀就强制求值整个请求/文件,破坏流式处理并造成可避免的内存尖峰
    内置
    来源与改动说明

    来源

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

  • 在没有泄漏或延迟问题证据的情况下投机性地添加 seq、bang 模式或深求值;严格性变化可能改变终止行为与异常时机
    内置
    来源与改动说明

    来源

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

04

错误、异常与资源安全

5 项
  • 打开 IO 资源时未使用 bracket、withFile、withBinaryFile、finally 或等价的托管抽象,在异常或异步取消到来时泄漏句柄
    内置
    来源与改动说明

    来源

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

  • 在 SomeException 级别使用 catch 或 try,无意间吞掉取消等异步异常;应捕获预期的异常类型或重新抛出异步异常
    内置
    来源与改动说明

    来源

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

  • 将 throwIO、error 或模式匹配失败用于调用方需要区分的预期领域错误;视情况返回 Either、ExceptT、Maybe 或类型化异常
    内置
    来源与改动说明

    来源

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

  • 清理逻辑实现为主操作之后的普通动作,而非使用异常安全的组合子
    内置
    来源与改动说明

    来源

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

  • 异常处理器丢弃原始成因或静默替换成一个貌似合理的值,掩盖损坏、部分写入或校验失败
    内置
    来源与改动说明

    来源

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

05

并发、异步异常与 STM

6 项
  • 用 forkIO 启动线程,而其异常、生命周期或关闭必须被观测;优先使用结构化的 async/withAsync,并确保结果被等待或链接
    内置
    来源与改动说明

    来源

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

  • takeMVar 之后执行工作再 putMVar,其间可能被中断,使 MVar 保持为空;使用 modifyMVar、masking 或其他异常安全的组合子
    内置
    来源与改动说明

    来源

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

  • 在 atomically 内执行阻塞操作、无界重试或长时间纯计算,导致事务过度重试或阻碍有效进展
    内置
    来源与改动说明

    来源

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

  • 将 unsafeIOToSTM 用于外部可见、非幂等或易抛异常的效果,这些效果可能随事务重试而多次执行
    内置
    来源与改动说明

    来源

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

  • 多线程更新共享可变状态而未使用 MVar、TVar、原子原语,或未采用确立单一所有权的设计
    内置
    来源与改动说明

    来源

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

  • 可能死锁的加锁顺序,或在持有 MVar/锁的同时调用未知的用户代码或等待另一线程
    内置
    来源与改动说明

    来源

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

06

类型、实例与 API 设计

5 项
  • 孤儿 typeclass 实例可能与其他包中的实例冲突,使行为依赖导入/构建组合;优先使用由定义模块持有的 newtype
    内置
    来源与改动说明

    来源

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

  • fromIntegral、toEnum、fromEnum 或收窄转换可能在无边界检查的情况下溢出、回绕、截断或接受无效范围
    内置
    来源与改动说明

    来源

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

  • 违反调用方所依赖类法则的 typeclass 实例,如不一致的 Eq/Ord、不合法的 Semigroup/Monoid,或与 Eq 不一致的 Hashable
    内置
    来源与改动说明

    来源

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

  • 公共 API 将无效状态暴露为互不相关的布尔值、元组或 String 值,而代数数据类型或 newtype 本可编码该不变量
    内置
    来源与改动说明

    来源

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

  • 约束明显宽于实现所需,降低复用性或隐藏了非预期的效果要求
    内置
    来源与改动说明

    来源

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

07

集合与性能

5 项
  • 反复左结合地追加列表(xs ++ [x])或在循环中使用 ++,使构造代价变为平方级;应前插后反转、使用 builder,或用合适的序列累加
    内置
    来源与改动说明

    来源

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

  • 遍历内部反复调用 length、用 !! 索引或做线性成员检查,而单趟遍历、fold 或 Set/Map 本可避免平方级开销
    内置
    来源与改动说明

    来源

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

  • 在热点或高频路径上反复在 String、严格/惰性 Text 与严格/惰性 ByteString 之间转换
    内置
    来源与改动说明

    来源

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

  • 对大型文本或字节处理工作负载使用 String,而周边 API 已是 Text 或 ByteString,且能实质性避免逐字符分配
    内置
    来源与改动说明

    来源

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

  • 强制并行而不加限制,可能保留整个输入或创建超出有效工作的 spark/任务
    内置
    来源与改动说明

    来源

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

08

不安全特性、FFI 与元编程

5 项
  • unsafePerformIO 的结果依赖可变状态、调用顺序,或依赖未反映在返回值中的参数,或在需要之处缺少 NOINLINE/文档化的引用透明性不变量
    内置
    来源与改动说明

    来源

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

  • 使用 unsafeCoerce、裸地址操作或 GHC.Exts 原语,而没有严格窄化的文档化表示与生命周期不变量
    内置
    来源与改动说明

    来源

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

  • FFI 调用对指针生命周期、可空性、缓冲区长度、对齐、所有权转移、终结器、回调或 C 字符串编码处理不当
    内置
    来源与改动说明

    来源

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

  • Template Haskell、拟引用(quasiquotation)或生成源码将不可信数据并入可执行代码
    内置
    来源与改动说明

    来源

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

  • 在正确性依赖效果顺序、句柄生命周期或异常行为时使用 unsafeInterleaveIO 或惰性 I/O
    内置
    来源与改动说明

    来源

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

09

安全敏感代码

4 项
  • HASKELL-SECURITY-001状态加载中
    外部输入未经严格校验即传给 System.Process.shell、显式 shell 命令、SQL 拼接或模板/代码求值;优先使用带参数列表的 proc 与参数化 API
    内置
    来源与改动说明

    来源

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

  • HASKELL-SECURITY-002状态加载中
    使用不可信路径时未约束遍历范围、符号链接行为及预期根目录
    内置
    来源与改动说明

    来源

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

  • HASKELL-SECURITY-003状态加载中
    密钥、令牌、私钥、凭据或个人身份信息被写入日志、异常、源代码或序列化诊断信息
    内置
    来源与改动说明

    来源

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

  • HASKELL-SECURITY-004状态加载中
    认证、授权、密码学或随机令牌代码使用了临时拼凑的算法、(在相关场景下)非常数时间的秘密比较,或非密码学 RNG
    内置
    来源与改动说明

    来源

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

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

手动复制规则链接

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