Ruby Memoization 性能優化之記憶化

2019-08-04

Memoization 是什麼

基本上是對「函數」的一種快取(Cache)，能夠在執行一次調用後將結果快取下來，避免在第二次調用時再次花費計算成本。

在 Ruby 內使用 memoization 的例子

def orders
  @orders ||= Order.all
end

||= 會在參數為 nil 時執行調用後者的 Order.all，當 @orders 被塞入值之後則會直接拿 cache 的資料回傳，也就是說在這裡無論 call 多少次 orders 也只會有一次的 SQL query

不是每個情況都需要 cache

cache 是有成本的，過度的 cache 會造成難以追蹤數據是在哪一個地方被 cache，同時也要考慮 cache invalidation 的狀況

基本上還是要看情況來判斷到底該不該用 memoization，而使用的情況依照資源運算成本來說可能分為幾種

成本	呼叫次數	好處
低	一次	完全沒有
低	多次	除非工作量非常大，否則好處不明顯
高	多次	可能值得

所以在撰寫設計時需要注意這樣操作的好處是否值得？

class Comment
  # ...

  def review_ended?
    # 這裡計算資源成本便宜，所以不需要實做快取類似以下
    # @review_ended ||= 24.hours.ago >= updated_at

    24.hours.ago >= updated_at
  end
end

Constructors

Ruby 常見的 class 在初始化時可以透過 initialize 將值塞進 instance variable

class PlaceOrderService
  attr_reader :user

  def initialize(user_id)
    @user = User.find(user_id)
  end
end

這樣在 object 被建立時，就可以直接讀取 @user 了，不需要每次再透過 user_id 去尋找

懶加載 Laziness

如果有一個昂貴的操作不一定會呼叫到，那麼把昂貴的機算用 memoization 丟到 method 內是更好的作法。

這樣一來在 object 生成時，並不會直接執行該 method，而是等到真正被呼叫到時才執行，並且也能夠在被呼叫時把這個昂貴的操作 cache 起來

class User
  def main_address
    @main_address ||= begin
      # do expensive work
      maybe_main_address = home_address if prefers_home_address?
      maybe_main_address = work_address unless maybe_main_address
      maybe_main_address = addresses.first unless maybe_main_address
    end
  end
end

begin..end 會創建一個 block 然後回傳最後的值，同時也可以拿到 block 裡面定義的變數，其實和直接定義 method 有點相似，差別他可以和外圍的程式碼共享局部變數就是了。

所以其實我們可以把包 begin 的部分在單獨拆開如下一個範例所示

將 cache 和計算分開

這樣做比上面更好了，除了可讀性的提升，也便於測試，必要時還可以覆用 method

class User
  def main_address
    @main_address ||= maybe_main_address
  end

  private
  
  # do expensive work
  def maybe_main_address
    return home_address if prefers_home_address?
    
    work_address || addresses.first
  end
end

或是把昂貴操作放在 constructor 也行

class User
  def initialize
    @main_address ||= maybe_main_address
  end

  private

  # do expensive work
  def maybe_main_address
    return home_address if prefers_home_address?
    
    work_address || addresses.first
  end
end

小結

Memoization 使用場景

將昂貴的操作 cache 起來
延遲不一定會操作到的昂貴 method（懶加載）

常用情況

object 頻繁操作的對象可以直接放在 constructor 在生成時直接快取，並可以設置 attr_reader
只用一次的操作丟到 method 就好
便宜的操作資源丟到 method 就好
昂貴且不一定會用到的資源用可以用 memoization 處理懶加載 + 快取

Nic Lin's Blog