ActionDispatch::Request - Ruby on Rails 中文

ENV_METHODS	=	%w[ AUTH_TYPE GATEWAY_INTERFACE PATH_TRANSLATED REMOTE_HOST REMOTE_IDENT REMOTE_USER REMOTE_ADDR SERVER_NAME SERVER_PROTOCOL ORIGINAL_SCRIPT_NAME HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_FROM HTTP_NEGOTIATE HTTP_PRAGMA HTTP_CLIENT_IP HTTP_X_FORWARDED_FOR HTTP_ORIGIN HTTP_VERSION HTTP_X_CSRF_TOKEN HTTP_X_REQUEST_ID HTTP_X_FORWARDED_HOST ].freeze

HTTP_METHODS	=	RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC4791 + RFC5789

HTTP_METHOD_LOOKUP	=	{}

LOCALHOST	=	Regexp.union [/^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, /^::1$/, /^0:0:0:0:0:0:0:1(%.*)?$/]

RFC2518	=	%w(PROPFIND PROPPATCH MKCOL COPY MOVE LOCK UNLOCK)
	来自 RFC 2518: HTTP Extensions for Distributed Authoring – WEBDAV 的 HTTP 方法
RFC2616	=	%w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT)
	来自 RFC 2616: Hypertext Transfer Protocol – HTTP/1.1 的 HTTP 方法
RFC3253	=	%w(VERSION-CONTROL REPORT CHECKOUT CHECKIN UNCHECKOUT MKWORKSPACE UPDATE LABEL MERGE BASELINE-CONTROL MKACTIVITY)
	来自 RFC 3253: Versioning Extensions to WebDAV 的 HTTP 方法
RFC3648	=	%w(ORDERPATCH)
	来自 RFC 3648: WebDAV Ordered Collections Protocol 的 HTTP 方法
RFC3744	=	%w(ACL)
	来自 RFC 3744: WebDAV Access Control Protocol 的 HTTP 方法
RFC4791	=	%w(MKCALENDAR)
	来自 RFC 4791: Calendaring Extensions to WebDAV 的 HTTP 方法
RFC5323	=	%w(SEARCH)
	来自 RFC 5323: WebDAV SEARCH 的 HTTP 方法
RFC5789	=	%w(PATCH)
	来自 RFC 5789: PATCH Method for HTTP 的 HTTP 方法

Attributes

[R]

rack_request

类公共方法

empty() 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 59
def self.empty
  new({})
end

new(env) 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 63
def initialize(env)
  super

  @rack_request = Rack::Request.new(env)

  @method            = nil
  @request_method    = nil
  @remote_ip         = nil
  @original_fullpath = nil
  @fullpath          = nil
  @ip                = nil
end

实例公共方法

GET() 链接

重写 Rack 的 GET 方法以支持不区分大小写的访问。

也别名为：query_parameters

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 400
def GET
  fetch_header("action_dispatch.request.query_parameters") do |k|
    encoding_template = Request::Utils::CustomParamEncoder.action_encoding_template(self, path_parameters[:controller], path_parameters[:action])
    rack_query_params = ActionDispatch::ParamBuilder.from_query_string(rack_request.query_string, encoding_template: encoding_template)

    set_header k, rack_query_params
  end
rescue ActionDispatch::ParamError => e
  raise ActionController::BadRequest.new("Invalid query parameters: #{e.message}")
end

POST() 链接

重写 Rack 的 POST 方法以支持不区分大小写的访问。

也别名为：request_parameters

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 413
def POST
  fetch_header("action_dispatch.request.request_parameters") do
    encoding_template = Request::Utils::CustomParamEncoder.action_encoding_template(self, path_parameters[:controller], path_parameters[:action])

    param_list = nil
    pr = parse_formatted_parameters(params_parsers) do
      if param_list = request_parameters_list
        ActionDispatch::ParamBuilder.from_pairs(param_list, encoding_template: encoding_template)
      else
        # We're not using a version of Rack that provides raw form
        # pairs; we must use its hash (and thus post-process it below).
        fallback_request_parameters
      end
    end

    # If the request body was parsed by a custom parser like JSON
    # (and thus the above block was not run), we need to
    # post-process the result hash.
    if param_list.nil?
      pr = ActionDispatch::ParamBuilder.from_hash(pr, encoding_template: encoding_template)
    end

    self.request_parameters = pr
  end
rescue ActionDispatch::ParamError, EOFError => e
  raise ActionController::BadRequest.new("Invalid request parameters: #{e.message}")
end

authorization() 链接

返回授权头，无论它是直接指定还是通过代理替代项之一指定的。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 465
def authorization
  get_header("HTTP_AUTHORIZATION")   ||
  get_header("X-HTTP_AUTHORIZATION") ||
  get_header("X_HTTP_AUTHORIZATION") ||
  get_header("REDIRECT_X_HTTP_AUTHORIZATION")
end

body() 链接

请求体是一个 IO 输入流。如果 RAW_POST_DATA 环境变量已设置，则将其包装在 StringIO 中。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 362
def body
  if raw_post = get_header("RAW_POST_DATA")
    raw_post = (+raw_post).force_encoding(Encoding::BINARY)
    StringIO.new(raw_post)
  else
    body_stream
  end
end

commit_csrf_token() 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 497
def commit_csrf_token
  controller_instance.commit_csrf_token(self) if controller_instance.respond_to?(:commit_csrf_token)
end

commit_flash() 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 486
def commit_flash
end

content_length() 链接

以整数形式返回请求的内容长度。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 297
def content_length
  return raw_post.bytesize if has_header?(TRANSFER_ENCODING)
  super.to_i
end

controller_class() 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 87
def controller_class
  params = path_parameters
  params[:action] ||= "index"
  controller_class_for(params[:controller])
end

controller_class_for(name) 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 93
def controller_class_for(name)
  if name
    controller_param = name.underscore
    const_name = controller_param.camelize << "Controller"
    begin
      const_name.constantize
    rescue NameError => error
      if error.missing_name == const_name || const_name.start_with?("#{error.missing_name}::")
        raise MissingController.new(error.message, error.name)
      else
        raise
      end
    end
  else
    PASS_NOT_FOUND
  end
end

form_data?() 链接

通过检查请求的 Content-Type 是否为以下任一媒体类型来确定请求体是否包含表单数据：application/x-www-form-urlencoded 或 multipart/form-data。表单数据媒体类型的列表可以通过 FORM_DATA_MEDIA_TYPES 数组进行修改。

当未提供 Content-Type 头且 request_method 为 POST 时，不假定请求体包含表单数据。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 378
def form_data?
  FORM_DATA_MEDIA_TYPES.include?(media_type)
end

fullpath() 链接

返回包含最后一个请求 URL（包括参数）的 String。

# get "/articles"
request.fullpath # => "/articles"

# get "/articles?page=2"
request.fullpath # => "/articles?page=2"

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 276
def fullpath
  @fullpath ||= super
end

headers() 链接

提供对请求的 HTTP 头的访问，例如

request.headers["Content-Type"] # => "text/plain"

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 237
def headers
  @headers ||= Http::Headers.new(self)
end

http_auth_salt() 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 203
def http_auth_salt
  get_header "action_dispatch.http_auth_salt"
end

ip() 链接

以 String 形式返回客户端的 IP 地址。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 311
def ip
  @ip ||= super
end

key?(key) 链接

如果请求具有与给定 key 参数匹配的头，则返回 true。

request.key? :ip_spoofing_check # => true

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 114
def key?(key)
  has_header? key
end

local?() 链接

如果请求来自 localhost、127.0.0.1 或 ::1，则为 true。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 473
def local?
  LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip)
end

logger() 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 482
def logger
  get_header("action_dispatch.logger")
end

media_type() 链接

请求的 String MIME 类型。

# get "/articles"
request.media_type # => "application/x-www-form-urlencoded"

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 292
def media_type
  content_mime_type&.to_s
end

method(*args) 链接

返回环境变量 REQUEST_METHOD 的原始值，即使它被中间件覆盖了。有关更多信息，请参阅 request_method。

出于调试目的，当带参数调用时，此方法将回退到 Object#method。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 217
def method(*args)
  if args.empty?
    @method ||= check_method(
      get_header("rack.methodoverride.original_method") ||
      get_header("REQUEST_METHOD")
    )
  else
    super
  end
end

method_symbol() 链接

以符号形式返回 method。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 230
def method_symbol
  HTTP_METHOD_LOOKUP[method]
end

original_fullpath() 链接

返回包含最后一个请求路径（包括其参数）的 String。

# get '/foo'
request.original_fullpath # => '/foo'

# get '/foo?bar'
request.original_fullpath # => '/foo?bar'

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 265
def original_fullpath
  @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath)
end

original_url() 链接

以 String 形式返回原始请求 URL。

# get "/articles?page=2"
request.original_url # => "http://www.example.com/articles?page=2"

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 284
def original_url
  base_url + original_fullpath
end

query_parameters() 链接

别名为：GET

raw_post() 链接

读取请求体。这对于需要直接处理原始请求的 Web 服务非常有用。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 353
def raw_post
  unless has_header? "RAW_POST_DATA"
    set_header("RAW_POST_DATA", read_body_stream)
  end
  get_header "RAW_POST_DATA"
end

remote_ip() 链接

以 String 形式返回客户端的 IP 地址，通常由 RemoteIp 中间件设置。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 317
def remote_ip
  @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s
end

remote_ip=(remote_ip) 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 321
def remote_ip=(remote_ip)
  @remote_ip = nil
  set_header "action_dispatch.remote_ip", remote_ip
end

request_id() 链接

返回唯一的请求 ID，该 ID 基于防火墙、负载均衡器或 Web 服务器生成的 X-Request-Id 头，或者由 RequestId 中间件生成（该中间件设置 action_dispatch.request_id 环境变量）。

这个唯一的 ID 有助于在日志记录或调试时进行端到端请求跟踪。这依赖于 ActionDispatch::RequestId 中间件设置的 Rack 变量。

也别名为：uuid

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 336
def request_id
  get_header ACTION_DISPATCH_REQUEST_ID
end

request_method() 链接

返回应用程序应该看到的 HTTP 方法。如果方法被中间件覆盖（例如，将 HEAD 请求转换为 GET，或使用 _method 参数确定应用程序应该使用的方法），此方法将返回覆盖后的值，而不是原始值。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 151
def request_method
  @request_method ||= check_method(super)
end

request_method_symbol() 链接

以符号形式返回 request_method。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 208
def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

request_parameters() 链接

别名为：POST

request_parameters=(params) 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 477
def request_parameters=(params)
  raise if params.nil?
  set_header("action_dispatch.request.request_parameters", params)
end

request_parameters_list() 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 442
def request_parameters_list
  # We don't use Rack's parse result, but we must call it so Rack
  # can populate the rack.request.* keys we need.
  rack_post = rack_request.POST

  if form_pairs = get_header("rack.request.form_pairs")
    # Multipart
    form_pairs
  elsif form_vars = get_header("rack.request.form_vars")
    # URL-encoded
    ActionDispatch::QueryParser.each_pair(form_vars)
  elsif rack_post && !rack_post.empty?
    # It was multipart, but Rack did not preserve a pair list
    # (probably too old). Flat parameter list is not available.
    nil
  else
    # No request body, or not a format Rack knows
    []
  end
end

reset_csrf_token() 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 493
def reset_csrf_token
  controller_instance.reset_csrf_token(self) if controller_instance.respond_to?(:reset_csrf_token)
end

reset_session() 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 386
def reset_session
  session.destroy
  reset_csrf_token
end

route_uri_pattern() 链接

返回请求匹配的路由的 URI 模式，格式与 bin/rails routes 相同。

request.route_uri_pattern # => "/:controller(/:action(/:id))(.:format)"

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 159
def route_uri_pattern
  unless pattern = get_header("action_dispatch.route_uri_pattern")
    route = get_header("action_dispatch.route")
    return if route.nil?
    pattern = route.path.spec.to_s
    set_header("action_dispatch.route_uri_pattern", pattern)
  end
  pattern
end

send_early_hints(links) 链接

Early Hints 是一个 HTTP/2 状态码，表示有助于客户端开始准备处理最终响应的提示。

如果 env 包含 rack.early_hints，则服务器接受 HTTP2 推送链接头。

send_early_hints 方法接受如下的链接哈希：

send_early_hints("link" => "</style.css>; rel=preload; as=style,</script.js>; rel=preload")

如果您使用 javascript_include_tag 或 stylesheet_link_tag，则默认包含 Early Hints 头（如果支持）。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 254
def send_early_hints(links)
  env["rack.early_hints"]&.call(links)
end

server_software() 链接

返回 HTTP 服务器软件的小写名称。

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 347
def server_software
  (get_header("SERVER_SOFTWARE") && /^([a-zA-Z]+)/ =~ get_header("SERVER_SOFTWARE")) ? $1.downcase : nil
end

session_options=(options) 链接

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 395
def session_options=(options)
  Session::Options.set self, options
end

uuid() 链接

别名为：request_id

xhr?() 链接

别名为：xml_http_request?

xml_http_request?() 链接

如果 X-Requested-With 头包含 “XMLHttpRequest”（不区分大小写），则返回 true。根据所选的 JavaScript 库和框架，可能需要手动添加。

也别名为：xhr?

Source: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 305
def xml_http_request?
  /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH"))
end

类 ActionDispatch::Request < Object

常量

Attributes

类公共方法

empty() 链接

new(env) 链接

实例公共方法

GET() 链接

POST() 链接

authorization() 链接

body() 链接

commit_csrf_token() 链接

commit_flash() 链接

content_length() 链接

controller_class() 链接

controller_class_for(name) 链接

form_data?() 链接

fullpath() 链接

headers() 链接

http_auth_salt() 链接

ip() 链接

key?(key) 链接

local?() 链接

logger() 链接

media_type() 链接

method(*args) 链接

method_symbol() 链接

original_fullpath() 链接

original_url() 链接

query_parameters() 链接

raw_post() 链接

remote_ip() 链接

remote_ip=(remote_ip) 链接

request_id() 链接

request_method() 链接

request_method_symbol() 链接

request_parameters() 链接

request_parameters=(params) 链接

request_parameters_list() 链接

reset_csrf_token() 链接

reset_session() 链接

route_uri_pattern() 链接

send_early_hints(links) 链接

server_software() 链接

session_options=(options) 链接

uuid() 链接

xhr?() 链接

xml_http_request?() 链接