跳到内容 跳到搜索

Action Controller Metal

ActionController::Metal 是最简单的控制器，它提供了有效的 Rack 接口，但没有 ActionController::Base 提供的其他便利功能。

一个金属控制器的示例可能如下所示

class HelloController < ActionController::Metal
  def index
    self.response_body = "Hello World!"
  end
end

然后，要将请求路由到您的金属控制器，您需要在 config/routes.rb 中添加类似以下内容

get 'hello', to: HelloController.action(:index)

该 ::action 方法返回一个有效的 Rack 应用程序，供 Rails 路由器调度。

渲染 助手

默认情况下，ActionController::Metal 不会提供任何用于渲染视图、部分或其他响应的实用程序，除了 response_body=、content_type= 和 status= 等一些低级设置器。要添加您习惯在普通控制器中使用的渲染助手，您可以执行以下操作

class HelloController < ActionController::Metal
  include AbstractController::Rendering
  include ActionView::Layouts
  append_view_path "#{Rails.root}/app/views"

  def index
    render "hello/index"
  end
end

重定向 助手

要将重定向助手添加到您的金属控制器，请执行以下操作

class HelloController < ActionController::Metal
  include ActionController::Redirecting
  include Rails.application.routes.url_helpers

  def index
    redirect_to root_url
  end
end

其他 助手

您可以参考 ActionController::Base 中包含的模块，查看可以添加到金属控制器的其他功能。

方法
A
C
D
H
L
M
N
P
R
S
U

属性

[R] request

当前请求的 ActionDispatch::Request 实例。
[R] response

当前响应的 ActionDispatch::Response 实例。

类公共方法

action(name)

返回给定操作名称的 Rack 端点。

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 315
def self.action(name)
  app = lambda { |env|
    req = ActionDispatch::Request.new(env)
    res = make_response! req
    new.dispatch(name, req, res)
  }

  if middleware_stack.any?
    middleware_stack.build(name, app)
  else
    app
  end
end

controller_name()

返回控制器名称的最后部分，带下划线，不包括结尾的 Controller。例如，PostsController 返回 posts。命名空间被省略，所以 Admin::PostsController 也返回 posts。

返回

  • 字符串

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 130
def self.controller_name
  @controller_name ||= (name.demodulize.delete_suffix("Controller").underscore unless anonymous?)
end

dispatch(name, req, res)

直接调度到控制器。实例化控制器，然后执行名为 name 的操作。

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 331
def self.dispatch(name, req, res)
  if middleware_stack.any?
    middleware_stack.build(name) { |env| new.dispatch(name, req, res) }.call req.env
  else
    new.dispatch(name, req, res)
  end
end

make_response!(request)

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 134
def self.make_response!(request)
  ActionDispatch::Response.new.tap do |res|
    res.request = request
  end
end

middleware()

该控制器使用的中间件堆栈。

默认情况下使用 ActionDispatch::MiddlewareStack 的变体，它允许以下语法

class PostsController < ApplicationController
  use AuthenticationMiddleware, except: [:index, :show]
end

在指南中阅读有关 [Rails 中间件堆栈] (guides.rubyonrails.org/rails_on_rack.html#action-dispatcher-middleware-stack) 的更多信息。

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 310
def self.middleware
  middleware_stack
end

new()

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 210
def initialize
  @_request = nil
  @_response = nil
  @_response_body = nil
  @_routes = nil
  @_params = nil
  super
end

use(...)

将给定的 Rack 中间件及其参数推送到中间件堆栈的底部。

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 293
def use(...)
  middleware_stack.use(...)
end

实例公共方法

content_type

委托给 ActionDispatch::Response#content_type

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 204
delegate :content_type, to: "@_response"

content_type=

委托给 ActionDispatch::Response#content_type=

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 192
delegate :content_type=, to: "@_response"

controller_name()

委托给类的 ::controller_name。

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 156
def controller_name
  self.class.controller_name
end

headers

委托给 ActionDispatch::Response#headers。

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 180
delegate :headers, to: "@_response"

location

委托给 ActionDispatch::Response#location

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 200
delegate :location, to: "@_response"

location=

委托给 ActionDispatch::Response#location=

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 188
delegate :location=, to: "@_response"

media_type

委托给 ActionDispatch::Response#media_type

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 208
delegate :media_type, to: "@_response"

params()

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 219
def params
  @_params ||= request.parameters
end

params=(val)

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 223
def params=(val)
  @_params = val
end

performed?()

测试渲染或重定向是否已经发生。

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 245
def performed?
  response_body || response.committed?
end

reset_session()

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 284
def reset_session
  @_request.reset_session
end

response=(response)

分配响应并将其标记为已提交。不会再进行任何处理。

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 268
def response=(response)
  set_response!(response)

  # Force `performed?` to return true:
  @_response_body = true
end

response_body=(body)

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 234
def response_body=(body)
  if body
    body = [body] if body.is_a?(String)
    response.body = body
    super
  else
    response.reset_body!
  end
end

session

当前请求的 ActionDispatch::Request::Session 实例。有关详细信息，请参阅 Active Controller Session 指南。

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 176
delegate :session, to: "@_request"

status

委托给 ActionDispatch::Response#status

源代码：显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 196
delegate :status, to: "@_response"

status=

委托给 ActionDispatch::Response#status=

来源: 显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 184
delegate :status=, to: "@_response"

url_for(string)

基本的 url_for，可以被重写以实现更强大的功能。

来源: 显示 | 在 GitHub 上

# File actionpack/lib/action_controller/metal.rb, line 230
def url_for(string)
  string
end