上篇文章帶大家基本了解了一下開始一個 Vapor 項目的流程,本篇緊接著來說說在所有 Web 框架中都最關(guān)鍵的 “路由”粘优,因為 “路由” 模塊在 Web 項目中擔任很重要的角色仇味,所以很多語言的 Web 框架都把 “路由” 抽離到框架層,從而減少開發(fā)者的工作量雹顺,一個設(shè)計得易用強大的 “路由” 系統(tǒng)也會給相應(yīng)給框架增添不少色彩丹墨。
Web 開發(fā)中的路由這個概念簡單來說就是 URL 路徑到具體處理函數(shù)之間的映射,只有設(shè)定好了路由嬉愧,訪問者才能在瀏覽器根據(jù)相關(guān) URL 規(guī)則進行頁面跳轉(zhuǎn)和訪問贩挣,Vapor 對路由做了很多實用性設(shè)計,包括路由的構(gòu)建、路由組王财、類型安全的路由參數(shù)卵迂、路由集合等等,希望看完本篇文章你能用 Vapor 寫出一些簡單的路由绒净,我們先來看看 Vapor 最簡單的路由注冊见咒。
Droplet
注冊路由之前我們需要知道 Droplet
這個類,每個程序都應(yīng)該有一個它的實例挂疆,控制著整個程序的生命周期论颅,之后我們會通過 droplet 來注冊路由,添加 provider囱嫩,添加中間件 (middleware) 等等。 droplet 的初始化很簡單漏设,一個空程序看起來就像這樣:
import Vapor
let drop = Droplet()
// your magic here
drop.run()
注冊路由
注冊一個最基本的路由通過對全局 Droplet
對象調(diào)用一個方法墨闲,指定路徑和一個閉包來接收操作處理。
drop.get("welcome") { request in
return "Hello"
}
我們通過調(diào)用 get()
方法來注冊了一個路徑為 /welcome
的路由郑口,并返回了 "Hello" 這個字符串到瀏覽器鸳碧,當然我們除了 get
還可以其他的標準 HTTP 方法,比如 post
犬性、 put
瞻离、 patch
、 delete
乒裆、options
套利。
另外我們還可以使用 add()
方法來注冊路由,以接收第一個參數(shù) Method
作為 HTTP 方法來動態(tài)注冊路由鹤耍,Method
是一個枚舉肉迫,包含了上述所列的 HTTP 標準方法,代碼看起來是這樣:
drop.add(.trace, "welcome") { request in
return "Hello"
}
可能你會想明明上面已經(jīng)提供了對應(yīng)的方法來注冊路由稿黄,為什么還要多一個 add()
方法來注冊路由喊衫?因為這個方法可以動態(tài)注冊,并且支持一些其他不常見的方法(比如 trace
)杆怕。
另外有一種關(guān)于多級路徑的寫法族购,直接使用參數(shù)分割,而不是在一個 String 參數(shù)中用 /
分開陵珍,官方推薦是這種寫法寝杖,因為可以更容易寫出類型安全的路由參數(shù)。
drop.get("foo", "bar", "baz") { request in
return "You requested /foo/bar/baz"
}
如果想在 URL 路由中使用通配符怎么辦撑教?
app.get("anything", "*") { request in
return "Matches anything after /anything"
}
像這個例子因為用了 *
尾隨參數(shù)朝墩,可以匹配到如下所有路徑:
- /anything
- /anything/foo
- /anything/foo/bar
- /anything/foo/bar/baz
Request
每個路由的閉包都會有一個 Request
參數(shù),用來獲得每一個訪問請求的相關(guān)內(nèi)容,比如 URL 參數(shù)收苏、HTTP Header亿卤、HTTP Body 等等,而且 Vapor 都已經(jīng)為你封裝好了很方便的接口來獲取這些內(nèi)容鹿霸,甚至直接解析 JSON排吴。
詳細使用可以參考官方文檔 Request 一節(jié)。
路由參數(shù)
Vapor 提倡使用類型安全的路由參數(shù)來接收數(shù)據(jù)懦鼠,我們可以在路由方法中使用 Swift 類型來指定參數(shù)類型钻哩,Vapor 會在內(nèi)部解析并將參數(shù)返回給閉包以供使用,非常方便肛冶。
drop.get("users", Int.self) { request, userId in
return "You requested User #\(userId)"
}
Swift 中處處有協(xié)議街氢,路由參數(shù)也是如此,我們所見例子中的 Int
其實就是 Vapor 給實現(xiàn)了 StringInitializable
協(xié)議睦袖,當然 String
也已經(jīng)默認實現(xiàn)珊肃。
public protocol StringInitializable {
init?(from string: String) throws
}
Response
每個路由的閉包中可以返回三種類型的內(nèi)容,Response
馅笙、ResponseRepresentable
伦乔、throw
,你可以你可以返回自己所需的 HTTP 狀態(tài)碼董习、URL 重定向烈和、JSON等,基本涵蓋日常所需的請求返回皿淋。
Response
Response
是 Vapor 中 HTTP 模塊中定義的基于 Message 的類招刹,有很多構(gòu)造方法方便我們自定義 response 返回:
// 重定向
Response(redirect: "http://vapor.codes")
// JSON
Response(status: .ok, json: JSON(["hello":"world"]))
// String
Response(body: "hello")
ResponseRepresentable
ResponseRepresentable
是一個協(xié)議宋距,任何遵循這個協(xié)議的對象均可在路由中返回衰腌,就像之前例子中我們直接返回了字符串,就是因為 Vapor 默認給 String
實現(xiàn)了 ResponseRepresentable
協(xié)議备恤,讓我們可以方便的在閉包中直接返回字符串高帖,類似的還有 JSON
缰儿、Model
對象。
throw
另外一大特性就是可以直接在路由中拋出異常散址,我們可以 throw 任何遵從 Swift.Error
協(xié)議的對象乖阵,當然 Vapor 已經(jīng)為我們封裝好了幾個常用的 Error 來方便我們拋出異常。
drop.get("404") { request in
throw Abort.notFound
}
當我們請求這個地址的時候一般會看到一個 Vapor 默認提供的錯誤頁面预麸,還挺漂亮的瞪浸,如果不想用 Vapor 提供的默認錯誤頁面,我們可以從 drop.middleware
中移除 AbortMiddleware
并添加自己的實現(xiàn)即可吏祸。
Abort 枚舉在 Vapor 中定義如下:
public enum Abort: Swift.Error {
case badRequest
case notFound
case serverError
case custom(status: Status, message: String)
}
Status 枚舉了幾十個我們可能用到的 HTTP 狀態(tài)碼对蒲,如 200(.ok
)、 301(.movedPermanently
)、403(.forbidden
) ...
路由組
Vapor 提供了路由組的概念蹈矮,通常用來集中組織一組相同前綴砰逻,添加中間件,限制主機名泛鸟,或者集中管理的路由蝠咆,路由組有兩個類型:Group
和 Grouped
。
Group 通過一個閉包來收納旗下所有的路由北滥,讓它們有統(tǒng)一的路徑前綴刚操,示例如下:
drop.group("v1") { v1 in
v1.get("users") { request in
// get the users
}
}
Grouped 原理類似,只是形式上有所變化再芋,通過 drop.grouped()
方法返回一個 RouteGroup
對象來收納路由菊霜。
let v1 = drop.grouped("v1")
v1.get("users") { request in
// get the users
}
文章到此關(guān)于 Vapor 路由基本的內(nèi)容也差不多都介紹完畢了,當然這里講的可能并不全面济赎,示例代碼基本來自于官方文檔(感謝 ??)占卧,下一篇準備說說 Vapor 的模版引擎 Leaf。
之前開的坑在寫一個博客程序 NSPress联喘,如果大家有興趣歡迎討論。