NOTE / Ruby-On-Rails

use mixin and autoload_paths vs eager_load_paths

使用 mixin 以及 autoload_paths vs eager_load_paths解說

2018.03.01 / Ruby-On-Rails /

Ruby

先進行 mixin 範例
如果不想使用mixin請使用以下方式直接在Controller新增 Controller級的helper

helper_method :current_cart
def current_cart
  @current_cart ||= find_cart
end

在 lib/modules/common_helper.rb 先新增我們所需要的helper相關資訊
將Cart相關資訊存在session裡面 common_helper.rb

module CommonHelper
  def current_cart
    @current_cart ||= find_cart
  end
  def find_cart
      cart = Cart.find_by(id: session[:cart_id])
      if cart.blank?
        cart = Cart.create
      end
      session[:cart_id] = cart.id
      return cart
  end
end

接下來在 config/application.rb新增自動載入方式這樣就完成了可以在Controller or View 呼叫

config.eager_load_paths << "#{Rails.root}/lib/modules"

eager_load_paths目錄是指 Rails 會自動根據命名慣例載入，而 Ruby 的 $LOAD_PATH 常數則是 require 時會尋找的目錄。像 lib 這個目錄 Rails 預設就只有加到 $LOAD_PATH 之中，所以你放在 lib 的檔案是可以 require 到，但是因為預設沒有加到eager_load_paths之中，所以沒有自動載入的機制。

若要查看是否有載入請在rails c 輸入這行ActiveSupport::Dependencies.autoload_paths OR Rails.application.config.assets.paths即可

> rails c
> ActiveSupport::Dependencies.autoload_paths
[
    [ 0] "/Users/app/assets",
    [ 1] "/Users/app/channels",
    [ 2] "/Users/app/controllers",
    [ 3] "/Users/app/controllers/concerns",
    [ 4] "/Users/app/helpers",
    [ 5] "/Users/app/jobs",
    [ 6] "/Users/app/mailers",
    [ 7] "/Users/app/models",
    [ 8] "/Users/app/models/concerns",
    [ 9] "/Users/app/uploaders",
我們需要的是載入這行 -> [10] "/Users/lib/modules",
    [11] "/Users/.rvm/gems/ruby-2.3.1/gems/devise-4.4.1/app/controllers",
    [12] "/Users/.rvm/gems/ruby-2.3.1/gems/devise-4.4.1/app/helpers",
    [13] "/Users/.rvm/gems/ruby-2.3.1/gems/devise-4.4.1/app/mailers",
    [14] "/Users/.rvm/gems/ruby-2.3.1/gems/font-awesome-rails-4.7.0.3/app/assets",
    [15] "/Users/.rvm/gems/ruby-2.3.1/gems/font-awesome-rails-4.7.0.3/app/helpers",
    [16] "/Users/.rvm/gems/ruby-2.3.1/gems/material_icons-2.2.1/app/assets",
    [17] "/Users/.rvm/gems/ruby-2.3.1/gems/material_icons-2.2.1/app/helpers",
    [18] "/Users/.rvm/gems/ruby-2.3.1/gems/material_icons-2.2.1/app/models",
    [19] "/Users/test/mailers/previews"
]

Controller 裡使用

def add_to_cart
  extend CommonHelper
  current_cart.add_product_to_cart(@product)
end

View 裡使用

<% extend CommonHelper %>

• include 提供了混合它的Class的實例方法。(動態使用)
• extend 擴展為混合Class提供類方法。(靜態使用)
• 建議使用 extend 取代 include 這樣就不用include 在 new 了
  extend or include
  extend include 解說

  autoload_paths 以及 eager_load_paths使用方式

  autoload_paths在 Rails版本 < 5以下做使用以下任一種方式即可使用 in config/application.rb

  config.autoload_paths += Dir["#{config.root}/lib/**"]
  config.autoload_paths += %W(#{config.root}/lib/modules)
  

  eager_load_paths 在 Rails版本 >= 5使用以下任一種方式即可使用，in config/application.rb

  config.eager_load_paths << "#{Rails.root}/lib/modules"
  config.eager_load_paths += %W(#{config.root}/lib/modules)
  config.eager_load_paths += %W(
  #{config.root}/lib/modules
  #{config.root}/lib/my_others
  )
  

上production因安全所需會自動取消autoload_paths，所以在此建議使用eager_load_paths 上production會比以較不會發生異常。
總結：autoload_paths就是當使用某個常量（比如module class時），rails會調用const_missing，然後在autoload_paths的數組目錄中查找，找到該常量後加載使用。簡單認為，在使用時，才加載相關代碼。 優點：能夠快速啟動rails，在啟動rails時減少加載代碼，在使用時臨時加載進來。eager_load_paths在rails啟動時，就把eager_load_paths中的目錄代碼加載進來.production環境時建議使用，eager_load_paths加載。這樣雖然啟動的 時候速度會變慢，因為要加載更多代碼，但是，這樣加載預熱後，在用戶使用程序時，就能很快的調用到相關代碼，因為已經在啟動的時候加載好了。 關於lib目錄中的代碼文件根據實際情況需要，選擇加載方式。

REFERENCE / 5

• autoload_paths vs eager_load_paths詳細說明 ↗
• Don't forget about eager_load when extending autoload paths ↗
• autoload_paths or eager_load其他使用方式 ↗
• rails3中autoload_paths加載詳細說明 ↗
• helper-method-and-view-context解說 ↗