Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Ruby3.x】Exception::backtrace_locations()メソッドの使い方

backtrace_locationsメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

backtrace_locationsメソッドは、例外が発生した位置の情報(スタックトレース)を詳細に取得するメソッドです。このメソッドは、Exceptionクラスのインスタンスに対して呼び出され、例外がプログラムのどの場所で、どのようなメソッド呼び出しの連鎖を経て発生したかを具体的に教えてくれます。戻り値は、Thread::Backtrace::Locationオブジェクトの配列となります。

それぞれのThread::Backtrace::Locationオブジェクトは、スタックトレースの各行に対応しており、例外発生時のファイル名、行番号、およびその位置で実行されていたメソッド名やクラス名などの具体的な情報を含んでいます。これにより、単なる文字列の配列としてスタックトレースを返すbacktraceメソッドとは異なり、プログラム的に構造化されたデータとして各要素にアクセスし、より柔軟に情報を利用したり処理したりすることが可能です。

このメソッドは、デバッグ作業やエラーハンドリングにおいて非常に有用です。例えば、エラーログを自動生成する際に、例外発生箇所の詳細な情報をプログラム的に取得して記録したり、特定の条件に基づいてエラーの原因を特定し、適切なエラー処理を分岐させたりする際に活用できます。システム開発において、予期せぬエラーが発生した場合の原因特定を効率化し、堅牢なアプリケーションを構築するための重要な機能の一つです。

構文(syntax)

1begin
2  raise "何らかのエラー"
3rescue => e
4  e.backtrace_locations
5end

引数(parameters)

引数なし

引数はありません

戻り値(return)

現在のスレッドにおける、例外発生時のコールスタックを表す Thread::Backtrace::Location オブジェクトの配列が返されます。

関連コンテンツ