Контроллер Действий Base

Контроллеры Действий являются основой веб-запроса в 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.

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

Запросы

Для каждого запроса маршрутизатор определяет значение ключей 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 браузера (см. ActionDispatch::Session::CookieStore). Таким образом, пользователь не сможет прочитать или изменить данные сессии. Однако пользователь может сохранить копию cookie даже после истечения срока его действия, поэтому следует избегать хранения конфиденциальной информации в сессиях на основе cookie.

Ответы

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

Отображения

Контроллер Действий отправляет контент пользователю, используя один из пяти методов отображения. Наиболее универсальным и распространённым является отображение шаблона. 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 (не повторяйся), мы будем повторно использовать (и перенаправлять на) действие 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» в одном запросе.

Дополнительную информацию о перенаправлениях и имеющихся вариантах см. в ActionController::Redirecting.

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

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

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

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

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