Action Dispatch `Response`

表示由控制器操作生成的 HTTP 响应。使用它来检索响应的当前状态或自定义响应。它可以表示实际的 HTTP 响应（即要发送回 Web 浏览器的响应）或 TestResponse（即从集成测试生成的响应）。

当前请求的 Response 对象在控制器上公开为 ActionController::Metal#response。 ActionController::Metal 还提供了一些额外的委托方法，这些方法委托给 Response 的属性，例如 ActionController::Metal#headers。

Integration 测试可能也希望更详细地检查响应。方法，例如 Integration::RequestHelpers#get 和 Integration::RequestHelpers#post 返回 TestResponse 的实例（继承自 Response）用于此目的。

例如，以下演示集成测试将控制器响应的主体打印到控制台

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

命名空间

类 ActionDispatch::Response::RackBody

方法

A

abort,
await_commit,
await_sent

B

body,
body=,
body_parts

C

charset,
charset=,
close,
code,
commit!,
committed?,
content_type,
content_type=,
cookies,
create

D

delete_header

E

each

G

get_header

H

has_header?

L

location,
location=

M

media_type,
merge_default_headers,
message

N

P

prepare!

R

redirect_url,
reset_body!,
response_code

S

send_file,
sending!,
sending?,
sending_file=,
sent!,
sent?,
set_header,
status=,
status_message

T

to_a

W

write

包含的模块

常量

CONTENT_TYPE	=	"Content-Type"

ContentTypeHeader	=	Struct.new :mime_type, :charset

Header	=	Headers
	即将弃用
Headers	=	::Rack::Headers

NO_CONTENT_CODES	=	[100, 101, 102, 103, 204, 205, 304]

NullContentTypeHeader	=	ContentTypeHeader.new nil, nil

SET_COOKIE	=	"Set-Cookie"

属性

[R]	header	响应的标题。 `header["Content-Type"] # => "text/plain" header["Content-Type"] = "application/json" header["Content-Type"] # => "application/json"` 也称为 `headers`。 `headers["Content-Type"] # => "text/plain" headers["Content-Type"] = "application/json" headers["Content-Type"] # => "application/json"` 也称为 `header` 以确保兼容性。
[R]	headers	响应的标题。 `header["Content-Type"] # => "text/plain" header["Content-Type"] = "application/json" header["Content-Type"] # => "application/json"` 也称为 `headers`。 `headers["Content-Type"] # => "text/plain" headers["Content-Type"] = "application/json" headers["Content-Type"] # => "application/json"` 也称为 `header` 以确保兼容性。
[RW]	request	响应正在响应的请求。
[R]	status	HTTP 状态代码。
[R]	stream	作为可流式对象的基础主体。

类公有方法

create(status = 200, headers = {}, body = [], default_headers: self.default_headers) 链接

来源：显示 | 在 GitHub 上

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

merge_default_headers(original, default) 链接

来源：显示 | 在 GitHub 上

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

new(status = 200, headers = nil, body = []) 链接

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/response.rb, line 171
def initialize(status = 200, headers = nil, body = [])
  super()

  @headers = Headers.new

  headers&.each do |key, value|
    @headers[key] = value
  end

  self.body, self.status = body, status

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

  prepare_cache_control!

  yield self if block_given?
end

实例公有方法

abort() 链接

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/response.rb, line 396
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() 链接

来源：显示 | 在 GitHub 上

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

await_sent() 链接

来源：显示 | 在 GitHub 上

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

body() 链接

将响应的内容作为字符串返回。这包含对 render 的任何调用的内容。

来源：显示 | 在 GitHub 上

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

body=(body) 链接

允许您手动设置或覆盖响应主体。

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/response.rb, line 339
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() 链接

来源：显示 | 在 GitHub 上

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

charset() 链接

响应的字符集。HTML 需要知道你提供的內容的编码，因此我们需要将它一起发送。

来源：显示 | 在 GitHub 上

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

charset=(charset) 链接

设置 HTTP 字符集。如果参数为 nil，则将字符集设置为 default_charset。

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

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/response.rb, line 289
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

close() 链接

来源：显示 | 在 GitHub 上

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

code() 链接

返回一个字符串以确保与 Net::HTTPResponse 兼容。

来源：显示 | 在 GitHub 上

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

commit!() 链接

来源：显示 | 在 GitHub 上

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

committed?() 链接

来源：显示 | 在 GitHub 上

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

content_type() 链接

响应的内容类型。

来源：显示 | 在 GitHub 上

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

content_type=(content_type) 链接

设置 HTTP 响应的內容 MIME 类型。例如，在控制器中，你可以这样写

response.content_type = "text/plain"

如果已为此响应定义了字符集（请参阅 charset=），则字符集信息也将包含在内容类型信息中。

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/response.rb, line 259
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

cookies() 链接

返回响应 cookie，转换为 Hash 中的 (name => value) 对

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

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/response.rb, line 419
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

delete_header(key) 链接

来源：显示 | 在 GitHub 上

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

each(&block) 链接

来源：显示 | 在 GitHub 上

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

get_header(key) 链接

来源：显示 | 在 GitHub 上

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

has_header?(key) 链接

来源：显示 | 在 GitHub 上

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

location 链接

响应的地址。

也别名为：redirect_url

来源：在 GitHub 上

# File actionpack/lib/action_dispatch/http/response.rb, line 235

location=(location) 链接

设置响应的地址

来源：在 GitHub 上

# File actionpack/lib/action_dispatch/http/response.rb, line 240

media_type() 链接

响应的媒体类型。

来源：显示 | 在 GitHub 上

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

message() 链接

返回当前 HTTP 状态码对应的消息

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

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

也别名为：status_message

来源：显示 | 在 GitHub 上

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

prepare!() 链接

别名为：to_a

redirect_url 链接

我们将要响应的 Location 标头。

别名为：location

reset_body!() 链接

来源：显示 | 在 GitHub 上

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

response_code() 链接

请求的响应码。

来源：显示 | 在 GitHub 上

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

send_file(path) 链接

将存储在 path 中的文件作为响应主体发送。

来源：显示 | 在 GitHub 上

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

sending!() 链接

来源：显示 | 在 GitHub 上

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

sending?() 链接

来源：显示 | 在 GitHub 上

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

sending_file=(v) 链接

来源：显示 | 在 GitHub 上

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

sent!() 链接

来源：显示 | 在 GitHub 上

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

sent?() 链接

来源：显示 | 在 GitHub 上

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

set_header(key, v) 链接

来源：显示 | 在 GitHub 上

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

status=(status) 链接

设置 HTTP 状态码。

来源：显示 | 在 GitHub 上

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

status_message() 链接

别名为：message

to_a() 链接

将 Response 转换为一个与 Rack 兼容的数组，包括状态、标头和主体。允许显式展开

status, headers, body = *response

也别名为：prepare!

来源：显示 | 在 GitHub 上

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

write(string) 链接

来源：显示 | 在 GitHub 上

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

类 ActionDispatch::Response < Object

Action Dispatch Response

常量

属性

类公有方法

create(status = 200, headers = {}, body = [], default_headers: self.default_headers) 链接

merge_default_headers(original, default) 链接

new(status = 200, headers = nil, body = []) 链接

实例公有方法

abort() 链接

await_commit() 链接

await_sent() 链接

body() 链接

body=(body) 链接

body_parts() 链接

charset() 链接

charset=(charset) 链接

close() 链接

code() 链接

commit!() 链接

committed?() 链接

content_type() 链接

content_type=(content_type) 链接

cookies() 链接

delete_header(key) 链接

each(&block) 链接

get_header(key) 链接

has_header?(key) 链接

location 链接

location=(location) 链接

media_type() 链接

message() 链接

prepare!() 链接

redirect_url 链接

reset_body!() 链接

response_code() 链接

send_file(path) 链接

sending!() 链接

sending?() 链接

sending_file=(v) 链接

sent!() 链接

sent?() 链接

set_header(key, v) 链接

status=(status) 链接

status_message() 链接

to_a() 链接

write(string) 链接

Action Dispatch `Response`