Spec-Zone.ru › Ruby on Rails 6.1

класс ActionController::Base

Родитель:
Metal

Контроллеры Action — основа обработки веб-запросов в Rails. Они состоят из одного или нескольких действий, которые выполняются при запросе, а затем либо выводят шаблон, либо перенаправляют на другое действие. Действие определяется как публичный метод контроллера, который автоматически будет доступен веб-серверу через маршруты Rails.

По умолчанию только контроллер ApplicationController в приложении Rails наследуется от ActionController::Base. Все остальные контроллеры наследуются от ApplicationController. Это предоставляет вам один класс для настройки таких вещей, как защита от подделки запросов и фильтрация чувствительных параметров запроса.

Пример контроллера может выглядеть так:

class PostsController < ApplicationController
  def index
    @posts = Post.all
  end

  def create
    @post = Post.create params[:post]
    redirect_to posts_path
  end
end

Действия по умолчанию выводят шаблон в каталоге app/views , соответствующем имени контроллера и действия после выполнения кода в действии. Например, действие index контроллера PostsController выведет шаблон app/views/posts/index.html.erb по умолчанию после заполнения переменной экземпляра @posts.

В отличие от действия index, действие create не выводит шаблон. После выполнения своего основного назначения (создания новой записи), оно инициирует перенаправление. Это перенаправление выполняется путем возврата внешнего ответа HTTP 302 Moved , который переводит пользователя на действие index.

Эти два метода представляют два основных архетипа действий, используемых в контроллерах Action: получение и отображение и выполнение и перенаправление. Большинство действий являются вариациями этих тем.

Запросы

Для каждого запроса маршрутизатор определяет значение ключей controller и action. Они определяют, какой контроллер и какое действие вызываются. Остальные параметры запроса, сессия (если она доступна) и весь запрос со всеми HTTP-заголовками доступны для действия через методы доступа. Затем выполняется действие.

Полный объект запроса доступен через аксессор request и используется в основном для запроса HTTP-заголовков:

def server_ip
  location = request.env["REMOTE_ADDR"]
  render plain: "This server hosted at #{location}"
end

Parameters

Все параметры запроса, независимо от того, поступают ли они из строки запроса в URL или данных формы, отправленных через POST-запрос, доступны через метод params , который возвращает хеш. Например, действие, выполненное через /posts?category=All&limit=5 , будет включать { "category" => "All", "limit" => "5" } в params.

Также возможно создавать многомерные хеши параметров, указывая ключи с помощью квадратных скобок, например:

<input type="text" name="post[name]" value="david">
<input type="text" name="post[address]" value="hyacintvej">

Запрос, поступающий от формы, содержащей эти вводы, будет включать { "post" => { "name" => "david", "address" => "hyacintvej" } }. Если вход адреса был назван post[address][street], params бы содержало { "post" => { "address" => { "street" => "hyacintvej" } } }. Вложенность может быть любой глубины.

Сессии

Сессии позволяют сохранять объекты между запросами. Это полезно для объектов, которые еще не готовы к сохранению, таких как объект Signup, созданный в многостраничном процессе, или объекты, которые мало меняются и постоянно необходимы, такие как объект User для системы, требующей входа в систему. Однако сессии не следует использовать в качестве кэша для объектов, вероятность изменения которых без ведома пользователя высока. Обычно слишком сложно поддерживать все это синхронизированным — базы данных уже прекрасно справляются с этой задачей.

Вы можете поместить объекты в сессию, используя метод session, который обращается к хешу:

session[:person] = Person.authenticate(user_name, password)

Вы можете извлечь его снова через тот же хеш:

"Hello #{session[:person]}"

Для удаления объектов из сессии вы можете либо назначить единственный ключ nil:

# removes :person from session
session[:person] = nil

либо удалить всю сессию с помощью reset_session.

Сессии по умолчанию хранятся в cookie-файле браузера, который криптографически подписан, но не зашифрован. Это предотвращает вмешательство пользователя в сессию, но также позволяет ему просматривать ее содержимое.

Не храните секретные данные в сессиях на основе cookie-файлов!

Ответы

Каждое действие приводит к ответу, который содержит заголовки и документ, которые будут отправлены браузеру пользователя. Фактический объект ответа генерируется автоматически с помощью методов render и redirect и не требует вмешательства пользователя.

Вывод

Контроллер Action отправляет содержимое пользователю, используя один из пяти методов вывода. Наиболее универсальным и распространенным является вывод шаблона. В Action Pack включен Action View, который позволяет выводить ERB шаблоны. Он настраивается автоматически. Контроллер передает объекты в представление, присваивая переменные экземпляра:

def show
  @post = Post.find(params[:id])
end

которые затем автоматически доступны в представлении:

Title: <%= @post.title %>

Вам не нужно полагаться на автоматический вывод. Например, действия, которые могут привести к выводу различных шаблонов, будут использовать ручные методы вывода:

def search
  @results = Search.find(params[:query])
  case @results.count
    when 0 then render action: "no_results"
    when 1 then render action: "show"
    when 2..10 then render action: "show_many"
  end
end

Узнайте больше о написании ERB и шаблонов Builder в ActionView::Base.

Перенаправления

Перенаправления используются для перемещения из одного действия в другое. Например, после действия create , которое сохраняет запись в блог в базу данных, мы можем показать пользователю новую запись. Поскольку мы следуем принципам DRY (Don't Repeat Yourself), мы будем повторно использовать (и перенаправлять на) действие show , которое, предположительно, уже создано. Код может выглядеть так:

def create
  @entry = Entry.new(params[:entry])
  if @entry.save
    # The entry was saved correctly, redirect to show
    redirect_to action: 'show', id: @entry.id
  else
    # things didn't go so well, do something else
  end
end

В этом случае после сохранения новой записи в базе данных пользователь перенаправляется на метод show, который затем выполняется. Обратите внимание, что это внешнее перенаправление на уровне HTTP, которое заставит браузер сделать второй запрос (GET на действие show), а не какое-то внутреннее перенаправление, которое вызывает оба действия «create» и «show» в рамках одного запроса.

Узнайте больше о redirect_to и доступных опциях в ActionController::Redirecting.

Вызов нескольких перенаправлений или выводов

Действие может содержать только один вывод или одно перенаправление. Попытка сделать это снова приведет к ошибке DoubleRenderError:

def do_something
  redirect_to action: "elsewhere"
  render action: "overthere" # raises DoubleRenderError
end

Если вам нужно перенаправить при определенном условии, убедитесь, что добавили «and return», чтобы остановить выполнение.

def do_something
  redirect_to(action: "elsewhere") and return if monkeys.nil?
  render action: "overthere" # won't be called if monkeys is nil
end

Константы

MODULES
PROTECTED_IVARS

Определяет некоторые внутренние переменные, которые не должны передаваться в представление.

Публичные методы класса

without_modules(*modules) Показать исходный код
# File actionpack/lib/action_controller/base.rb, line 197
def self.without_modules(*modules)
  modules = modules.map do |m|
    m.is_a?(Symbol) ? ActionController.const_get(m) : m
  end

  MODULES - modules
end

Вспомогательная функция-короткая запись, которая возвращает все модули, включенные в ActionController::Base, за исключением переданных в качестве аргументов:

class MyBaseController < ActionController::Metal
  ActionController::Base.without_modules(:ParamsWrapper, :Streaming).each do |left|
    include left
  end
end

Это обеспечивает больший контроль над тем, что вы хотите исключить, и упрощает создание простого класса контроллера вместо ручного перечисления требуемых модулей.

Публичные методы экземпляра

request() Показать исходный код
# File actionpack/lib/action_controller/base.rb, line 174
    

Возвращает экземпляр ActionDispatch::Request, представляющий текущий запрос.

response() Показать исходный код
# File actionpack/lib/action_controller/base.rb, line 180
    

Возвращает ActionDispatch::Response, представляющий текущий ответ.

© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API