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: 超文本傳輸協定 – HTTP/1.1 中的 HTTP 方法
RFC3253	=	%w(VERSION-CONTROL REPORT CHECKOUT CHECKIN UNCHECKOUT MKWORKSPACE UPDATE LABEL MERGE BASELINE-CONTROL MKACTIVITY)
	RFC 3253: WebDAV 的版本控制擴展中的 HTTP 方法
RFC3648	=	%w(ORDERPATCH)
	RFC 3648: WebDAV 有序集合協定中的 HTTP 方法
RFC3744	=	%w(ACL)
	RFC 3744: WebDAV 訪問控制協定中的 HTTP 方法
RFC4791	=	%w(MKCALENDAR)
	RFC 4791: WebDAV 的日曆擴展中的 HTTP 方法
RFC5323	=	%w(SEARCH)
	RFC 5323: WebDAV SEARCH 中的 HTTP 方法
RFC5789	=	%w(PATCH)
	RFC 5789: HTTP 的 PATCH 方法中的 HTTP 方法

屬性

[R]

rack_request

類別公開方法

empty() 連結

來源：顯示 | 在 GitHub 上

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

new(env) 連結

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 64
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 方法以支援 indifferent access（大小寫不敏感的訪問）。

也別名為：query_parameters

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 394
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 方法以支援 indifferent access（大小寫不敏感的訪問）。

也別名為：request_parameters

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 407
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() 連結

返回授權標頭，無論它是直接指定還是透過代理替代方案之一指定。

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 459
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 356
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 491
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 480
def commit_flash
end

content_length() 連結

以整數形式返回請求的內容長度

來源：顯示 | 在 GitHub 上

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

controller_class() 連結

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 88
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 94
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?() 連結

透過檢查請求的「內容類型」是否為以下媒體類型之一來判斷請求主體是否包含表單資料：`application/x-www-form-urlencoded` 或 `multipart/form-data`。可以透過 `FORM_DATA_MEDIA_TYPES` 陣列修改表單資料媒體類型列表。

當未提供「內容類型」標頭且 `request_method` 為 `POST` 時，不會假設請求主體包含表單資料。

來源：顯示 | 在 GitHub 上

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

fullpath() 連結

返回包含上次請求網址參數的 `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 270
def fullpath
  @fullpath ||= super
end

headers() 連結

提供對請求 HTTP 標頭的訪問，例如：

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

來源：顯示 | 在 GitHub 上

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

http_auth_salt() 連結

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 198
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 305
def ip
  @ip ||= super
end

key?(key) 連結

如果請求具有與給定鍵值參數匹配的標頭，則返回 true。

request.key? :ip_spoofing_check # => true

來源：顯示 | 在 GitHub 上

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

local?() 連結

如果請求來自本地主機、127.0.0.1 或 ::1，則為 true。

來源：顯示 | 在 GitHub 上

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

logger() 連結

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 476
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 286
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 212
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 225
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'

來源：顯示 | 在 GitHub 上

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

來源：顯示 | 在 GitHub 上

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

query_parameters() 連結

GET 的別名。

raw_post() 連結

讀取請求主體。這對於需要直接處理原始請求的 Web 服務很有用。

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 347
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 中介軟體設定。

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 311
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 315
def remote_ip=(remote_ip)
  @remote_ip = nil
  set_header "action_dispatch.remote_ip", remote_ip
end

request_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 330
def request_id
  get_header ACTION_DISPATCH_REQUEST_ID
end

request_method() 連結

傳回應用程式應該看到的 HTTP 方法。如果方法被中介軟體覆蓋（例如，如果 HEAD 請求被轉換為 GET，或者如果使用 _method 參數來決定應用程式應該使用的方法），則此方法傳回覆蓋的值，而不是原始值。

來源：顯示 | 在 GitHub 上

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

request_method_symbol() 連結

傳回 request_method 的符號形式。

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 203
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 471
def request_parameters=(params)
  raise if params.nil?
  set_header("action_dispatch.request.request_parameters", params)
end

request_parameters_list() 連結

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 436
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() 連結

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 487
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 380
def reset_session
  session.destroy
  reset_csrf_token
end

route_uri_pattern() 連結

使用與 bin/rails routes 相同的格式傳回請求的匹配路由的 URI 模式

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

來源：顯示 | 在 GitHub 上

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

send_early_hints(links) 連結

Early Hints 是一種 HTTP/2 狀態碼，表示提示以幫助客戶端開始準備處理最終響應。

如果環境變數包含 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 標頭。

來源：顯示 | 在 GitHub 上

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

server_software() 連結

傳回 HTTP 伺服器軟體的小寫名稱。

來源：顯示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/request.rb, line 341
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 389
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 299
def xml_http_request?
  /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH"))
end

類別 ActionDispatch::Request < 物件

常數

屬性

類別公開方法

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?() 連結