Rubyでbacktraceを使う方法を現役エンジニアが解説【初心者向け】

Rubyでbacktraceを使う方法について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して初心者向けに解説します。

 

そもそもRubyについてよく分からないという方は、Rubyとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプRuby講座の内容をもとに紹介しています。

 

目次

• backtraceとは
• backtraceを使うメリットと利用シーン
• backtraceを使う方法
• 実際に書いてみよう
• まとめ

 

backtraceとは

backtraceとは、例外処理を行うときに、例外が発生したときのプログラムの呼び出し状況を取得するメソッドです。

 

[PR] 未経験からWebエンジニアを目指す方法とは

backtraceを使うメリットと利用シーン

例外処理を行うと、例外は検知できますが、具体的にコードのどこで例外が発生したかはわかりません。backtraceメソッドを呼び出すことで、どの部分で例外が発生したか確認できます。ソースコードレベルで確認できるので、デバッグに役立ちます。

 

backtraceを使う方法

backtraceメソッドは以下のように使います。

begin
  エラーが発生する処理
   あるいは
  raise 発生させたい例外
rescue => e
  復旧処理
  e.backtrace
end

例外処理の復旧処理の中で使用します。backtraceメソッドの戻り値は、バックトレースの文字列の配列です。

 

実際に書いてみよう

begin
  2/0 # ZeroDivideErrorが発生する
rescue => e
  puts "エラーが発生しました。"
  puts e.backtrace
ensure
  puts "例外処理を終わります。"
end

と書きます。

このプログラムを実行すると、

エラーが発生しました。
backtrace.rb:2:in `/'
backtrace.rb:2:in `<main>'
例外処理を終わります。

が表示されます。呼び出した時のバックトレースが表示されます。プログラムに例外処理を実装せずに異常終了した時に見かけるメッセージと同じフォーマットです。実行したRubyのソースコード名とその行番号が取得できます。

この例では、backtrace.rbを実行してプログラムのメインで例外が発生していることがわかります。ソースコードの行番号もわかります。バックトレースは、

backtrace.rb:2:in `/'      - 例外が発生した処理(backtrace.rbの2行目)
backtrace.rb:2:in `<main>' - 例外が発生した場所(backtrace.rbの2行目)

という内容です。この例では、2つの文字列が取得できます。

メソッド呼び出しの先で例外が発生した場合もバックトレースで状況がわかります。

class Error_method
  def self.foo
    2/0 # ZeroDivideErrorが発生する
  end
end

begin
  Error_method.foo # クラスメソッド呼び出し
rescue => e
  puts "エラーが発生しました。"
  puts e.backtrace
ensure
  puts "例外処理を終わります。"
end

このプログラムを実行すると、

エラーが発生しました。
backtrace.rb:3:in `/'
backtrace.rb:3:in `foo'
backtrace.rb:8:in `<main>'
例外処理を終わります。

が表示されます。呼び出した時のバックトレースが表示されます。この例では、backtrace.rbを実行してプログラムのメインからfooメソッドを呼び出した先で例外が発生していることがわかります。バックトレースは、

backtrace.rb:3:in `/'      - 例外が発生した処理(backtrace.rbの3行目)
backtrace.rb:3:in `foo'    - 例外が発生したメソッド(backtrace.rbの3行目)
backtrace.rb:8:in `<main>' - メソッドを呼び出した場所 (backtrace.rbの8行目から呼び出し)

という内容です。

 

まとめ

backtraceは、例外処理が発生した場所を特定することができます。デバッグ目的に使って効率的に開発してみましょう。

 

監修してくれたメンター

伊藤広明（いとうひろあき） 1990年代からソフトウェア開発を仕事としてはじめ、2000年ごろからWEBエンジニアの仕事にも従事。 世の中で末長く使ってもらえるシステム開発が信条。後進の育成にも力を入れている。 作れるもの：Webシステム、スマホアプリ 書ける言語: Ruby・PHP・Python・Java・Swift・C#・C/C++・JavaScriptなど 経験があるフレームワーク: Laravel・Ruby on Rails・Apache Strutsなど

 

 

TechAcademyでは、初心者でもRuby on Railsを使ったプログラミングを習得できるオンラインブートキャンプRuby講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。