模块 Net::HTTPHeader
HTTPHeader 模块提供对 HTTP 头部的访问。
该模块包含在
-
Net::HTTPGenericRequest
(因此也包含在Net::HTTPRequest
中)。
头部是称为字段的键值对的类似哈希的集合。
请求和响应字段¶ ↑
头部可能包含在
-
一个
Net::HTTPRequest
对象中:该对象的头部将与请求一起发送。请求中可以定义任何字段;请参阅 设置器。 -
一个
Net::HTTPResponse
对象中:该对象的头部通常是从主机返回的。可以从该对象中检索字段;请参阅 获取器 和 迭代器。
应该发送或期望哪些字段完全取决于主机;请参阅
关于示例¶ ↑
此处的示例假设已要求 net/http
(这也要求 uri
)
require 'net/http'
此处的许多代码示例使用以下示例网站
一些示例还假设这些变量
uri = URI('https://jsonplaceholder.typicode.com/') uri.freeze # Examples may not modify. hostname = uri.hostname # => "jsonplaceholder.typicode.com" path = uri.path # => "/" port = uri.port # => 443
因此,示例请求可以写成
Net::HTTP.get(uri) Net::HTTP.get(hostname, '/index.html') Net::HTTP.start(hostname) do |http| http.get('/todos/1') http.get('/todos/2') end
需要修改的示例 URI
首先复制 uri
,然后修改副本
_uri = uri.dup _uri.path = '/todos/1'
字段¶ ↑
头字段是一个键值对。
字段键¶ ↑
字段键可以是
-
字符串:键
'Accept'
被视为'Accept'.downcase
;即'accept'
。 -
符号:键
:Accept
被视为:Accept.to_s.downcase
;即'accept'
。
示例
req = Net::HTTP::Get.new(uri) req[:accept] # => "*/*" req['Accept'] # => "*/*" req['ACCEPT'] # => "*/*" req['accept'] = 'text/html' req[:accept] = 'text/html' req['ACCEPT'] = 'text/html'
字段值¶ ↑
字段值可以作为字符串数组或字符串返回
-
这些方法将字段值作为数组返回
-
get_fields
: 返回给定键的数组值,如果不存在则返回nil
。 -
to_hash
: 返回所有头字段的哈希:每个键都是字段名;它的值是该字段的数组值。
-
-
这些方法将字段值作为字符串返回;字段的字符串值等效于
self[key.downcase.to_s].join(', '))
可以设置字段值
示例字段值
-
字符串
req['Accept'] = 'text/html' # => "text/html" req['Accept'] # => "text/html" req.get_fields('Accept') # => ["text/html"]
-
符号
req['Accept'] = :text # => :text req['Accept'] # => "text" req.get_fields('Accept') # => ["text"]
-
简单数组
req[:foo] = %w[bar baz bat] req[:foo] # => "bar, baz, bat" req.get_fields(:foo) # => ["bar", "baz", "bat"]
-
简单哈希
req[:foo] = {bar: 0, baz: 1, bat: 2} req[:foo] # => "bar, 0, baz, 1, bat, 2" req.get_fields(:foo) # => ["bar", "0", "baz", "1", "bat", "2"]
-
嵌套
req[:foo] = [%w[bar baz], {bat: 0, bam: 1}] req[:foo] # => "bar, baz, bat, 0, bam, 1" req.get_fields(:foo) # => ["bar", "baz", "bat", "0", "bam", "1"] req[:foo] = {bar: %w[baz bat], bam: {bah: 0, bad: 1}} req[:foo] # => "bar, baz, bat, bam, bah, 0, bad, 1" req.get_fields(:foo) # => ["bar", "baz", "bat", "bam", "bah", "0", "bad", "1"]
便捷方法¶ ↑
各种便捷方法检索值、设置值、查询值、设置表单值或遍历字段。
设置器¶ ↑
方法 []=
可以设置任何字段,但对新值的验证很少;一些其他的 setter 方法提供了一些验证
-
[]=
: 为给定键设置字符串或数组值。 -
add_field
: 为给定键创建或添加到数组值。 -
basic_auth
: 为'Authorization'
设置字符串授权头。 -
content_length=
: 为字段'Content-Length
设置整数长度。 -
content_type=
: 为字段'Content-Type'
设置字符串值。 -
proxy_basic_auth
: 为'Proxy-Authorization'
设置字符串授权头。 -
set_range
: 设置字段'Range'
的值。
表单设置器¶ ↑
-
set_form
: 设置 HTML 表单数据集。 -
set_form_data
: 从 HTML 表单数据设置头字段和主体。
获取器¶ ↑
方法 []
可以检索任何存在的字段的值,但始终以字符串形式;一些其他的 getter 方法返回与简单字符串值不同的东西
-
[]
: 返回给定键的字符串字段值。 -
content_length
: 返回字段'Content-Length'
的整数值。 -
content_range
: 返回字段'Content-Range'
的Range
值。 -
content_type
: 返回字段'Content-Type'
的字符串值。 -
fetch
: 返回给定键的字符串字段值。 -
get_fields
: 返回给定key
的数组字段值。 -
main_type
: 返回字段'Content-Type'
的字符串值的第一个部分。 -
sub_type
: 返回字段'Content-Type'
的字符串值的第二个部分。 -
range_length
: 返回字段'Content-Range'
中给定范围的整数长度。 -
type_params
: 返回'Content-Type'
的字符串参数。
查询¶ ↑
-
chunked?
: 返回字段'Transfer-Encoding'
是否设置为'chunked'
。 -
connection_close?
: 返回字段'Connection'
是否设置为'close'
。 -
connection_keep_alive?
: 返回字段'Connection'
是否设置为'keep-alive'
。 -
key?
: 返回给定键是否存在。
迭代器¶ ↑
-
each_capitalized
: 将每个字段的大写名称/值对传递给块。 -
each_capitalized_name
: 将每个大写字段名称传递给块。 -
each_header
: 将每个字段名称/值对传递给块。 -
each_name
: 将每个字段名称传递给块。 -
each_value
: 将每个字符串字段值传递给块。
常量
- MAX_FIELD_LENGTH
- MAX_KEY_LENGTH
公共实例方法
返回不区分大小写的字段 key
的字符串字段值,如果不存在此类键,则返回 nil
;请参阅 字段
res = Net::HTTP.get_response(hostname, '/todos/1') res['Connection'] # => "keep-alive" res['Nosuch'] # => nil
请注意,某些字段值可以通过便捷方法检索;请参阅 获取器.
# File lib/net/http/header.rb, line 224 def [](key) a = @header[key.downcase.to_s] or return nil a.join(', ') end
将不区分大小写的 key
的值设置为 val
,如果字段存在,则覆盖先前值;请参阅 字段
req = Net::HTTP::Get.new(uri) req['Accept'] # => "*/*" req['Accept'] = 'text/html' req['Accept'] # => "text/html"
请注意,某些字段值可以通过便捷方法设置;请参阅 设置器.
# File lib/net/http/header.rb, line 240 def []=(key, val) unless val @header.delete key.downcase.to_s return val end set_field(key, val) end
如果字段存在,则将值 val
添加到字段 key
的值数组中;如果不存在,则使用给定的 key
和 val
创建字段。请参阅 字段
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"]
# File lib/net/http/header.rb, line 261 def add_field(key, val) stringified_downcased_key = key.downcase.to_s if @header.key?(stringified_downcased_key) append_field_value(@header[stringified_downcased_key], val) else set_field(key, val) end end
使用给定的 account
和 password
字符串设置标头 'Authorization'
req.basic_auth('my_account', 'my_password') req['Authorization'] # => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="
# File lib/net/http/header.rb, line 945 def basic_auth(account, password) @header['authorization'] = [basic_encode(account, password)] end
如果字段 'Transfer-Encoding'
存在且具有值 'chunked'
,则返回 true
,否则返回 false
;请参阅 Transfer-Encoding 响应标头
res = Net::HTTP.get_response(hostname, '/todos/1') res['Transfer-Encoding'] # => "chunked" res.chunked? # => true
# File lib/net/http/header.rb, line 654 def chunked? return false unless @header['transfer-encoding'] field = self['Transfer-Encoding'] (/(?:\A|[^\-\w])chunked(?![\-\w])/i =~ field) ? true : false end
返回 HTTP
会话是否将要关闭。
# File lib/net/http/header.rb, line 966 def connection_close? token = /(?:\A|,)\s*close\s*(?:\z|,)/i @header['connection']&.grep(token) {return true} @header['proxy-connection']&.grep(token) {return true} false end
返回 HTTP
会话是否将要保持活动状态。
# File lib/net/http/header.rb, line 974 def connection_keep_alive? token = /(?:\A|,)\s*keep-alive\s*(?:\z|,)/i @header['connection']&.grep(token) {return true} @header['proxy-connection']&.grep(token) {return true} false end
返回字段 'Content-Length'
的值作为整数,如果不存在该字段则返回 nil
;参见 Content-Length 请求头
res = Net::HTTP.get_response(hostname, '/nosuch/1') res.content_length # => 2 res = Net::HTTP.get_response(hostname, '/todos/1') res.content_length # => nil
# File lib/net/http/header.rb, line 616 def content_length return nil unless key?('Content-Length') len = self['Content-Length'].slice(/\d+/) or raise Net::HTTPHeaderSyntaxError, 'wrong Content-Length format' len.to_i end
将字段 'Content-Length'
的值设置为给定的数字;参见 Content-Length 响应头
_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>
# File lib/net/http/header.rb, line 637 def content_length=(len) unless len @header.delete 'content-length' return nil end @header['content-length'] = [len.to_i.to_s] end
返回一个 Range
对象,表示字段 'Content-Range'
的值,如果不存在该字段则返回 nil
;参见 Content-Range 响应头
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
# File lib/net/http/header.rb, line 670 def content_range return nil unless @header['content-range'] m = %r<\A\s*(\w+)\s+(\d+)-(\d+)/(\d+|\*)>.match(self['Content-Range']) or raise Net::HTTPHeaderSyntaxError, 'wrong Content-Range format' return unless m[1] == 'bytes' m[2].to_i .. m[3].to_i end
返回字段 'Content-Type'
的值中的 媒体类型,如果不存在该字段则返回 nil
;参见 Content-Type 响应头
res = Net::HTTP.get_response(hostname, '/todos/1') res['content-type'] # => "application/json; charset=utf-8" res.content_type # => "application/json"
# File lib/net/http/header.rb, line 701 def content_type main = main_type() return nil unless main sub = sub_type() if sub "#{main}/#{sub}" else main end end
删除给定不区分大小写的 key
的头(参见 Fields);返回已删除的值,如果不存在该字段则返回 nil
req = Net::HTTP::Get.new(uri) req.delete('Accept') # => ["*/*"] req.delete('Nosuch') # => nil
# File lib/net/http/header.rb, line 453 def delete(key) @header.delete(key.downcase.to_s) end
与 each_header
相似,但键以大写形式返回。
Net::HTTPHeader#canonical_each
是 Net::HTTPHeader#each_capitalized
的别名。
# File lib/net/http/header.rb, line 484 def each_capitalized block_given? or return enum_for(__method__) { @header.size } @header.each do |k,v| yield capitalize(k), v.join(', ') end end
使用每个大写字段名称调用块
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"
大小写区分取决于系统;请参阅 大小写映射。
如果没有给出代码块,则返回一个枚举器。
# File lib/net/http/header.rb, line 417 def each_capitalized_name #:yield: +key+ block_given? or return enum_for(__method__) { @header.size } @header.each_key do |k| yield capitalize(k) end end
使用每个键值对调用代码块
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
的别名。
# File lib/net/http/header.rb, line 364 def each_header #:yield: +key+, +value+ block_given? or return enum_for(__method__) { @header.size } @header.each do |k,va| yield k, va.join(', ') end end
使用每个字段键调用代码块
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
的别名。
# File lib/net/http/header.rb, line 391 def each_name(&block) #:yield: +key+ block_given? or return enum_for(__method__) { @header.size } @header.each_key(&block) end
使用每个字符串字段值调用代码块
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"
如果没有给出代码块,则返回一个枚举器。
# File lib/net/http/header.rb, line 438 def each_value #:yield: +value+ block_given? or return enum_for(__method__) { @header.size } @header.each_value do |va| yield va.join(', ') end end
使用代码块,如果存在,则返回 key
的字符串值;否则返回代码块的值;忽略 default_val
;请参阅 字段
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.
# File lib/net/http/header.rb, line 341 def fetch(key, *args, &block) #:yield: +key+ a = @header.fetch(key.downcase.to_s, *args, &block) a.kind_of?(Array) ? a.join(', ') : a end
返回给定 key
的数组字段值,如果不存在此字段,则返回 nil
;请参阅 字段
res = Net::HTTP.get_response(hostname, '/todos/1') res.get_fields('Connection') # => ["keep-alive"] res.get_fields('Nosuch') # => nil
# File lib/net/http/header.rb, line 306 def get_fields(key) stringified_downcased_key = key.downcase.to_s return nil unless @header[stringified_downcased_key] @header[stringified_downcased_key].dup end
如果存在不区分大小写的 key
的字段,则返回 true
,否则返回 false
req = Net::HTTP::Get.new(uri) req.key?('Accept') # => true req.key?('Nosuch') # => false
# File lib/net/http/header.rb, line 463 def key?(key) @header.key?(key.downcase.to_s) end
返回字段 'Content-Type'
值的 媒体类型 的前导(“类型”)部分,如果不存在此字段,则返回 nil
;请参阅 Content-Type 响应头
res = Net::HTTP.get_response(hostname, '/todos/1') res['content-type'] # => "application/json; charset=utf-8" res.main_type # => "application"
# File lib/net/http/header.rb, line 723 def main_type return nil unless @header['content-type'] self['Content-Type'].split(';').first.to_s.split('/')[0].to_s.strip end
使用给定的 account
和 password
字符串设置 'Proxy-Authorization'
标头
req.proxy_basic_auth('my_account', 'my_password') req['Proxy-Authorization'] # => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="
# File lib/net/http/header.rb, line 956 def proxy_basic_auth(account, password) @header['proxy-authorization'] = [basic_encode(account, password)] end
返回一个包含 Range
对象的数组,这些对象表示 'Range'
字段的值,如果不存在此字段则返回 nil
;请参阅 Range 请求标头
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
# File lib/net/http/header.rb, line 509 def range return nil unless @header['range'] value = self['Range'] # byte-range-set = *( "," OWS ) ( byte-range-spec / suffix-byte-range-spec ) # *( OWS "," [ OWS ( byte-range-spec / suffix-byte-range-spec ) ] ) # corrected collected ABNF # http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#section-5.4.1 # http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#appendix-C # http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-19#section-3.2.5 unless /\Abytes=((?:,[ \t]*)*(?:\d+-\d*|-\d+)(?:[ \t]*,(?:[ \t]*\d+-\d*|-\d+)?)*)\z/ =~ value raise Net::HTTPHeaderSyntaxError, "invalid syntax for byte-ranges-specifier: '#{value}'" end byte_range_set = $1 result = byte_range_set.split(/,/).map {|spec| m = /(\d+)?\s*-\s*(\d+)?/i.match(spec) or raise Net::HTTPHeaderSyntaxError, "invalid byte-range-spec: '#{spec}'" d1 = m[1].to_i d2 = m[2].to_i if m[1] and m[2] if d1 > d2 raise Net::HTTPHeaderSyntaxError, "last-byte-pos MUST greater than or equal to first-byte-pos but '#{spec}'" end d1..d2 elsif m[1] d1..-1 elsif m[2] -d2..-1 else raise Net::HTTPHeaderSyntaxError, 'range is not specified' end } # if result.empty? # byte-range-set must include at least one byte-range-spec or suffix-byte-range-spec # but above regexp already denies it. if result.size == 1 && result[0].begin == 0 && result[0].end == -1 raise Net::HTTPHeaderSyntaxError, 'only one suffix-byte-range-spec with zero suffix-length' end result end
返回表示 'Content-Range'
字段值的长度的整数,如果不存在此字段则返回 nil
;请参阅 Content-Range 响应标头
res = Net::HTTP.get_response(hostname, '/todos/1') res['Content-Range'] # => nil res['Content-Range'] = 'bytes 0-499/1000' res.range_length # => 500
# File lib/net/http/header.rb, line 687 def range_length r = content_range() or return nil r.end - r.begin + 1 end
设置 'Content-Type'
字段的值;返回新值;请参阅 Content-Type 请求标头
req = Net::HTTP::Get.new(uri) req.set_content_type('application/json') # => ["application/json"]
Net::HTTPHeader#content_type=
是 Net::HTTPHeader#set_content_type
的别名。
# File lib/net/http/header.rb, line 772 def set_content_type(type, params = {}) @header['content-type'] = [type + params.map{|k,v|"; #{k}=#{v}"}.join('')] end
存储将在 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'
时
各种形式可以混合使用
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
:该值是多部分消息的边界字符串。如果未给出,则边界是随机字符串。参见 Boundary。 -
:charset
:该值是表单提交的字符集。非文件字段的字段名称和值应使用此字符集进行编码。
# File lib/net/http/header.rb, line 924 def set_form(params, enctype='application/x-www-form-urlencoded', formopt={}) @body_data = params @body = nil @body_stream = nil @form_option = formopt case enctype when /\Aapplication\/x-www-form-urlencoded\z/i, /\Amultipart\/form-data\z/i self.content_type = enctype else raise ArgumentError, "invalid enctype: #{enctype}" end end
将请求主体设置为从参数 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
的别名。
# File lib/net/http/header.rb, line 812 def set_form_data(params, sep = '&') query = URI.encode_www_form(params) query.gsub!(/&/, sep) if sep != '&' self.body = query self.content_type = 'application/x-www-form-urlencoded' end
设置字段 'Range'
的值;参见 Range 请求头
使用参数 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
的别名。
# File lib/net/http/header.rb, line 576 def set_range(r, e = nil) unless r @header.delete 'range' return r end r = (r...r+e) if e case r when Numeric n = r.to_i rangestr = (n > 0 ? "0-#{n-1}" : "-#{-n}") when Range first = r.first last = r.end last -= 1 if r.exclude_end? if last == -1 rangestr = (first > 0 ? "#{first}-" : "-#{-first}") else raise Net::HTTPHeaderSyntaxError, 'range.first is negative' if first < 0 raise Net::HTTPHeaderSyntaxError, 'range.last is negative' if last < 0 raise Net::HTTPHeaderSyntaxError, 'must be .first < .last' if first > last rangestr = "#{first}-#{last}" end else raise TypeError, 'Range/Integer is required' end @header['range'] = ["bytes=#{rangestr}"] r end
返回字段 'Content-Type'
值中的 媒体类型 的尾随(“子类型”)部分,如果不存在此类字段,则返回 nil
;参见 Content-Type 响应头
res = Net::HTTP.get_response(hostname, '/todos/1') res['content-type'] # => "application/json; charset=utf-8" res.sub_type # => "json"
# File lib/net/http/header.rb, line 738 def sub_type return nil unless @header['content-type'] _, sub = *self['Content-Type'].split(';').first.to_s.split('/') return nil unless sub sub.strip end
返回键值对的哈希表。
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"]}
# File lib/net/http/header.rb, line 477 def to_hash @header.dup end
返回 'Content-Type'
字段值的尾部(“参数”)部分,如果不存在此字段,则返回 nil
;请参阅 Content-Type 响应头
res = Net::HTTP.get_response(hostname, '/todos/1') res['content-type'] # => "application/json; charset=utf-8" res.type_params # => {"charset"=>"utf-8"}
# File lib/net/http/header.rb, line 753 def type_params result = {} list = self['Content-Type'].to_s.split(';') list.shift list.each do |param| k, v = *param.split('=', 2) result[k.strip] = v.strip end result end
私有实例方法
# File lib/net/http/header.rb, line 285 def append_field_value(ary, val) case val when Enumerable val.each{|x| append_field_value(ary, x)} else val = val.to_s if /[\r\n]/n.match?(val.b) raise ArgumentError, 'header field value cannot include CR/LF' end ary.push val end end
# File lib/net/http/header.rb, line 960 def basic_encode(account, password) 'Basic ' + ["#{account}:#{password}"].pack('m0') end
# File lib/net/http/header.rb, line 493 def capitalize(name) name.to_s.split(/-/).map {|s| s.capitalize }.join('-') end
# File lib/net/http/header.rb, line 270 def set_field(key, val) case val when Enumerable ary = [] append_field_value(ary, val) @header[key.downcase.to_s] = ary else val = val.to_s # for compatibility use to_s instead of to_str if val.b.count("\r\n") > 0 raise ArgumentError, 'header field value cannot include CR/LF' end @header[key.downcase.to_s] = [val] end end