前言
上一篇我们初步了解了Droplet和Route,本篇中我们一起写一些简单的get和post请求,以及我总结的一些套路。因为本人也是初学,没有任何后端开发经验,所有难免出现错误,大虾们多多指正。
常见请求
get/post请求
返回字符串
drop.get("get","string") { req in
return "Hello, world!"
}
返回JSON
drop.get("get","json") { req in
var json = JSON()
try json.set("hello", "world")
return json
}
获取request中数据
drop.get("get","info") { req in
var json = JSON()
let name = req.data["name"]?.string
let age = req.data["age"]?.int
let isVip = req.data["isVip"]?.bool
try json.set("name", name)
try json.set("age", age)
try json.set("isVip", isVip)
return json
}
post请求同上处理。
项目路由处理常见套路
单一文件
demo或者测试项目中业务逻辑很少,不需要统一管理时,所有的路由直接写main.swift
中就可以了。
如: main.swift
let config = try Config()
try config.setup()
let drop = try Droplet(config)
// 注册路由
// get 示例
drop.get("welcome") { request in
return "Hello"
}
// post 示例
drop.post("form") { request in
return "Submitted with a POST request"
}
// 路由组 示例 1
drop.group("v1") { v1 in
// get
v1.get("users") { request in
// get the users
}
// post
drop.post("form") { request in
return "Submitted with a POST request"
}
}
// 路由组 示例 2
let v1 = drop.grouped("v1")
// get
v1.get("users") { request in
// get the users
}
// post
v1.post("form") { request in
return "Submitted with a POST request"
}
// 运行
try drop.run()
vapor模板中的实现
当直接使用vapor new Hello --template=api
创建一个名为“hello”的vapor默认的模板项目时,内部已经存在了部分样板代码。
具体就是通过给Config
、Droplet
添加extension,在extension中实现路由注册。具体代码参考Sources/App/Setup/
目录下Config+Setup.swift
和Droplet+Setup.swift
文件。
在Droplet+Setup.swift
实现一个setup
方法去注册路由
extension Droplet {
public func setup() throws {
try setupRoutes()
// Do any additional droplet setup
}
func setupRoutes() throws {
get("hello") { req in
var json = JSON()
try json.set("hello", "world")
return json
}
post("posttest") { req in
}
}
}
工具类统一注册路由
通过一个工具类如:RouteTool、Router 等等(命名随意),来统一注册路由,以MVC的方式搭建项目。
首先在main.swift
中,我们定义全局变量api
、v1
、v2
等(根据实际需求)管理路由组。如:
let config = try Config()
try config.setup()
let drop = try Droplet(config)
/// 基础api
let api = drop.grouped("api")
let v1 = api.grouped("v1")
let v2 = api.grouped("v2")
/// 路由
RouteTool.setUp()
try drop.run()
然后如上述代码中RouteTool.setUp()
,我们创建一个路由工具RouteTool
,并为其实现一个setUp
方法来为不同的控制器统一注册路由。示例:
struct RouteTool {
static func setUp() {
// 注册业务
SignController().registeredRouting()
// 用户业务
UserController().registeredRouting()
// 验证码
VerifyCodeController().registeredRouting()
// 评论业务
CommentController().registeredRouting()
···等等
}
}
然后我们在具体的控制器里,完成路由注册、数据请求的具体实现。比如我们创建SignUpController,用来处理用户注册的业务。
在SignUpController.swift
中,我们实现处理请求。方法内部的业务代码此处使用...
省略,并非本篇重点。
class SignController {
// 对外提供统一注册路由的方法
public func registeredRouting() {
v1.post("signup", handler: self.signup)
v1.post("password","reset", handler: self.resetPassWord)
v1.post("password","change", handler: self.changePassWord)
}
// 用户注册
func signup(_ request: Request) throws -> ResponseRepresentable {
...
}
// 重置密码
func resetPassWord(_ request: Request) throws -> ResponseRepresentable {
...
}
// 更改密码
func changePassWord(_ request: Request) throws -> ResponseRepresentable {
...
}
...等等其他业务
}
通过RouteCollection协议来注册路由组
同样的,我们使用上一节中的SignController
作代码示例。遵守RouteCollection
协议并实现func build(_ builder: RouteBuilder)
协议方法。
class SignController: RouteCollection {
func build(_ builder: RouteBuilder) throws {
let api = builder.grouped("api")
let v1 = api.grouped("v1")
v1.post("signup", handler: self.signUp)
v1.post("password","reset", handler: self.resetPassWord)
v1.post("password","change", handler: self.changePassWord)
}
// 用户注册
func signup(_ request: Request) throws -> ResponseRepresentable {
...
}
// 重置密码
func resetPassWord(_ request: Request) throws -> ResponseRepresentable {
...
}
// 更改密码
func changePassWord(_ request: Request) throws -> ResponseRepresentable {
...
}
...等等其他业务
}
这时候我们就可以在main.swift
中通过collection(<#T##c: (EmptyInitializable & RouteCollection).Protocol##(EmptyInitializable & RouteCollection).Protocol#>)
来注册路由组了。
let config = try Config()
try config.setup()
let drop = try Droplet(config)
// 注册路由组
let signVC = SignController()
drop.collection(signVC)
try drop.run()
我们也可以为控制器实现一个extension并遵守EmptyInitializable
协议,这样做的目的是注册路由时我们无需实例化该控制器。
extension SignController: EmptyInitializable { }
此时我们在以上注册路由组的示例代码中就不需要实例化SignController了。
drop.collection(SignController.self)
最后
本篇是我在阅读文档和其他开源项目时总结的一些小套路,毕竟我也没有后端开发经验,文中若出现错误,欢迎批评指正。