класс ActionController::Metal
Контроллер Action Controller Metal
ActionController::Metal — это самый простой контроллер, предоставляющий валидный интерфейс Rack без дополнительных возможностей, предоставляемых ActionController::Base.
Пример контроллера типа metal может выглядеть так:
class HelloController < ActionController::Metal
def index
self.response_body = "Hello World!"
end
end
Затем, для маршрутизации запросов к вашему контроллеру metal, добавьте что-то подобное в config/routes.rb:
get 'hello', to: HelloController.action(:index)
Метод ::action возвращает валидное приложение Rack для маршрутизатора Rails для обработки.
Helpers
По умолчанию, 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
Перенаправление Helpers
Для добавления инструментов перенаправления в ваш контроллер metal выполните следующие действия:
class HelloController < ActionController::Metal
include ActionController::Redirecting
include Rails.application.routes.url_helpers
def index
redirect_to root_url
end
end
Другие Helpers
Вы можете обратиться к модулям, включённым в ActionController::Base, чтобы узнать о других возможностях, которые вы можете добавить в ваш контроллер metal.
Атрибуты
Экземпляр ActionDispatch::Request для текущего запроса.
Экземпляр ActionDispatch::Response для текущего ответа.
Публичные методы класса
# 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 Возвращает конечную точку Rack для данного имени действия.
# File actionpack/lib/action_controller/metal.rb, line 130
def self.controller_name
@controller_name ||= (name.demodulize.delete_suffix("Controller").underscore unless anonymous?)
end Возвращает последнюю часть имени контроллера, с нижним подчеркиванием, без окончания Controller. Например, PostsController возвращает posts. Имена пространств имён опускаются, поэтому Admin::PostsController также возвращает posts.
Возвращает
-
string
# 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 Прямая отправка в контроллер. Создаёт экземпляр контроллера, затем выполняет действие с именем name.
# 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 # File actionpack/lib/action_controller/metal.rb, line 310 def self.middleware middleware_stack end
Стек middleware, используемый этим контроллером.
По умолчанию использует вариацию ActionDispatch::MiddlewareStack, которая позволяет использовать следующий синтаксис:
class PostsController < ApplicationController use AuthenticationMiddleware, except: [:index, :show] end
Дополнительную информацию о стеке middleware в Rails см. в руководстве (guides.rubyonrails.org/rails_on_rack.html#action-dispatcher-middleware-stack).
# File actionpack/lib/action_controller/metal.rb, line 210 def initialize @_request = nil @_response = nil @_response_body = nil @_routes = nil @_params = nil super end
# File actionpack/lib/action_controller/metal.rb, line 293 def use(...) middleware_stack.use(...) end
Добавляет указанный middleware Rack и его аргументы в конец стека middleware.
Методы публичного экземпляра
# File actionpack/lib/action_controller/metal.rb, line 204 delegate :content_type, to: "@_response"
Перенаправляет вызов на ActionDispatch::Response#content_type
# File actionpack/lib/action_controller/metal.rb, line 192 delegate :content_type=, to: "@_response"
Перенаправляет вызов на ActionDispatch::Response#content_type=
# File actionpack/lib/action_controller/metal.rb, line 156 def controller_name self.class.controller_name end
Перенаправляет вызов на ::controller_name класса.
# File actionpack/lib/action_controller/metal.rb, line 180 delegate :headers, to: "@_response"
Перенаправляет вызов на ActionDispatch::Response#headers.
# File actionpack/lib/action_controller/metal.rb, line 200 delegate :location, to: "@_response"
Перенаправляет вызов на ActionDispatch::Response#location
# File actionpack/lib/action_controller/metal.rb, line 188 delegate :location=, to: "@_response"
Перенаправляет вызов на ActionDispatch::Response#location=
# File actionpack/lib/action_controller/metal.rb, line 208 delegate :media_type, to: "@_response"
Перенаправляет вызов на ActionDispatch::Response#media_type
# File actionpack/lib/action_controller/metal.rb, line 219 def params @_params ||= request.parameters end
# File actionpack/lib/action_controller/metal.rb, line 223 def params=(val) @_params = val end
# File actionpack/lib/action_controller/metal.rb, line 245 def performed? response_body || response.committed? end
Проверяет, уже произошёл рендер или перенаправление.
# File actionpack/lib/action_controller/metal.rb, line 284 def reset_session @_request.reset_session end
# File actionpack/lib/action_controller/metal.rb, line 268 def response=(response) set_response!(response) # Force `performed?` to return true: @_response_body = true end
Присваивает ответ и отмечает его как подтверждённый. Дальнейшая обработка не будет производиться.
# 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 # File actionpack/lib/action_controller/metal.rb, line 176 delegate :session, to: "@_request"
Экземпляр ActionDispatch::Request::Session для текущего запроса. Дополнительные сведения см. в руководстве по сессиям Active Controller.
# File actionpack/lib/action_controller/metal.rb, line 196 delegate :status, to: "@_response"
Перенаправляет вызов на ActionDispatch::Response#status
# File actionpack/lib/action_controller/metal.rb, line 184 delegate :status=, to: "@_response"
Перенаправляет вызов на ActionDispatch::Response#status=
# File actionpack/lib/action_controller/metal.rb, line 230 def url_for(string) string end
Базовая url_for функция, которая может быть переопределена для более сложной функциональности.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.