58

目前正在生产中,我收到以下文本:

500 Internal Server Error
If you are the administrator of this website, then please read this web application's
log file and/or the web server's log file to find out what went wrong.

该页面上没有任何 HTML。此代码位于何处?我没有public/500.html文件。

在我的路线中,我有:

  get "/404", :to => "errors#error_404"
  get "/422", :to => "errors#error_404"
  get "/500", :to => "errors#error_500"
  get "/505", :to => "errors#error_505"

错误控制器:

class ErrorsController < ApplicationController

  def sub_layout
    "left"
  end

  def error_404
    render :status => 404, :formats => [:html], :layout => "white", :sub_layout => "left"
  end

  def error_422
    render :status => 422, :formats => [:html], :layout => "white", :sub_layout => "left"
  end

  def error_500
    render :status => 500, :formats => [:html], :layout => "white", :sub_layout => "left"
  end

  def error_505
    render :status => 505, :formats => [:html], :layout => "white", :sub_layout => "left"
  end

end

如何让它始终加载我的自定义错误?在某些错误上,它只会抛出来自 Ruby on Rails 核心某处的那两行文本。我希望它每次都能获取我自定义样式的错误页面!

4

3 回答 3

64

我们的exception_handlergem 可用于 Ruby on Rails 自定义错误页面。

这个怎么运作

所有 Ruby on Rails 异常都使用config.exceptions_app. 这是在config/application.rborconfig/environments/*.rb文件中分配的 - 它需要是一个回调:

config.exceptions_app 设置异常发生时 ShowException 中间件调用的异常应用程序。默认为 ActionDispatch::PublicExceptions.new(Rails.public_path)。

每当 Ruby on Rails 遇到错误时,它都会调用ShowExceptions中间件。这会调用exception_app并将整个request(包括exception)发送到exceptions_app

中间件驱动的异常

exceptions_app需要做出回应。如果没有,failsafe则加载:

  # show_exceptions.rb#L38
  def render_exception(env, exception)
    wrapper = ExceptionWrapper.new(env, exception)
    status  = wrapper.status_code
    env["action_dispatch.exception"] = wrapper.exception
    env["PATH_INFO"] = "/#{status}"
    response = @exceptions_app.call(request.env) # => exceptions_app callback
    response[1]["X-Cascade"] == "pass" ? pass_response(status) : response
  rescue Exception => failsafe_error # => raised if exceptions_app false
    $stderr.puts "Error during failsafe response: #{failsafe_error}\n  #{failsafe_error.backtrace * "\n  "}"
    FAILSAFE_RESPONSE
  end

failsafe存储在的FAILSAFE_RESPONSE顶部ShowExceptions


自定义错误页面

如果要创建自定义错误页面,则需要将自己的回调注入config.exceptions_app. 这可以在应用程序中完成,也可以使用 gem 完成:

代码截图

注意该call方法是如何使用的——这就是回调的工作方式。env当收到来自 Internet 的请求时,将调用Ruby on Rails ( );当引发异常时,env传递给exceptions_app.

异常处理的质量将取决于您的管理方式env。这个很重要; 引用self.routes不会使环境向前发展。

最好的方法是使用单独的控制器处理异常。这使您可以像处理另一个视图一样处理请求,授予对layout和其他组件 ( model/ email) 的访问权限。


两种处理异常的方法:

  1. 覆盖404/500路线
  2. 调用控制器

我们的 gem 是围绕我们的controller- 每次exception引发 an 时调用的。这可以完全控制异常过程,允许100% 品牌化布局。它在 Ruby on Rails 5 上 100% 运行。


管理 Ruby on Rails 的异常

如果您对 gem 不感兴趣,让我解释一下过程:

所有 Ruby on Rails 异常都由config.exceptions_app回调处理。这是在config/application.rborconfig/environments/*.rb文件中分配的 - 它需要是一个回调:

config.exceptions_app 设置异常发生时 ShowException 中间件调用的异常应用程序。默认为 ActionDispatch::PublicExceptions.new(Rails.public_path)。

每当您的应用程序引发异常时,ShowExceptions都会调用中间件。该中间件将异常构建到 中request并将其转发给config.exceptions_app回调。

默认情况下,config.exceptions_app指向路由。这就是 Rails 自带404.html,500.html和文件夹422.html的原因public

如果要创建自定义异常页面,则需要覆盖config.exceptions_app回调 - 将错误请求传递给适当的处理程序,无论是 acontroller还是route

[中间件]

有效管理此问题的两种方法是将错误请求发送到路由,或调用控制器。

最简单且最常见的方式是将请求转发到路由;不幸的是,这会忽略请求并阻止您正确详细说明异常。

最好的方法是调用一个单独的控制器。这将允许您传递整个请求,允许您保存、发送电子邮件或执行许多其他操作。


400 / 500 错误

Rails只能响应 HTTP 有效的错误

虽然应用程序的异常可能不同,但返回的状态码应该40x50x。这符合 HTTP 规范并在此处进行了概述。

这意味着无论您使用/构建何种异常处理解决方案,Ruby on Rails都需要向浏览器返回其中一个40x50x错误。

换句话说,自定义错误页面与异常类型几乎没有关系——更多的是您如何捕获和提供浏览器响应

默认情况下,Ruby on Rails 使用404.html,422.html500.html文件public夹中的文件执行此操作。如果您想自己处理异常流,则需要删除这些文件并将错误请求引导至您自己的exceptions_app回调。

这可以用routesor来完成controller(我现在将解释):


1. 路线

最简单的方法是让路由处理它。

这种方法很臃肿,需要使用多个操作。管理响应也很困难。

这显示了如何exceptions_app直接用路由替换:

# config/application.rb
config.exceptions_app = self.routes

这是我的代码(Ruby 2.0.0 和 Ruby on Rails 4.0):

应用程序配置

#config/application.rb
config.exceptions_app = self.routes

路线

#config/routes.rb
if Rails.env.production?
   get '404', to: 'application#page_not_found'
   get '422', to: 'application#server_error'
   get '500', to: 'application#server_error'
end

应用控制器

#controllers/application_controller.rb
def page_not_found
    respond_to do |format|
      format.html { render template: 'errors/not_found_error', layout: 'layouts/application', status: 404 }
      format.all  { render nothing: true, status: 404 }
    end
  end

  def server_error
    respond_to do |format|
      format.html { render template: 'errors/internal_server_error', layout: 'layouts/error', status: 500 }
      format.all  { render nothing: true, status: 500}
    end
  end

错误布局(完全静态——仅用于服务器错误)

#views/layouts/error.html.erb
<!DOCTYPE html>
<html>
<head>
  <title><%= action_name.titleize %> :: <%= site_name %></title>
  <%= csrf_meta_tags %>
  <style>
    body {
        background: #fff;
        font-family: Helvetica, Arial, Sans-Serif;
        font-size: 14px;
    }
    .error_container {
        display: block;
        margin: auto;
        margin: 10% auto 0 auto;
        width: 40%;
    }
    .error_container .error {
        display: block;
        text-align: center;
    }
    .error_container .error img {
        display: block;
        margin: 0 auto 25px auto;
    }
    .error_container .message strong {
        font-weight: bold;
        color: #f00;
    }
  </style>
</head>
<body>

    <div class="error_container">
        <%= yield %>
    </div>

</body>
</html>

错误视图

#views/errors/not_found_error.html.erb
<div class="error">
    <h2>Sorry, this page has moved, or doesn't exist!</h2>
</div>


#views/errors/internal_server_error.html.erb
<div class="error">
    <div class="message">
        <strong>Error!</strong>
        We're sorry, but our server is experiencing problems :(
    </div>
</div>

虽然许多人更喜欢“路线”方法,因为它简单,但它既不高效也不模块化。事实上,如果您的应用程序有任何面向对象的外观,您很快就会将其视为 hack。

一个响亮的方法是使用自定义控制器来捕获纯异常。这样,您可以根据应用程序的整体结构构建流程:


2.控制器

另一种选择是将所有请求路由到控制器。

这是无限强大的,因为它允许您接受请求(异常)并将其传递给视图,同时在后端进行管理。这将允许将其保存到数据库中。

这个要点显示了如何。

这意味着我们可以挂钩到中间件并将整个请求传递给控制器​​。

如果此控制器由模型和视图支持,我们可以将其提取到 gem 中(这就是我们所做的)。如果您想手动操作,方法如下:


配置

这种方法的美妙之处在于它直接挂钩到config.exceptions_app. 这意味着任何异常都可以本地处理,从而提高效率。为确保这有效,您需要将以下代码放入config/application.rbexceptions_app仅适用于production-development显示错误):

#config/application.rb
config.exceptions_app = ->(env) { ExceptionController.action(:show).call(env) }

要进行测试,您可以将“本地”请求设置为 false:

#config/environments/development.rb
config.consider_all_requests_local  = false # true

控制器

下一步是添加exception控制器。虽然这可以在 中处理application_controller,但最好提取到它自己的中。注意来自application.rb--的调用ExceptionController.action(:show)

#app/controllers/exception_controller.rb
class ExceptionController < ApplicationController

  #Response
  respond_to :html, :xml, :json

  #Dependencies
  before_action :status

  #Layout
  layout :layout_status

  ####################
  #      Action      #
  ####################

  #Show
  def show
    respond_with status: @status
  end

  ####################
  #   Dependencies   #
  ####################

  protected

  #Info
  def status
    @exception  = env['action_dispatch.exception']
    @status     = ActionDispatch::ExceptionWrapper.new(env, @exception).status_code
    @response   = ActionDispatch::ExceptionWrapper.rescue_responses[@exception.class.name]
  end

  #Format
  def details
    @details ||= {}.tap do |h|
      I18n.with_options scope: [:exception, :show, @response], exception_name: @exception.class.name, exception_message: @exception.message do |i18n|
        h[:name]    = i18n.t "#{@exception.class.name.underscore}.title", default: i18n.t(:title, default: @exception.class.name)
        h[:message] = i18n.t "#{@exception.class.name.underscore}.description", default: i18n.t(:description, default: @exception.message)
      end
    end
  end
  helper_method :details

  ####################
  #      Layout      #
  ####################

  private

  #Layout
  def layout_status
    @status.to_s == "404" ? "application" : "error"
  end

end

意见

有两个视图要添加以使其正常工作。

第一个是exception/show视图,第二个是layouts/error. 第一个是给出exception_contoller#show一个视图,第二个是500内部服务器错误。

#app/views/exception/show.html.erb
<h1><%= details[:name]    %></h1>
<p><%=  details[:message] %></p>


#app/views/layouts/error.html.erb (for 500 internal server errors)
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <title>Error</title>
    <style>
      html {
        height: 100%;
        background: #fff;
      }
      body {
        font-family: Helvetica, Arial, Sans-Serif;
        font-size: 14px;
      }
      .error_container {
        display: block;
        margin: auto;
        margin: 10% auto 0 auto;
        width: 40%;
      }
      .error_container .error {
        display: block;
        text-align: center;
      }
      .error_container .error img {
        display: block;
        margin: 0 auto 15px auto;
      }
      .error_container .message > * {
        display: block;
      }
      .error_container .message strong {
        font-weight: bold;
        color: #f00;
      }
    </style>
  </head>
  <body>
    <div class="error_container"><%= yield %></div>
  </body>
</html>

结论

异常错误代码无关紧要。

当 Ruby on Rails 引发异常时,它会分配上述 HTTP 响应代码之一。这些允许您的浏览器确定请求是否成功。

处理异常时,您需要确保能够处理40*错误(通常使用与应用程序其余部分相同的布局)和50*错误(需要自己的布局)。

在这两种情况下,您最好使用单独的exception控制器,这将允许您将其exception作为对象进行管理。

于 2013-10-09T17:43:55.047 回答
49

您遇到的错误是从

https://github.com/rails/rails/blob/4-0-stable/actionpack/lib/action_dispatch/middleware/show_exceptions.rb#L18-L22

这意味着你的异常被拯救的代码本身就是抛出异常。您可以检查日志中的文本:

Error during failsafe response:

确定异常的真正来源,从而解决您的问题。

于 2013-10-13T14:10:20.783 回答
18

应用程序中的错误页面应该尽可能简单。同样的建议涉及他们的渲染。如果您的应用程序返回 500 HTTP 响应代码,则意味着事情已经出错了。并且您可能无法呈现错误页面并将其显示给用户。

理想情况下,错误页面应该是由 Web 服务器直接提供的纯 HTML 页面,而不需要访问应用程序服务器。

说到 Ruby on Rails 实现这个想法。它基于使用资产管道预编译 HTML 静态页面。

首先添加一个新的资产类型(Ruby on Rails > 4.1):

# config/initializers/assets.rb

Rails.application.config.assets.precompile += %w(404.html 500.html)
Rails.application.config.assets.paths << Rails.root.join('app/assets/html')
Rails.application.config.assets.register_mime_type('text/html', '.html')

如果使用模板引擎(例如 Slim 和Haml),请通过初始化程序注册它:

# For Slim
Rails.application.assets.register_engine('.slim', Slim::Template)
# For Haml
Rails.application.assets.register_engine('.haml', Tilt::HamlTemplate)

现在您准备好使用您最喜欢的模板引擎和 Ruby on Rails 的内置视图助手在 app/assets/html 目录中创建漂亮的错误页面。

生产技巧

在生产资产管道上,将摘要添加到已编译资产并将文件存储在默认文件夹下(通常是生产服务器上的共享/公共/资产)。您可以使用 capistrano 将错误页面复制到 Web 服务器根目录:

# config/deploy.rb
# Capistrano 3 only

namespace :deploy do
  desc 'Copy compiled error pages to public'
  task :copy_error_pages do
    on roles(:all) do
      %w(404 500).each do |page|
        page_glob = "#{current_path}/public/#{fetch(:assets_prefix)}/#{page}*.html"
        # copy newest asset
        asset_file = capture :ruby, %Q{-e "print Dir.glob('#{page_glob}').max_by { |file| File.mtime(file) }"}
        if asset_file
          execute :cp, "#{asset_file} #{current_path}/public/#{page}.html"
        else
          error "Error #{page} asset does not exist"
        end
      end
    end
  end
  after :finishing, :copy_error_pages
end

最后一件事。告诉 Web 服务器将这些文件用于某些 HTTP 错误代码(示例 nginx 配置):

error_page 500 502 503 504 /500.html;
error_page 404 /404.html;

链轮 3 更新

对于 Sprocket 3,您需要这样的东西(使用 Ruby on Rails 5 测试):

# config/environments/production.rb
config.assets.configure do |env|
  env.register_transformer 'text/slim', 'text/html', Slim::Template
  env.register_mime_type 'text/slim', extensions: ['.html']
  env.register_engine '.slim', Slim::Template
end

# config/initializers/assets.rb
Rails.application.config.assets.precompile += %w(404.html 500.html)
Rails.application.config.assets.paths << Rails.root.join('app/assets/html')
于 2014-08-14T08:40:30.333 回答