Vapor文档学习廿七: HTTP - Request

Module: import HTTP

Request类是我们和HTTP模块打交道最多的部分,喜爱满看一些它常用的属性:

public var method: Method
public var uri: URI
public var parameters: Node
public var headers: [HeaderKey: String]
public var body: Body
public var data: Content

Method

HTTP请求方法包括:GET、POST、PUT、PATCH、DELETE。

URI

与请求相关的URI类,用来访问发送请求的uri的属性。
比如:http://vapor.codes/example?query=hi#fragments-too

let scheme = request.uri.scheme // http
let host = request.uri.host // vapor.codes

let path = request.uri.path // /example
let query = request.uri.query // query=hi
let fragment = request.uri.fragment // fragments-too

Route Parameters

请求相关的url 参数。比如我们注册了hello/:name/age/:age的路径,那么我们可以获取如下内容:

let name = request.parameters["name"] // String?
let age = request.parameters["age"]?.int // Int?

或者你也可以用extract抛出nil和无效的变量。

let name = try request.parameters.extract("name") as String
let age = try request.parameters.extract("age") as Int

extract函数可以转换任何NodeInitializable类型,包括自定义的类型。如果要了解更多请参考Node

注意:路由部分也说明了类型安全的路由

Headers

请求相关的头部信息。如果你准备对外发送请求,你可以将自己的秘钥添加到headers中。

let contentType = request.headers["Content-Type"]  

向外部发送请求时:

let request = Request ...
request.headers["Content-Type"] = "application/json"
request.headers["Authorization"] = ... my auth token

Extending Headers

我们总是尽可能的剔除字符串类型的代码来提高程序代码。我们可以通过扩展向headers中添加变量。

extension HTTP.KeyAccessible where Key == HeaderKey, Value == String {
    var customKey: String? {
      get {
        return self["Custom-Key"]
      }
      set {
        self["Custom-Key"] = newValue
      }
    }
}

实现上面的模式之后,我们的字符串类型的Custom-key包含在了我们的代码里。现在可以如下访问:

let customKey = request.headers.customKey

// or

let request = ...
request.headers.customKey = "my custom value"

Body

body是请求相关的主体,承载这主要数据。在body可以查看更多信息。
为了传到请求中,我们经常这样拉取body字节:

let rawBytes = request.body.bytes

Content

通常,当我们发送或接收请求时,我们将其用作传输内容的方式。 为此,Vapor提供了一个方便的data变量,与请求相关联,以一致的方式管理请求内容。
比如,我从http://vapor.codes?hello=world接收一个请求:

let world = request.data["hello"]?.string

如果我们接收以下json数据,上面的代码同样适用:

{
  "hello": "world"
}

这也适用于"multi-part"请求,甚至可以通过Middleware扩展新的类型,如XML或YAML。
如果你喜欢更明确地访问给定的类型,那是完全正确的。 data变量纯粹为开发者选择方便。

JSON

可以直接通过json获取请求的json数据:

let json = request.json["hello"]

Query Parameters

query方法获取查询数据:

let query = request.query?["hello"]  // String?
let name = request.query?["name"]?.string // String?
let age = request.query?["age"]?.int // Int?
let rating = request.query?["rating"]?.double // Double?

Key Paths

Key paths 适用于大多数Vapor类型的key-value嵌套。
如下json示例:

{
  "metadata": "some metadata",
  "artists" : {
    "href": "http://someurl.com",
    "items": [
      {
        "name": "Van Gogh",
      },
      {
        "name": "Mozart"
      }
    ]
  }
}

然后我们可以通过以下方式获取值:

MetaData

获取最外层值:

let type = request.data["metadata"].string // "some metadata"
Items

获取嵌套值:

let items = request.data["artists", "items"] // [["name": "Van Gogh"], ["name": "Mozart"]]
Mixing Arrays and Objects

获取第一个“artists”:

let first = request.data["artists", "items", 0] // ["name": "Van Gogh"]
Array Item

从item获取key:

let firstName = request.data["artists", "items", 0, "name"] // "Van Gogh"
Array Comprehension

遍历数组,只取artists 的name:

let names = request.data["artists", "items", "name"] // ["Van Gogh", "Mozart"]
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,036评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,046评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,411评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,622评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,661评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,521评论 1 304
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,288评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,200评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,644评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,673评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,281评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2 355

推荐阅读更多精彩内容