【Rails】Railsアプリにオリジナルのエラーページ(404/500)を実装

はじめに

Railsアプリを新規作成した時点では、404 Not Foundのエラーページは以下のようになっています。

エラーが出ているということは伝わりますが、すべて英語で書かれていて無骨な印象を受けます。404 Not Foundという文言も見当たらないため、一見してどういう内容のエラーなのかが伝わりにくいです。このようなエラーページではなく、もっとわかりやすいオリジナルのエラーページを実装することができます。

本記事では、Railsアプリでオリジナルのエラーページを実装する方法について説明します。

オリジナルのエラーページを実装

ルーティングの追加

config/routes.rbの最後(endの直前)に以下のルーティングを追記します。他のどのルーティングにも一致しないリクエストの場合はApplicationContollerrouting_errorアクションを実行するようにしています。

get '*not_found' => 'application#routing_error'
post '*not_found' => 'application#routing_error'

アクションの追加

app/controller/application_controller.rbに以下を追記します。

class ApplicationController < ActionController::Base
  unless Rails.env.development?
    rescue_from Exception,                      with: :_render_500
    rescue_from ActiveRecord::RecordNotFound,   with: :_render_404
    rescue_from ActionController::RoutingError, with: :_render_404
  end

  def routing_error
    raise ActionController::RoutingError, params[:path]
  end

  private
    def _render_404(e = nil)
      logger.info "Rendering 404 with excaption: #{e.message}" if e

      if request.format.to_sym == :json
        render json: { error: "404 Not Found" }, status: :not_found
      else
        render "errors/404.html", status: :not_found, layout: "error"
      end
    end

    def _render_500(e = nil)
      logger.error "Rendering 500 with excaption: #{e.message}" if e

      if request.format.to_sym == :json
        render json: { error: "500 Internal Server Error" }, status: :internal_server_error
      else
        render "errors/500.html", status: :internal_server_error, layout: "error"
      end
    end
end

エラーページのレンダリングをしている箇所について、errors/404.htmlのように必ず拡張子をつけるようにしてください。例えば/icon.gifのようなリクエストがきた場合、レンダリングの指定ファイルの拡張子が省略されていると、リクエストの拡張子に基づいたerrors/404.gifをレンダリングしようとしエラーになります。

より丁寧に以下のように書くこともできます。

respond_to do |format|
  format.json { render json: { error: "404 Not Found" }, status: :not_found }
  format.all { render file: 'errors/404.html', content_type: 'text/html', status: :not_found, layout: 'error' }
end

なお、開発環境でエラーページの確認をする場合は、Rails.env.development?Rails.env.production?に変えるか、条件文をコメントアウトするなどしてください。

ビューの追加

app/views/errors/ディレクトリを作成し、その中に404.html.erb500.html.erbを作成してください。また、レイアウトを指定している場合はapp/views/layouts/ディレクトリ配下にerror.html.erbを作成してください。

今回は以下のようなシンプルなエラーページを作成しました。

まとめ

普段はあまりユーザーの目に入らないエラーページですが、だからこそこだわってオリジナルのエラーページを実装していると「おっ」と思ってもらえるかもしれません。そんなに難しい作業ではないので、余裕があればぜひオリジナルのエラーページを実装してみましょう。

本記事を参考にして、オリジナルのエラーページを実装していただければと思います。

関連記事

【Rails】Paranoiaを使用した論理削除(ソフトデリート)
# はじめに Paranoiaは、Railsアプリケーションで論理削除(ソフトデリート)を実現するためのGemです。 論理削除は、データベースのレコードを物理的に削除するのではなく、削除フラグを設定することで「削除済み」とみなす方法です。こ [...]
2024年7月20日 21:33
【Rails】activerecord-multi-tenantを使用したマルチテナントアプリケーションの作成
# はじめに マルチテナントアプリケーションでは、複数の顧客(テナント)が同じアプリケーションを利用するため、データの分離が必要です。 activerecord-multi-tenantは、このようなマルチテナント環境をサポートするための便 [...]
2024年7月18日 16:50
【Rails】RubyとRailsにおけるattr_reader, attr_writer, attr_accessorの概念と使用方法
# はじめに RubyとRailsの開発において、`attr_reader`,`attr_writer`,`attr_accessor`は非常に便利なメソッドです。これらは、クラス内でインスタンス変数に対するゲッターおよびセッターメソッドを簡単に [...]
2024年7月17日 18:11
【Rails】RubyとRailsにおけるyieldの概念と使用方法
# はじめに RubyとRailsにおける`yield`は、メソッドやテンプレートの中で動的にコードブロックを実行する能力を提供し、これによってコードの再利用性と拡張性が大幅に向上します。本記事では、RubyとRailsにおける`yield`の概 [...]
2024年7月17日 13:15
【Rails】AASMを使用してオブジェクトの状態遷移を効率的に管理
# はじめに Railsアプリケーションにおいて、オブジェクトの状態管理は重要な課題の一つです。AASM (Acts As State Machine) gemは、複雑な状態遷移を効率的に管理します。本記事では、AASMの基本的な使い方を解説して [...]
2024年7月16日 18:00
【Rails】RSpec + Swagger + rswagでアプリケーションのAPIをテストおよびドキュメント化する方法
# はじめに Railsアプリケーションの開発において、APIのテストとドキュメント化は重要な要素です。 RSpecはテストフレームワークとして広く利用されており、SwaggerはAPIの設計とドキュメント化を支援します。これらを統合するr [...]
2024年7月16日 14:27
【Rails】mailcatcherを使用して開発環境でメール送信をテストする方法
# はじめに mailcatcherは、開発環境でのメール送信をキャプチャするためのツールです。ローカルで送信されたメールをブラウザ上で簡単に確認できるようにします。mailcatcherをRailsアプリケーションで使用する方法について説明しま [...]
2024年7月15日 16:37
【Rails】impressionistを使用してページビューやクリック数を追跡する方法
# はじめに impressionist Gemを使用してRailsアプリケーションでページビューやクリック数を追跡する方法について説明します。 # 実装方法 ## impressionist Gemのインストール まず、impre [...]
2024年7月15日 14:18