класс ActionDispatch::Response

Родитель:: Объект
Включенные модули:: ActionDispatch::Http::FilterRedirect, ActionDispatch::Http::Cache::Response

Представляет HTTP-ответ, сгенерированный действием контроллера. Используйте его для получения текущего состояния ответа или для его настройки. Он может представлять как реальный HTTP-ответ (то есть тот, который должен быть отправлен обратно веб-браузеру), так и TestResponse (то есть тот, который генерируется из интеграционных тестов).

Ответ в основном является деталью реализации Ruby on Rails, и его никогда не следует использовать напрямую в контроллерах. Контроллеры должны использовать методы, определенные в ActionController::Base вместо этого. Например, если вы хотите установить тип MIME содержимого HTTP-ответа, используйте ActionControllerBase#headers вместо Response#headers.

Тем не менее, интеграционные тесты могут захотеть более подробно просмотреть ответы контроллеров, и именно тогда ответ может быть полезен для разработчиков приложений. Integration методы тестов, такие как ActionDispatch::Integration::Session#get и ActionDispatch::Integration::Session#post, возвращают объекты типа TestResponse (которые, конечно, также являются объектами типа Response).

Например, следующий демо-тест интеграции выводит тело ответа контроллера в консоль:

class DemoControllerTest < ActionDispatch::IntegrationTest
  def test_print_root_path_to_console
    get('/')
    puts response.body
  end
end

Константы

CONTENT_TYPE
ContentTypeHeader
LOCATION
NO_CONTENT_CODES
NullContentTypeHeader
SET_COOKIE

Атрибуты

header[R]

Получение заголовков для этого ответа.

headers[R]

Получение заголовков для этого ответа.

request[RW]

Запрос, на который отвечает ответ.

status[R]

Код HTTP-статуса.

stream[R]

Основное тело как потоковый объект.

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

create(status = 200, header = {}, body = [], default_headers: self.default_headers) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 162
def self.create(status = 200, header = {}, body = [], default_headers: self.default_headers)
  header = merge_default_headers(header, default_headers)
  new status, header, body
end

merge_default_headers(original, default) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 167
def self.merge_default_headers(original, default)
  default.respond_to?(:merge) ? default.merge(original) : original
end

new(status = 200, header = {}, body = []) { |self| ... } Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 174
def initialize(status = 200, header = {}, body = [])
  super()

  @header = Header.new(self, header)

  self.body, self.status = body, status

  @cv           = new_cond
  @committed    = false
  @sending      = false
  @sent         = false

  prepare_cache_control!

  yield self if block_given?
end

Вызов метода суперкласса

return_only_media_type_on_content_type() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 95
def self.return_only_media_type_on_content_type
  ActiveSupport::Deprecation.warn(
    ".return_only_media_type_on_content_type is dreprecated with no replacement and will be removed in 6.2."
  )
end

return_only_media_type_on_content_type=(*) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 89
def self.return_only_media_type_on_content_type=(*)
  ActiveSupport::Deprecation.warn(
    ".return_only_media_type_on_content_type= is dreprecated with no replacement and will be removed in 6.2."
  )
end

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

abort() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 383
def abort
  if stream.respond_to?(:abort)
    stream.abort
  elsif stream.respond_to?(:close)
    # `stream.close` should really be reserved for a close from the
    # other direction, but we must fall back to it for
    # compatibility.
    stream.close
  end
end

await_commit() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 196
def await_commit
  synchronize do
    @cv.wait_until { @committed }
  end
end

await_sent() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 202
def await_sent
  synchronize { @cv.wait_until { @sent } }
end

body() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 317
def body
  @stream.body
end

Возвращает содержимое ответа в виде строки. Это содержит содержимое любых вызовов render.

body=(body) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 326
def body=(body)
  if body.respond_to?(:to_path)
    @stream = body
  else
    synchronize do
      @stream = build_buffer self, munge_body_object(body)
    end
  end
end

Позволяет вручную задать или переопределить тело ответа.

body_parts() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 370
def body_parts
  parts = []
  @stream.each { |x| parts << x }
  parts
end

charset() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 287
def charset
  header_info = parsed_content_type_header
  header_info.charset || self.class.default_charset
end

Кодировка символов ответа. HTML хочет знать кодировку содержимого, которое вы им предоставляете, поэтому нам нужно отправить это вместе.

charset=(charset) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 276
def charset=(charset)
  content_type = parsed_content_type_header.mime_type
  if false == charset
    set_content_type content_type, nil
  else
    set_content_type content_type, charset || self.class.default_charset
  end
end

Устанавливает кодировку символов HTTP. В случае параметра nil, он устанавливает кодировку символов в default_charset.

response.charset = 'utf-16' # => 'utf-16'
response.charset = nil      # => 'utf-8'

close() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 379
def close
  stream.close if stream.respond_to?(:close)
end

code() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 298
def code
  @status.to_s
end

Возвращает строку для обеспечения совместимости с Net::HTTPResponse.

commit!() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 206
def commit!
  synchronize do
    before_committed
    @committed = true
    @cv.broadcast
  end
end

committed?() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 230
def committed?; synchronize { @committed }; end

content_type() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 256
def content_type
  super.presence
end

Тип содержимого ответа.

Вызывает метод суперкласса

content_type=(content_type) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 246
def content_type=(content_type)
  return unless content_type
  new_header_info = parse_content_type(content_type.to_s)
  prev_header_info = parsed_content_type_header
  charset = new_header_info.charset || prev_header_info.charset
  charset ||= self.class.default_charset unless prev_header_info.mime_type
  set_content_type new_header_info.mime_type, charset
end

Устанавливает тип MIME содержимого HTTP-ответа. Например, в контроллере вы можете написать это:

response.content_type = "text/plain"

Если для этого ответа определен набор символов (см. charset=), то информация о наборе символов также будет включена в информацию о типе содержимого.

cookies() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 407
def cookies
  cookies = {}
  if header = get_header(SET_COOKIE)
    header = header.split("\n") if header.respond_to?(:to_str)
    header.each do |cookie|
      if pair = cookie.split(";").first
        key, value = pair.split("=").map { |v| Rack::Utils.unescape(v) }
        cookies[key] = value
      end
    end
  end
  cookies
end

Возвращает файлы cookie ответа, преобразованные в Hash пар (имя => значение)

assert_equal 'AuthorOfNewPage', r.cookies['author']

delete_header(key) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 194
def delete_header(key); headers.delete key; end

each(&block) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 74
def each(&block)
  sending!
  x = @stream.each(&block)
  sent!
  x
end

get_header(key) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 192
def get_header(key);    headers[key];       end

has_header?(key) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 191
def has_header?(key);   headers.key? key;   end

media_type() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 261
def media_type
  parsed_content_type_header.mime_type
end

Тип носителя ответа.

message() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 310
def message
  Rack::Utils::HTTP_STATUS_CODES[@status]
end

Возвращает соответствующее сообщение для текущего кода состояния HTTP:

response.status = 200
response.message # => "OK"

response.status = 404
response.message # => "Not Found"

Также алиас: status_message

prepare!()

Псевдоним для: to_a

reset_body!() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 366
def reset_body!
  @stream = build_buffer(self, [])
end

response_code() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 293
def response_code
  @status
end

Код ответа запроса.

send_file(path) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 361
def send_file(path)
  commit!
  @stream = FileBody.new(path)
end

Отправить файл, хранящийся в path, в качестве тела ответа.

sending!() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 214
def sending!
  synchronize do
    before_sending
    @sending = true
    @cv.broadcast
  end
end

sending?() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 229
def sending?;   synchronize { @sending };   end

sending_file=(v) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 265
def sending_file=(v)
  if true == v
    self.charset = false
  end
end

sent!() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 222
def sent!
  synchronize do
    @sent = true
    @cv.broadcast
  end
end

END_OF_DOCUMENT_MARKER

sent?() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 231
def sent?;      synchronize { @sent };      end

set_header(key, v) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 193
def set_header(key, v); headers[key] = v;   end

status=(status) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 234
def status=(status)
  @status = Rack::Utils.status_code(status)
end

Устанавливает код состояния HTTP.

status_message()

Псевдоним для: message

to_a() Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 398
def to_a
  commit!
  rack_response @status, @header.to_hash
end

Преобразует Response в совместимый с Rack массив статуса, заголовков и тела. Разрешает явное использование splat:

status, headers, body = *response

Также алиасируется как: prepare!

write(string) Показать исходный код

# File actionpack/lib/action_dispatch/http/response.rb, line 321
def write(string)
  @stream.write string
end