Sorbet/sorbet 常见问题解答：深入解析与最佳实践

Sorbet/sorbet 常见问题解答：深入解析与最佳实践

sorbet A fast, powerful type checker designed for Ruby 项目地址: https://gitcode.com/gh_mirrors/so/sorbet

为什么 Sorbet 认为这个值是 nil？我明明检查过它不是！

Sorbet 实现了流敏感（flow-sensitive）类型系统，但存在一些局限性。最值得注意的是，Sorbet 不会假设同一个方法被连续调用两次会返回相同的结果！

这是因为在 Ruby 中，方法调用可能产生副作用，导致连续调用返回不同值。例如：

def maybe_nil
  rand > 0.5 ? nil : "hello"
end

if maybe_nil
  puts maybe_nil.length  # Sorbet 会报错，因为第二次调用可能返回 nil
end

最佳实践是：将方法结果存储在局部变量中，然后对该变量进行检查：

value = maybe_nil
if value
  puts value.length  # 这样 Sorbet 就能正确推断类型
end

标准库的类型注解似乎不正确怎么办？

Sorbet 使用 RBI 文件来为 Ruby 标准库提供类型注解。这些 RBI 文件都是手动维护的，虽然能提供精细的类型信息，但有时可能不完整或不准确。

遇到这种情况时，你有两个选择：

1. 贡献修复：找到对应的 RBI 文件，直接提交类型注解的修正。这是最推荐的方式，因为所有 Sorbet 用户都能受益。

2. 使用逃生舱口：如果急需解决问题，可以使用 T.unsafe 等机制临时绕过类型检查。

标准库 RBI 文件的版本策略是保持向后兼容，通常会包含该 gem 过去和现在定义的所有内容。

T.let、T.cast 和 T.unsafe 有什么区别？

这三个类型断言方法各有特点：

• T.let：在变量赋值时声明其类型，会进行运行时检查
• T.cast：强制转换类型，仅在开发时检查，运行时不做验证
• T.unsafe：完全绕过类型检查系统

x = T.let(10, Integer)  # 运行时类型检查
y = T.cast("10", Integer)  # 开发时检查，运行时不做验证
z = T.unsafe(any_value)  # 完全绕过类型系统

如何为无返回值的方法添加类型签名？

使用 void 标识：

sig { void }
def do_something
  puts "This method returns nothing"
end

如何处理返回多个值的方法？

Ruby 的 return x, y 实际上是返回一个数组。在类型签名中，你可以：

1. 使用数组类型：

sig { returns(T::Array[Integer]) }
def two_numbers
  return 1, 2
end

2. 使用元组类型（实验性功能）：

sig { returns([Integer, String]) }
def number_and_string
  return 42, "answer"
end

如何为 attr_* 方法添加类型？

Sorbet 对 attr_reader、attr_writer 和 attr_accessor 有特殊支持。添加类型的方式与普通方法类似：

class Example
  extend T::Sig

  sig { returns(Integer) }
  attr_reader :read_only

  sig { params(write_only: String).returns(String) }
  attr_writer :write_only

  # 对于 attr_accessor，只需为读取部分写签名
  sig { returns(Float) }
  attr_accessor :read_write
end

注意：在 typed: strict 模式下，所有实例变量都必须在初始化方法中赋值或标记为可空。

Array 和 T::Array[...] 有什么区别？

• Array 是 Ruby 原生的数组类
• T::Array[...] 是 Sorbet 的泛型数组类型，必须指定元素类型

虽然 Sorbet 隐式将 Array 视为 T::Array[T.untyped]，但不能直接使用 T::Array 作为独立类型。

如何接受类对象而不是类实例？

使用 T.class_of：

sig { params(klass: T.class_of(MyClass)).void }
def takes_class(klass)
  klass.new  # 可以安全地调用类方法
end

如何为 initialize 方法写签名？

建议始终使用 void 作为返回值类型：

sig { void }
def initialize
  @value = T.let(0, Integer)
end

这可以提醒调用者应该使用 .new 方法而不是直接调用 initialize。

如何重写 == 方法？应该用什么签名？

重写 == 或 eql? 时，建议使用以下签名：

sig { params(other: T.anything).returns(T::Boolean) }
def ==(other)
  case other
  when self.class
    # 自定义相等性比较逻辑
  else
    false
  end
end

使用 case/when 或 === 进行类型检查比 is_a? 更可靠。

如何避免频繁使用 T.must 处理数组和哈希？

Ruby 的 [] 方法默认返回可空类型。如果你确定键存在，可以使用 fetch 方法：

hash = { key: "value" }
value = hash.fetch(:key)  # 如果键不存在会抛出异常

为什么 super 调用有时是未类型化的？

Sorbet 对 super 的类型检查有以下限制：

1. 必须在类中定义的方法，不能在模块中
2. 不能在 Ruby 块内使用（如 do...end）

要解决 super 的类型错误：

1. 确保父类方法确实存在
2. 检查是否违反了重写规则
3. 对于 initialize 方法，记得 super 返回 void
4. 可以使用 T.bind(self, T.untyped) 临时禁用类型检查

为什么 T.untyped && T::Boolean 返回 T.nilable(T::Boolean)？

这是因为 T.untyped 包含 nil，而 nil && anything 在 Ruby 中返回 nil。因此整个表达式的类型必须包含 nil 可能性。

Sorbet 能与 Rake/Rakefile 一起工作吗？

可以，但需要额外配置。因为 Rake 会修改全局对象添加 DSL 方法，Sorbet 无法自动识别这些方法。需要在 RBI 文件中为 Rake 的 DSL 方法添加类型定义。

---

通过本文，我们详细探讨了 Sorbet 使用中的常见问题及其解决方案。掌握这些知识点能帮助你更高效地使用 Sorbet 进行 Ruby 类型检查，写出更健壮的代码。

sorbet A fast, powerful type checker designed for Ruby 项目地址: https://gitcode.com/gh_mirrors/so/sorbet