module Net::HTTPHeader

返回不区分大小写的字段 key 的字符串字段值，如果不存在该键则返回 nil；请参阅 Fields。

res = Net::HTTP.get_response(hostname, '/todos/1')
res['Connection'] # => "keep-alive"
res['Nosuch']     # => nil

请注意，某些字段值可以通过便捷方法检索；请参阅 Getters。

将不区分大小写的 key 的值设置为 val，如果字段存在则覆盖先前的值；请参阅 Fields。

req = Net::HTTP::Get.new(uri)
req['Accept'] # => "*/*"
req['Accept'] = 'text/html'
req['Accept'] # => "text/html"

请注意，某些字段值可以通过便捷方法设置；请参阅 Setters。

如果字段存在，则将值 val 添加到字段 key 的值数组中；如果字段不存在，则用给定的 key 和 val 创建该字段。请参阅 Fields。

req = Net::HTTP::Get.new(uri)
req.add_field('Foo', 'bar')
req['Foo']            # => "bar"
req.add_field('Foo', 'baz')
req['Foo']            # => "bar, baz"
req.add_field('Foo', %w[baz bam])
req['Foo']            # => "bar, baz, baz, bam"
req.get_fields('Foo') # => ["bar", "baz", "baz", "bam"]

使用给定的 account 和 password 字符串设置 'Authorization' 头。

req.basic_auth('my_account', 'my_password')
req['Authorization']
# => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="

如果字段 'Transfer-Encoding' 存在且值为 'chunked'，则返回 true，否则返回 false；请参阅 Transfer-Encoding response header。

res = Net::HTTP.get_response(hostname, '/todos/1')
res['Transfer-Encoding'] # => "chunked"
res.chunked?             # => true

返回 HTTP 会话是否应关闭。

返回 HTTP 会话是否应保持活动。

返回字段 'Content-Length' 的值作为整数，如果不存在该字段则返回 nil；请参阅 Content-Length request header。

res = Net::HTTP.get_response(hostname, '/nosuch/1')
res.content_length # => 2
res = Net::HTTP.get_response(hostname, '/todos/1')
res.content_length # => nil

将字段 'Content-Length' 的值设置为给定的数值；请参阅 Content-Length response header。

_uri = uri.dup
hostname = _uri.hostname           # => "jsonplaceholder.typicode.com"
_uri.path = '/posts'               # => "/posts"
req = Net::HTTP::Post.new(_uri)    # => #<Net::HTTP::Post POST>
req.body = '{"title": "foo","body": "bar","userId": 1}'
req.content_length = req.body.size # => 42
req.content_type = 'application/json'
res = Net::HTTP.start(hostname) do |http|
  http.request(req)
end # => #<Net::HTTPCreated 201 Created readbody=true>

返回一个表示字段 'Content-Range' 值的 Range 对象，如果不存在该字段则返回 nil；请参阅 Content-Range response header。

res = Net::HTTP.get_response(hostname, '/todos/1')
res['Content-Range'] # => nil
res['Content-Range'] = 'bytes 0-499/1000'
res['Content-Range'] # => "bytes 0-499/1000"
res.content_range    # => 0..499

从字段 'Content-Type' 的值中返回 媒体类型，如果不存在该字段则返回 nil；请参阅 Content-Type response header。

res = Net::HTTP.get_response(hostname, '/todos/1')
res['content-type'] # => "application/json; charset=utf-8"
res.content_type    # => "application/json"

删除给定不区分大小写的 key 的头（参见 Fields）；返回删除的值，如果不存在该字段则返回 nil。

req = Net::HTTP::Get.new(uri)
req.delete('Accept') # => ["*/*"]
req.delete('Nosuch') # => nil

类似于 each_header，但键以驼峰形式返回。

Net::HTTPHeader#canonical_each 是 Net::HTTPHeader#each_capitalized 的别名。

将每个驼峰命名的字段名传递给块。

res = Net::HTTP.get_response(hostname, '/todos/1')
res.each_capitalized_name do |key|
  p key if key.start_with?('C')
end

输出

"Content-Type"
"Connection"
"Cache-Control"
"Cf-Cache-Status"
"Cf-Ray"

驼峰命名取决于系统；请参阅 Case Mapping。

如果未提供块，则返回一个枚举器。

将每个键/值对传递给块。

res = Net::HTTP.get_response(hostname, '/todos/1')
res.each_header do |key, value|
  p [key, value] if key.start_with?('c')
end

输出

["content-type", "application/json; charset=utf-8"]
["connection", "keep-alive"]
["cache-control", "max-age=43200"]
["cf-cache-status", "HIT"]
["cf-ray", "771d17e9bc542cf5-ORD"]

如果未提供块，则返回一个枚举器。

Net::HTTPHeader#each 是 Net::HTTPHeader#each_header 的别名。

将每个字段键传递给块。

res = Net::HTTP.get_response(hostname, '/todos/1')
res.each_key do |key|
  p key if key.start_with?('c')
end

输出

"content-type"
"connection"
"cache-control"
"cf-cache-status"
"cf-ray"

如果未提供块，则返回一个枚举器。

Net::HTTPHeader#each_name 是 Net::HTTPHeader#each_key 的别名。

将每个字符串字段值传递给块。

res = Net::HTTP.get_response(hostname, '/todos/1')
res.each_value do |value|
  p value if value.start_with?('c')
end

输出

"chunked"
"cf-q-config;dur=6.0000002122251e-06"
"cloudflare"

如果未提供块，则返回一个枚举器。

使用块时，返回 key 的字符串值（如果存在）；否则返回块的值；忽略 default_val；请参阅 Fields。

res = Net::HTTP.get_response(hostname, '/todos/1')

# Field exists; block not called.
res.fetch('Connection') do |value|
  fail 'Cannot happen'
end # => "keep-alive"

# Field does not exist; block called.
res.fetch('Nosuch') do |value|
  value.downcase
end # => "nosuch"

不带块时，返回 key 的字符串值（如果存在）；否则，如果提供了 default_val，则返回 default_val；否则引发异常。

res.fetch('Connection', 'Foo') # => "keep-alive"
res.fetch('Nosuch', 'Foo')     # => "Foo"
res.fetch('Nosuch')            # Raises KeyError.

返回给定 key 的数组字段值，如果不存在该字段则返回 nil；请参阅 Fields。

res = Net::HTTP.get_response(hostname, '/todos/1')
res.get_fields('Connection') # => ["keep-alive"]
res.get_fields('Nosuch')     # => nil

如果存在不区分大小写的 key 的字段，则返回 true，否则返回 false。

req = Net::HTTP::Get.new(uri)
req.key?('Accept') # => true
req.key?('Nosuch') # => false

从字段 'Content-Type' 的值中返回 媒体类型的开头（“type”）部分，如果不存在该字段则返回 nil；请参阅 Content-Type response header。

res = Net::HTTP.get_response(hostname, '/todos/1')
res['content-type'] # => "application/json; charset=utf-8"
res.main_type       # => "application"

使用给定的 account 和 password 字符串设置 'Proxy-Authorization' 头。

req.proxy_basic_auth('my_account', 'my_password')
req['Proxy-Authorization']
# => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="

返回一个表示字段 'Range' 值的 Range 对象数组，如果不存在该字段则返回 nil；请参阅 Range request header。

req = Net::HTTP::Get.new(uri)
req['Range'] = 'bytes=0-99,200-299,400-499'
req.range # => [0..99, 200..299, 400..499]
req.delete('Range')
req.range # # => nil

返回表示字段 'Content-Range' 中给定范围的长度的整数，如果不存在该字段则返回 nil；请参阅 Content-Range response header。

res = Net::HTTP.get_response(hostname, '/todos/1')
res['Content-Range'] # => nil
res['Content-Range'] = 'bytes 0-499/1000'
res.range_length     # => 500

设置字段 'Content-Type' 的值；返回新值；请参阅 Content-Type request header。

req = Net::HTTP::Get.new(uri)
req.set_content_type('application/json') # => ["application/json"]

Net::HTTPHeader#content_type= 是 Net::HTTPHeader#set_content_type 的别名。

存储将用于 POST 或 PUT 请求的表单数据。

params 中给定的表单数据由零个或多个字段组成；每个字段是

• 一个标量值。

• 一个名称/值对。

• 一个用于读取的 IO 流。

参数 params 应为一个 Enumerable（将调用 params.map 方法），通常是数组或哈希。

首先，我们设置一个请求

_uri = uri.dup
_uri.path ='/posts'
req = Net::HTTP::Post.new(_uri)

参数 params 作为数组

当 params 是一个数组时，它的每个元素都是一个定义字段的子数组；该子数组可以包含

• 一个字符串

  req.set_form([['foo'], ['bar'], ['baz']])
  

• 两个字符串

  req.set_form([%w[foo 0], %w[bar 1], %w[baz 2]])
  

• 当参数 enctype（见下文）被指定为 'multipart/form-data' 时

  • 一个字符串名称和一个用于读取的 IO 流。

    require 'stringio'
    req.set_form([['file', StringIO.new('Ruby is cool.')]])
    

  • 一个字符串名称、一个用于读取的 IO 流以及一个选项哈希，该哈希可以包含以下条目：

    • :filename：要使用的文件名。

    • :content_type：上传文件的内容类型。

    示例

    req.set_form([['file', file, {filename: "other-filename.foo"}]]

各种形式可以混合使用。

req.set_form(['foo', %w[bar 1], ['file', file]])

参数 params 作为哈希

当 params 是一个哈希时，它的每个条目都是一个定义字段的名称/值对。

• 名称是字符串。

• 值可以是

  • nil.

  • 另一个字符串。

  • 一个用于读取的 IO 流（仅当参数 enctype（见下文）指定为 'multipart/form-data' 时）。

示例

# Nil-valued fields.
req.set_form({'foo' => nil, 'bar' => nil, 'baz' => nil})

# String-valued fields.
req.set_form({'foo' => 0, 'bar' => 1, 'baz' => 2})

# IO-valued field.
require 'stringio'
req.set_form({'file' => StringIO.new('Ruby is cool.')})

# Mixture of fields.
req.set_form({'foo' => nil, 'bar' => 1, 'file' => file})

可选参数 enctype 指定字段 'Content-Type' 的值，并且必须是以下之一：

• 'application/x-www-form-urlencoded'（默认）。

• 'multipart/form-data'；请参阅 RFC 7578。

可选参数 formopt 是一个选项哈希（仅当参数 enctype 为 'multipart/form-data' 时适用），可能包含以下条目：

• :boundary：值是 multipart 消息的边界字符串。如果未给出，边界是随机字符串。请参阅 Boundary。

• :charset：值是表单提交的字符集。非文件字段的字段名和值应使用此字符集进行编码。

将请求正文设置为从参数 params 派生的 URL 编码字符串，并将请求头字段 'Content-Type' 设置为 'application/x-www-form-urlencoded'。

生成的请求适用于 HTTP 请求 POST 或 PUT。

参数 params 必须适用于用作 URI.encode_www_form 的参数 enum。

仅给定参数 params 时，将正文设置为带有默认分隔符 '&' 的 URL 编码字符串。

req = Net::HTTP::Post.new('example.com')

req.set_form_data(q: 'ruby', lang: 'en')
req.body            # => "q=ruby&lang=en"
req['Content-Type'] # => "application/x-www-form-urlencoded"

req.set_form_data([['q', 'ruby'], ['lang', 'en']])
req.body            # => "q=ruby&lang=en"

req.set_form_data(q: ['ruby', 'perl'], lang: 'en')
req.body            # => "q=ruby&q=perl&lang=en"

req.set_form_data([['q', 'ruby'], ['q', 'perl'], ['lang', 'en']])
req.body            # => "q=ruby&q=perl&lang=en"

还给定时字符串参数 sep，则使用该字符串作为分隔符。

req.set_form_data({q: 'ruby', lang: 'en'}, '|')
req.body # => "q=ruby|lang=en"

Net::HTTPHeader#form_data= 是 Net::HTTPHeader#set_form_data 的别名。

设置字段 'Range' 的值；请参阅 Range request header。

使用参数 length

req = Net::HTTP::Get.new(uri)
req.set_range(100)      # => 100
req['Range']            # => "bytes=0-99"

使用参数 offset 和 length

req.set_range(100, 100) # => 100...200
req['Range']            # => "bytes=100-199"

使用参数 range

req.set_range(100..199) # => 100..199
req['Range']            # => "bytes=100-199"

Net::HTTPHeader#range= 是 Net::HTTPHeader#set_range 的别名。

从字段 'Content-Type' 的值中返回 媒体类型的末尾（“subtype”）部分，如果不存在该字段则返回 nil；请参阅 Content-Type response header。

res = Net::HTTP.get_response(hostname, '/todos/1')
res['content-type'] # => "application/json; charset=utf-8"
res.sub_type        # => "json"

返回键/值对的哈希。

req = Net::HTTP::Get.new(uri)
req.to_hash
# =>
{"accept-encoding"=>["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"],
 "accept"=>["*/*"],
 "user-agent"=>["Ruby"],
 "host"=>["jsonplaceholder.typicode.com"]}

返回字段 'Content-Type' 值的末尾（“parameters”）部分，如果不存在该字段则返回 nil；请参阅 Content-Type response header。

res = Net::HTTP.get_response(hostname, '/todos/1')
res['content-type'] # => "application/json; charset=utf-8"
res.type_params     # => {"charset"=>"utf-8"}