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 方法

类公共方法

empty() 链接

来源: 显示 | 在 GitHub 上

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

new(env) 链接

来源: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 60
def initialize(env)
  super
  @method            = nil
  @request_method    = nil
  @remote_ip         = nil
  @original_fullpath = nil
  @fullpath          = nil
  @ip                = nil
end

实例公共方法

GET() 链接

覆盖 Rack 的 GET 方法以支持无差异访问。

也称为: query_parameters

来源: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 388
def GET
  fetch_header("action_dispatch.request.query_parameters") do |k|
    rack_query_params = super || {}
    controller = path_parameters[:controller]
    action = path_parameters[:action]
    rack_query_params = Request::Utils.set_binary_encoding(self, rack_query_params, controller, action)
    # Check for non UTF-8 parameter values, which would cause errors later
    Request::Utils.check_param_encoding(rack_query_params)
    set_header k, Request::Utils.normalize_encode_params(rack_query_params)
  end
rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError, Rack::QueryParser::ParamsTooDeepError => e
  raise ActionController::BadRequest.new("Invalid query parameters: #{e.message}")
end

POST() 链接

覆盖 Rack 的 POST 方法以支持无差异访问。

也称为: request_parameters

来源: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 404
def POST
  fetch_header("action_dispatch.request.request_parameters") do
    pr = parse_formatted_parameters(params_parsers) do |params|
      super || {}
    end
    pr = Request::Utils.set_binary_encoding(self, pr, path_parameters[:controller], path_parameters[:action])
    Request::Utils.check_param_encoding(pr)
    self.request_parameters = Request::Utils.normalize_encode_params(pr)
  end
rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError, Rack::QueryParser::ParamsTooDeepError, EOFError => e
  raise ActionController::BadRequest.new("Invalid request parameters: #{e.message}")
end

authorization() 链接

无论授权头是直接指定还是通过代理替代方案之一指定，此方法都会返回授权头。

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 420
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 中。

来源：显示 | 在 GitHub 上

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

来源：显示 | 在 GitHub 上

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

commit_flash() 链接

来源：显示 | 在 GitHub 上

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

content_length() 链接

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

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 285
def content_length
  return raw_post.bytesize if headers.key?("Transfer-Encoding")
  super.to_i
end

controller_class() 链接

来源：显示 | 在 GitHub 上

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

controller_class_for(name) 链接

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 85
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 时，请求主体不被认为包含表单数据。

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 366
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"

来源：显示 | 在 GitHub 上

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

headers() 链接

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

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

来源：显示 | 在 GitHub 上

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

http_auth_salt() 链接

来源：显示 | 在 GitHub 上

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

ip() 链接

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

来源：显示 | 在 GitHub 上

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

key?(key) 链接

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

request.key? :ip_spoofing_check # => true

来源：显示 | 在 GitHub 上

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

local?() 链接

如果请求来自本地主机、127.0.0.1 或 ::1，则为 true。

来源：显示 | 在 GitHub 上

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

logger() 链接

来源: 显示 | 在 GitHub 上

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

media_type() 链接

请求的 String MIME 类型。

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

来源: 显示 | 在 GitHub 上

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

method(*args) 链接

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

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

来源: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 205
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 的符号形式。

来源: 显示 | 在 GitHub 上

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

original_fullpath() 链接

返回一个 String，其中包含最后一个请求的路径，包括它们的 params。

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

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

来源: 显示 | 在 GitHub 上

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

original_url() 链接

返回原始请求 URL 作为 String。

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

来源：显示 | 在 GitHub 上

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

query_parameters() 链接

别名：GET

raw_post() 链接

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

来源：显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 339
def raw_post
  unless has_header? "RAW_POST_DATA"
    set_header("RAW_POST_DATA", read_body_stream)
    body_stream.rewind if body_stream.respond_to?(:rewind)
  end
  get_header "RAW_POST_DATA"
end

raw_request_method() 链接

别名：request_method

remote_ip() 链接

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

来源：显示 | 在 GitHub 上

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

remote_ip=(remote_ip) 链接

来源：显示 | 在 GitHub 上

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

来源：显示 | 在 GitHub 上

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

request_method() 链接

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

也称为：raw_request_method

来源: 显示 | 在 GitHub 上

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

request_method_symbol() 链接

返回 request_method 的符号形式。

来源: 显示 | 在 GitHub 上

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

request_parameters() 链接

别名: POST

request_parameters=(params) 链接

来源: 显示 | 在 GitHub 上

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

reset_csrf_token() 链接

来源: 显示 | 在 GitHub 上

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

reset_session() 链接

来源: 显示 | 在 GitHub 上

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

route_uri_pattern() 链接

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

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

来源: 显示 | 在 GitHub 上

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

send_early_hints(links) 链接

Early Hints 是一个 HTTP/2 状态码，它指示提示以帮助客户端开始为处理最终响应做准备。

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

send_early_hints 方法接受一个链接哈希，如下所示

send_early_hints("Link" => "</style.css>; rel=preload; as=style\n</script.js>; rel=preload")

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

来源: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 240
def send_early_hints(links)
  return unless env["rack.early_hints"]

  env["rack.early_hints"].call(links)
end

server_software() 链接

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

来源: 显示 | 在 GitHub 上

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

session_options=(options) 链接

来源: 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 383
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?

来源: 显示 | 在 GitHub 上

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

类 ActionDispatch::Request < Object

常量

类公共方法

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() 链接

raw_request_method() 链接

remote_ip() 链接

remote_ip=(remote_ip) 链接

request_id() 链接

request_method() 链接

request_method_symbol() 链接

request_parameters() 链接

request_parameters=(params) 链接

reset_csrf_token() 链接

reset_session() 链接

route_uri_pattern() 链接

send_early_hints(links) 链接

server_software() 链接

session_options=(options) 链接

uuid() 链接

xhr?() 链接

xml_http_request?() 链接