Vapor文档学习十五:ROUTING - Route Parameters

传统的Web框架通常都是使用字符串作为路由参数名称和参数类型,这就为路由出错埋下了隐患。 Vapor利用Swift闭包,提供了更加安全、更加直观的访问路由参数的方法。

Type Safe

创建一个类型安全的路由,只需要使用Type来替换路径中的一部分:

drop.get("users", Int.self) { request, userId in
    return "You requested User #\(userId)"
}

上面创建了一个匹配users/:id的路由,:idInt类型下面。作为对比,下面来演示如何手动判断路由参数的写法:

drop.get("users", ":id") { request in
  guard let userId = request.parameters["id"]?.int else {
    throw Abort.badRequest
  }

  return "You requested User #\(userId)"
}

我们看到类型安全的路由不仅少了3行代码,还可以避免发生运行时的错误(比如:id拼写错误)。

String Initializable

所有遵守StringInitializable协议的类型都可以作为类型安全路由的参数,默认包含以下类型:

  • String
  • Int
  • Model

String是最常用的,并且总是可以匹配的。Int只会匹配可以转换为整数的字符串,Model只会匹配通过字符串标识可以在数据库查到的模型。
之前的示例可以更加简化:

drop.get("users", User.self) { request, user in
  return "You requested \(user.name)"
}

这里提供的标识符会被用于自动查找用户。比如请求了/users/5User模型会自动查找标识为5的user,如果查找到了则请求成功,并且执行闭包,否则会抛出为查找到用户的异常。

下面是model没有遵守StringInitializable协议的情况下的写法:

drop.get("users", Int.self) { request, userId in
  guard let user = try User.find(userId) else {
    throw Abort.notFound
  }

    return "You requested User #\(userId)"
}

类型安全的路由总共可以为每一个路由减少6行代码。

Protocol

自定义类型遵守StringInitializable十分简单:

// StringInitializable的定义
public protocol StringInitializable {
    init?(from string: String) throws
}

Model类实现协议方法:

extension Model {
    public init?(from string: String) throws {
        if let model = try Self.find(string) {
            self = model
        } else {
            return nil
        }
    }
}

init既可以返回nil,也可以抛出异常。这样你可以抛出自定义的异常,也可以通过返回nil使用默认的方法处理异常。

Limits

目前类型安全的路由限制只能有三个参数,可以通过使用group来解决这个问题。

drop.group("v1", "users") { users in
  users.get(User.self, "posts", Post.self) { request, user, post in
    return "Requested \(post.name) for \(user.name)"
  }
}

上面是处理/v1/users/:userId/posts/:postId路由请求的结果。如果你呼吁增加更多类型安全路由,我们可以考虑将限制数提高一些。

Manual

综上所述,你依然可以使用传统的路由(非类型安全的路由)来处理特别复杂的情况。

drop.get("v1", "users", ":userId", "posts", ":postId", "comments", ":commentId") { request in
  let userId = try request.parameters.extract("userId") as Int
  let postId = try request.parameters.extract("postId") as Int
  let commentId = try request.parameters.extract("commentId") as Int

  return "You requested comment #\(commentId) for post #\(postId) for user #\(userId)"
}

request.parameters属性用来提取URI path编码的参数(比如/v1/users/1具有参数:userId,等于"1")。参数作为查询的一部分进行传递的情况下(e.g. /v1/search-user?userId=1),应该使用request.data(e.g. let userId = request.data["userId"]?.string)。

除了返回可选值外,请求参数可以作为字典来访问,也可以使用extract语法访问。

Groups

手动使用参数也适用于group

let userGroup = drop.grouped("users", ":userId")
userGroup.get("messages") { req in
    let user = try req.parameters.extract("userId") as User
}

<b>总结:</b>本章主要介绍了路由参数设置的方法,类型安全的路由可以极大的简化我们的代码,但是具有最多3个参数的限制。通过使用group可以解决这个问题。处理复杂的情况下,我们依然可以使用普通的路由模式。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • iOS网络架构讨论梳理整理中。。。 其实如果没有APIManager这一层是没法使用delegate的,毕竟多个单...
    yhtang阅读 5,184评论 1 23
  • # 一度蜜v3.0协议 --- # 交互协议 [TOC] ## 协议说明 ### 请求参数 下表列出了v3.0版协...
    c5e350bc5b40阅读 642评论 0 0
  • Routing Parameters 传统的Web框架通过使用路由参数名称和类型的字符串为路由留出错误空间。vap...
    晓蜻蜓阅读 655评论 0 1
  • 运动类别 耐力性 耐力性运动,又称有氧运动,是运动处方最主要和最基本的运动手段。在治疗性运动处方和预防性运动处方中...
    梦想不会太遥远阅读 485评论 0 0