【Ruby3.x】Module::private_method_defined?()メソッドの使い方
private_method_defined?メソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
private_method_defined?メソッドは、レシーバであるモジュールまたはクラスに、引数で指定された名前のプライベートメソッドが定義されているかを確認するメソッドです。
このメソッドは、メソッド名をシンボルまたは文字列で引数として受け取ります。指定された名前のメソッドがプライベートメソッドとして存在し、かつ呼び出し可能な状態であればtrueを返します。該当するプライベートメソッドが存在しない場合はfalseを返します。
メソッドの検索範囲は、レシーバ自身だけでなく、その祖先クラスやミックスインされたモジュールまで含まれます。そのため、継承によって利用可能になっているプライベートメソッドも正しく検出することが可能です。
主に、プログラムの実行中に特定のプライベートメソッドが内部的に存在するかどうかを動的にチェックする場面で利用されます。例えば、リフレクションを用いてプライベートメソッドを間接的に呼び出す前に、そのメソッドの存在を安全に確認する目的で使用されます。また、ライブラリやフレームワークの開発において、特定の内部実装が意図通りに提供されているかを検証する際にも役立ちます。
method_defined?メソッドがすべての可視性のメソッドを対象とするのに対し、private_method_defined?はプライベートメソッドに限定されるため、より具体的なメソッドの存在確認が可能です。システム内部の整合性を保つためや、デバッグ時におけるメソッドの状態確認に非常に有用です。
構文(syntax)
1class MyExampleClass 2 private 3 def my_private_method; end 4end 5 6MyExampleClass.private_method_defined?(:my_private_method)
引数(parameters)
method_name, inherit = true
- method_name: 調査したいメソッドの名前 (Symbol または String)
- inherit = true: 親クラスのメソッドも調査対象に含めるかどうかの真偽値 (Symbol, String)
戻り値(return)
Boolean
指定されたモジュール内に、指定された名前のプライベートメソッドが定義されているかどうかを真偽値（True/False）で返します。