Skip to content

Latest commit

 

History

History
351 lines (264 loc) · 11.6 KB

kong-request.md

File metadata and controls

351 lines (264 loc) · 11.6 KB
Raw

kong.request

本文原文链接：https://docs.konghq.com/1.1.x/pdk/kong.request/

Client request 模块是一组函数，用于获取有关客户端发出的传入请求的信息。

kong.request.get_scheme()

返回请求的URL的协议组件。返回值规范化为小写形式。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string 一个字符串，类似 "http" 或者 "https"
  • 用法 
     -- Given a request to https://example.com:1234/v1/movies

 kong.request.get_scheme() -- "https"

kong.request.get_host()

返回请求的URL的host组件，或“Host”标头的值。返回值规范化为小写形式。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string host
  • 用法 
     -- Given a request to https://example.com:1234/v1/movies

 kong.request.get_host() -- "example.com"

kong.request.get_port()

返回请求URL的端口组件。该值以Lua number 返回。

  • 阶段
    • certificate, rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • number 端口号
  • 用法 
     -- Given a request to https://example.com:1234/v1/movies

 kong.request.get_port() -- 1234

kong.request.get_forwarded_scheme()

返回请求的URL的协议组件，但如果它来自可信源，也会考虑X-Forwarded-Proto。返回值规范化为小写。

此函数是否考虑X-Forwarded-Proto取决于几个Kong配置参数：

提醒：由于ngx_http_realip_module不支持Forwarded HTTP Extension（RFC 7239），因此尚未提供支持。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string 转发的协议
  • 用法 
     kong.request.get_forwarded_scheme() -- "https"

kong.request.get_forwarded_host()

返回请求的URL的主机组件或“host”标头的值。不同于kong.request.get_host()，在保证可靠来源的情况下，它也会考虑使用X-Forwarded-Host。返回值规范化为小写。

此函数是否考虑X-Forwarded-Proto取决于几个Kong配置参数：

提醒：由于ngx_http_realip_module不支持Forwarded HTTP Extension（RFC 7239），因此尚未提供支持。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string 转发的host
  • 用法 
     kong.request.get_forwarded_host() -- "example.com"

kong.request.get_forwareded_port()

返回请求的URL的端口组件。不同于kong.request.get_host()，在保证可靠来源的情况下，它也会考虑使用X-Forwarded-Host。返回值规范化为lua number。

此函数是否考虑X-Forwarded-Proto取决于几个Kong配置参数：

提醒：由于ngx_http_realip_module不支持Forwarded HTTP Extension（RFC 7239），因此尚未提供支持。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • number 转发的端口
  • 用法 
     kong.request.get_forwarded_port() -- 1234

kong.request.get_http_version()

返回客户端在请求中使用的HTTP版本作为Lua number，返回值“1.1”和“2.0”，或者对于无法识别的值返回nil。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string|nil HTTP版号
  • 用法 
     kong.request.get_http_version() -- "1.1"

kong.request.get_method()

返回请求的HTTP方法。该值返回规范化为大写。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string 请求方法
  • 用法 
     kong.request.get_method() -- "GET"

kong.request.get_path()

返回请求URL的路径组件。它没有以任何方式标准化，也不包括url内参数。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string 路径
  • 用法 
     -- Given a request to https://example.com:1234/v1/movies?movie=foo

 kong.request.get_path() -- "/v1/movies"

kong.request.get_path_with_query()

返回路径，包括url内的参数（如果有）。没有进行转换/标准化。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string 带参数的路径
  • 用法 
     -- Given a request to https://example.com:1234/v1/movies?movie=foo

 kong.request.get_path_with_query() -- "/v1/movies?movie=foo"

kong.request.get_raw_query()

返回请求的URL的查询参数组件。它没有以任何方式进行标准化（甚至不对特殊字符进行URL解码）并且不包括最前面的? 字符标示。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string 请求的URL的查询参数
  • 用法 
     -- Given a request to https://example.com/foo?msg=hello%20world&bla=&bar

 kong.request.get_raw_query() -- "msg=hello%20world&bla=&bar"

kong.request.get_query_arg()

返回从当前请求的查询参数获取的指定参数的值。

返回的值是字符串，如果没有给出值，则返回布尔值true;如果找不到带有name的参数，则返回nil。

如果在查询字符串中多次出现具有相同名称的参数，则此函数将返回第一次出现的值。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 返回
    • string|boolean|nil 参数的值
  • 用法 
     -- Given a request GET /test?foo=hello%20world&bar=baz&zzz&blo=&bar=bla&bar

 kong.request.get_query_arg("foo") -- "hello world"
 kong.request.get_query_arg("bar") -- "baz"
 kong.request.get_query_arg("zzz") -- true
 kong.request.get_query_arg("blo") -- ""

kong.request.get_query([max_args])

返回从查询字符串获取的查询参数table。key是查询参数名称。值可以是带参数值的字符串，如果参数未赋值，则为布尔值true;如果在查询字符串中多次给出参数，则为数组。键和值根据URL编码的转义规则未转义。

请注意，查询参数字符串?foo＆bar转换为两个布尔值true参数，而?foo=&bar=转换为包含空字符串的两个字符串参数。

默认情况下，此函数最多返回100个参数。可以指定可选的max_args参数来自定义此限制，但必须大于1且不大于1000。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 参数
    • max_args(number, optional):设置已解析参数的最大数量限制
  • 返回
    • table 查询参数的表
  • 用法 
     -- Given a request GET /test?foo=hello%20world&bar=baz&zzz&blo=&bar=bla&bar

 for k, v in pairs(kong.request.get_query()) do
   kong.log.inspect(k, v)
 end

 -- Will print
 -- "foo" "hello world"
 -- "bar" {"baz", "bla", true}
 -- "zzz" true
 -- "blo" ""

kong.request.get_header(name)

返回指定请求header的值。

返回的值是字符串，如果在请求中找不到具有名称的header，则返回值可以为nil。 如果请求中多次出现具有相同名称的header，则此函数将返回此header第一次出现的值。

标题名称不区分大小写，并且标准化为小写，短划线（ - ）可以写为下划线（_）; 也就是说，header X-Custom-Header也可以作为x_custom_header检索。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 参数
    • name (string):要返回的标头的名称
  • 返回
    • string|nil header的值，如果不存在则为nil
  • 用法 
     -- Given a request with the following headers:

 -- Host: foo.com
 -- X-Custom-Header: bla
 -- X-Another: foo bar
 -- X-Another: baz

 kong.request.get_header("Host")            -- "foo.com"
 kong.request.get_header("x-custom-header") -- "bla"
 kong.request.get_header("X-Another")       -- "foo bar"

kong.request.get_headers([max_headers])

返回包含请求标头的Lua table。key是标题名称。值可以是带有header值的字符串，也可以是多次发送header的字符串数组。此表中的标题名称不区分大小写，并标准化为小写，短划线（-）可以写为下划线（_）; 也就是说，标题X-Custom-Header也可以作为x_custom_header检索。

默认情况下，此函数最多返回100个标题。可以使用可选的max_headers参数来自定义此限制，但必须大于1且不大于1000。

  • 阶段
    • rewrite, access, header_filter, body_filter, log, admin_api
  • 参数
    • max_headers (number, optional):设置可以解析header的最大数量限制
  • 返回
    • table table类型请求头
  • 用法 
     -- Given a request with the following headers:

 -- Host: foo.com
 -- X-Custom-Header: bla
 -- X-Another: foo bar
 -- X-Another: baz
 local headers = kong.request.get_headers()

 headers.host            -- "foo.com"
 headers.x_custom_header -- "bla"
 headers.x_another[1]    -- "foo bar"
 headers["X-Another"][2] -- "baz"

kong.request.get_raw_body()

返回普通请求体。如果正文没有大小（空），则此函数返回一个空字符串。如果正文的大小大于Nginx缓冲区大小（由client_body_buffer_size设置），则此函数将失败并返回解释此限制的错误消息。

  • 阶段
    • rewrite, access, admin_api
  • 返回
    • string 请求提体
  • 用法 
     -- Given a body with payload "Hello, Earth!":

 kong.request.get_raw_body():gsub("Earth", "Mars") -- "Hello, Mars!"

kong.request.get_body([mimetype[, max_args]])

将请求数据作为key/value表返回。一个高级便利功能。使用最合适的格式解析请求体：

  • 如果指定了mimetype
    • 使用请求的内容类型对主体进行解码（如果支持）。
  • 如果请求content-type类型是application/x-www-form-urlencoded
    • 以form-encoded形式返回body。
  • 如果请求content-type类型是multipart/form-data
    • 将主体解码为多部分表单数据（与multipart(kong.request.get_raw_body(), kong.request.get_header("Content-Type")):get_all()一样）
  • 如果请求content-type类型是application/json
    • 将body解码为JSON（与json.decode(kong.request.get_raw_body())一样）
    • JSON类型转换为匹配的Lua类型。
  • 如果不是上述任何一项，则返回nil，并且无法解析指示body的错误消息。

可选参数mimetype可以是以下字符串之一：

  • application/x-www-form-urlencoded
  • application/json
  • multipart/form-data

可选参数max_args可用于设置对application/x-www-form-urlencoded有效解析的表单参数数量的限制。

第三个返回值是包含用于解析主体的mimetype的字符串（根据mimetype参数），允许调用者识别正在解析主体的MIME类型。

  • 阶段
    • rewrite, access, admin_api
  • 参数
    • mimetype (string, optional): MIME 类型
    • max_args (number, optional): 设置已解析参数的最大数量限制
  • 返回
    1. table|nil 一个table表示请求体
    2. string|nil 错误信息
    3. string|nil mimetype使用的MIME类型
  • 用法 
     local body, err, mimetype = kong.request.get_body()
 body.name -- "John Doe"
 body.age  -- "42"