美文网首页
Vapor文档学习廿七: HTTP - Request

Vapor文档学习廿七: HTTP - Request

作者: Supremodeamor | 来源:发表于2017-04-24 14:16 被阅读70次

    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"]
    

    相关文章

      网友评论

          本文标题:Vapor文档学习廿七: HTTP - Request

          本文链接:https://www.haomeiwen.com/subject/vlauzttx.html