rails の自動読み込みを支える技術

Rails の自動読み込みを支える技術

2013-09-07 広島Ruby勉強会 #034

13年9月7日土曜日

Rails の読み込み規約

• Hoge -> hoge.rb• HogeMogu -> hoge_mogu.rb• Hoge::Mogu -> hoge/mogu.rb


名前の変換

• ActiveSupport::Inflector.underscore• Core Extention• String#underscore


関連モジュール

• ActiveSupport::Dependencies• ActiveSupport::Autoload


ActiveSupport::Dependencies


自動読み込み

• Rails 用のコードはクラス名から自動読み込みできる

• RAILS_ROOT/app/models/...• RAILS_ROOT/app/helpers/...• ...


RAILS_ROOT/libなど自動は読み込みできない


Rails を使わない場合

require 'active_support/dependencies.rb'ActiveSupport::Dependencies.autoload_paths << 'lib'


lib から自動読み込みができるようになります


ライブラリなどでは使わない

•自作ライブラリで規約に沿った読み込みは ActiveSupport::Autoload を使う

•アプリケーションの記述をシンプルにするために使う？


Rails での初期値

• RAILS_ROOT/app/assets• RAILS_ROOT/app/controllers• RAILS_ROOT/app/helpers• RAILS_ROOT/app/mailers• RAILS_ROOT/app/models• RAILS_ROOT/app/controllers/concerns• RAILS_ROOT/app/models/concerns


仕組み

• ConstMissing に処理を追加• autoload_paths の中にあるか確認•あれば読み込み•なければ ConstMissing 発生


動作をみたいなら

• Logger を設定• log_activity = true に設定• Rails の場合は Logger は設定済み


Logger を使う

require 'active_support/dependencies.rb'require 'logger'ActiveSupport::Dependencies.logger = Logger.new($stderr)ActiveSupport::Dependencies.log_activity = true


require するだけで使える

• 読み込み時に呼んでるメソッドがある• ActiveSupport::Dependencies.hook!• 止めたい場合は• ActiveSupport::Dependencies.unhook!


知ってると便利かも


ActiveSupport::Dependencies.warnings_on_first_load

•はじめて読み込みしたクラス•ログに出力•二度目は出力しない


ActiveSupport::Dependencies.history

•読み込みしたクラスが格納• Set で格納•順番はわからない


ActiveSupport::Dependencies.loaded

•読み込みしたクラスがわかる•History との違い• clear されることがある•これも Set


ActiveSupport::Dependencies.mechanism

•読み込みする時に• load を使うか (デフォルト)• require を使うか•環境変数 NO_RELOAD を設定で • require に


ActiveSupport::Dependencies.explicitly_unloadable_constants

•自動読み込みの対象にしない名前を登録


ActiveSupport::Autoload


ライブラリで規約を利用

• Rails のコードではよく使われている• lib/active_support.rb• lib/active_record.rb


autoload を拡張

• Kernel.autoload(module, filename)• Module.autoload(module, filename)•引数が2つ必要


autoload を拡張

• ActiveSupport::Autoload• #autoload(const_name, path = @@at_path)• 第2引数がオプションに


autoloadについて

•あるクラスが必要になった時にはじめてファイルを読み込みする

•第1引数あるクラスの名前•第2引数読み込みするファイル


第2引数は規約から推測可能


Kernelのほうはそのまま


Module のほうだけ拡張


例require 'active_support/dependencies/autoload'

module Hoge extend ActiveSupport::Autoload autoload :Moguend

Hoge::Mogu# > LoadError: cannot load such file -- hoge/mogu


eager_autoload と autoload!


よくある光景

eager_autoload do autoload :Hoge autoload :Moguend


auto_load!

• eager_autoload の中にかいておくと auto_load! でまとめて読み込みできる

•利点がはっきりとわからないです•知ってたら教えて


ご清聴ありがとうございます


rails の自動読み込みを支える技術

Technology