ruby中的freeze

freeze方法可以将一个Ruby对象冻结起来防止其被意外更改。

一个关于freeze的小问题

下面这段代码没有报错,是不是很奇怪呢?

a = "Test"
a.freeze
a += "this string"
puts a

Test this string
[Finished in 0.0s]

行为上看起来有些吊诡,但实际上问题并没有出在freeze上,freeze所限制的是一个对象,而这里确实为一个变量重新赋值,下面两句其实是等价的:

a += "this string"
a = a + "this string"

也就是说"Test"对象并没有被修改,其仍然在内存中,只不过现在成了一个无法被访问等待回收的垃圾对象。这一点可以通过a.object_id观察到。

当你真正要修改freeze对象时,它依然会抛出一个运行时错误,像下面这样:

a << "this string"
RuntimeError: can't modify frozen String

freeze的使用场景

1. 创建不变的常量

在Ruby语言中,常量是可变的,可以用如下代码解释

MY_CONSTANT = "foo"
MY_CONSTANT << "bar"
puts MY_CONSTANT.inspect # => "foobar"

但是通过freeze,可以实现真正意义的常量,这时,再次尝试更改常量,就会出现FrozenError,如下

MY_CONSTANT = "foo".freeze
MY_CONSTANT << "bar" # => RuntimeError: can't modify frozen string
image.png

如下就是ActionDispatch代码库中的一个真实使用例子,在rails日志中敏感词使用文本’[FILTERED]‘代替,这个文本就存储在冻结常量中。

module ActionDispatch
  module Http
    class ParameterFilter
      FILTERED = '[FILTERED]'.freeze
      ...

2. 减少对象分配

ruby加速的最佳方法之一就是减少创建对象的数量,对象分配一个烦人的源头就是大部分应用程序中散布的字符串。
每次调用log("foobar")类似的方法时,都会创建一个新的字符串对象,如果你的代码每秒要调用上千次类似的方法,这就意味着你每秒要创建上千个字符串,那是很大的开销。
幸运的是,ruby有个解决方法,如果我们冻结字符串常量,那将只会创建一个字符串对象,并且会缓存起来供将来使用,我将frozen和non-frozen的字符串进行了性能对比,结果显示性能提升了50%。

require 'benchmark/ips'

def noop(arg)
end

Benchmark.ips do |x|
  x.report("normal") { noop("foo") }
  x.report("frozen") { noop("foo".freeze)  }
end

# Results with MRI 2.2.2:
# Calculating -------------------------------------
#               normal   152.123k i/100ms
#               frozen   167.474k i/100ms
# -------------------------------------------------
#               normal      6.158M (± 3.3%) i/s -     30.881M
#               frozen      9.312M (± 3.5%) i/s -     46.558M

如果您查看Rails路由器,就可以看到这一点。由于路由器用于每个web页面请求,所以它需要速度快。这意味着有很多冻结的字符串字面量。

# excerpted from https://github.com/rails/rails/blob/f91439d848b305a9d8f83c10905e5012180ffa28/actionpack/lib/action_dispatch/journey/router/utils.rb#L15
def self.normalize_path(path)
  path = "/#{path}"
  path.squeeze!('/'.freeze)
  path.sub!(%r{/+\Z}, ''.freeze)
  path.gsub!(/(%[a-f0-9]{2})/) { $1.upcase }
  path = '/' if path == ''.freeze
  path
end

3. ruby>=2.2的软件内置优化

Ruby 2.2及其后版本(MRI)将自动冻结用作散列键的字符串文本。

user = {"name" => "george"}

# In Ruby >= 2.2
user["name"]

# ...is equivalent to this, in Ruby <= 2.1
user["name".freeze]

4. 对象的取值和函数式编程

尽管Ruby不是一种函数式编程语言,但是许多使用者都开始注意到里面函数样式的价值。这种样式的一个主要宗旨是,要防止外部修改。对象初始化之后不应发生改变。 通过在构造器里调用freeze函数,保证了对象不会更改。任何意外的外部修改都会导致异常值的出现。

class Point
  attr_accessor :x, :y
  def initialize(x, y)
    @x = x
    @y = y
    freeze
  end

  def change
    @x = 3
  end
end

point = Point.new(1,2)
point.change # RuntimeError: can't modify frozen Point

摘自:https://www.honeybadger.io/blog/when-to-use-freeze-and-frozen-in-ruby/

推荐阅读更多精彩内容