Sorbet项目中的可空类型(T.nilable)详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00534/article/details/148574764

Sorbet项目中的可空类型(T.nilable)详解

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

什么是可空类型

在Sorbet静态类型检查系统中，可空类型(Nilable Types)是指那些可能为nil的值类型。Sorbet默认情况下所有类型都是非空的，这意味着如果我们希望某个类型可以接受nil值，必须显式地使用T.nilable来声明。

T.nilable(String)  # 可以是String类型，也可以是nil

这种类型声明表示该值可以是nil，也可以是任何Ruby字符串。

可空类型的基本用法

在实际代码中，我们可以这样使用可空类型：

extend T::Sig

# 方法签名声明接受一个可能为nil的字符串
sig {params(x: T.nilable(String)).void}
def foo(x)
  if x
    puts "x不是nil! 值为: #{x}"
  else
    puts "x是nil"
  end
end

Sorbet对nil的智能追踪

Sorbet最强大的特性之一是能够通过程序的控制流来更新它对变量类型的认知。例如：

extend T::Sig

# 这个方法只接受非nil的字符串
sig {params(x: String).void}
def must_be_given_string(x)
  puts "获取字符串: #{x}"
end

sig {params(x: T.nilable(String)).void}
def foo(x)
  must_be_given_string(x) # 错误：期望String但得到T.nilable(String)
  
  if x
    must_be_given_string(x) # 正确：在这个分支中x肯定不是nil
  end
end

这种控制流敏感的类型检查是Sorbet最有用的特性之一，能够有效预防许多由nil引起的错误。

使用T.must断言非nil值

当Sorbet报告类型不匹配错误时，最佳实践是仔细思考为什么会出现这个错误。但有时我们确信某个值永远不会是nil，或者处理nil情况并不重要，这时可以使用T.must来消除错误。

extend T::Sig

sig {params(x: Integer).void}
def doesnt_take_nil(x); end

sig {params(key: Symbol, options: T::Hash[Symbol, Integer]).void}
def foo(key, options)
  val = T.must(options[key])  # 我们确信这个值不会是nil
  doesnt_take_nil(val) # 现在可以通过检查
end

使用T.must相当于告诉Sorbet："请相信我，这个值在运行时永远不会是nil"。这实际上是将代码正确性的证明责任从类型系统转移到了程序员身上。

T.must的替代方案

虽然T.must很有用，但有时会使代码显得杂乱。以下是几种替代方案：

1. 使用fetch方法

Ruby标准库提供了fetch方法，可以在元素不存在时抛出异常：

# 使用T.must
val = T.must(options[key])

# 使用fetch
val = options.fetch(key)

# 带默认值的fetch
val = options.fetch(key, 0)  # 如果key不存在，返回0

2. 安全导航操作符(&.)

Ruby 2.3引入的安全导航操作符可以在对象为nil时安全地调用方法：

extend T::Sig

sig {params(x: T.nilable(Integer)).returns(Integer)}
def foo(x)
  y = T.must(x).abs  # 如果x是nil会抛出异常
  y
end

sig {params(x: T.nilable(Integer)).returns(T.nilable(Integer))}
def bar(x)
  y = x&.abs  # 如果x是nil返回nil
  y
end