included

インクルーデッド（メタプログラミング）

意味モジュールがincludeされた時のフック

includedとは？

includedは、モジュールが他のクラスやモジュールにincludeされた時に自動的に呼び出されるメソッドです。これを使うと、モジュールがincludeされた際に特定の処理を実行できます。

includedの具体的な使い方

モジュールのincludeフックを使用してクラスメソッドを追加する例

module Greeting
  def self.included(base)
    base.extend(ClassMethods)
  end

  module ClassMethods
    def greet
      puts "こんにちは、#{self}クラスです！"
    end
  end
end

class User
  include Greeting
end

User.greet

👇出力結果

こんにちは、Userクラスです！

この例では、Greetingモジュールのincludedフックを使用して、includeしたクラスにクラスメソッドgreetを自動的に追加しています。ClassMethodsモジュールをextendすることで、クラスメソッドとして追加されます。

モジュールのincludeフックを使用してインスタンス変数を初期化する例

module Initializable
  def self.included(base)
    base.class_eval do
      attr_accessor :initialized_at
      alias_method :original_initialize, :initialize
      define_method(:initialize) do |*args|
        @initialized_at = Time.now
        original_initialize(*args)
      end
    end
  end
end

class MyClass
  include Initializable
  def initialize(name)
    @name = name
  end
end

obj = MyClass.new("Ruby")
puts "初期化時刻: #{obj.initialized_at}"

👇出力結果

初期化時刻: 2023-06-12 10:30:45 +0900

この例では、Initializableモジュールのincludedフックを使用して、includeしたクラスのinitializeメソッドを拡張しています。オブジェクトが作成された時刻を自動的に記録するinitialized_at属性を追加しています。

includedに関するよくある質問

Q. includedメソッドの引数baseとは？

A. baseは、モジュールがincludeされたクラスまたはモジュールを指します。この引数を通じて、includeした側の情報にアクセスできます。

Q. includedはいつ呼び出される？

A. includedは、モジュールが他のクラスやモジュールにincludeされた瞬間に自動的に呼び出されます。

Q. includedの一般的な使用例は？

A. モジュールがincludeされた時に、追加のセットアップやメソッドの定義、クラスへの機能追加などを行うために使用されます。例えば、クラスメソッドの自動追加などに利用できます。

includedが学べる書籍の紹介

「プログラミング単語帳」を使って、プログラミングの単語を英単語のように学習してみませんか？
プログラミング単語帳には、Rubyのincludedやmethod_added、eval、inherited、などのような実務でよく使われる単語が数百以上収録されています。
この書籍には、プログラミングの単語の意味や読み方、単語の使い方がわかる例文などが掲載されており、いつでもどこでもプログラミングの学習ができます。

よく使われる単語にだけ絞って学習することができるので、効率的にプログラミングが学習できます。