使用Swift4+Vapor写后端-示例&套路

前言

上一篇我们初步了解了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默认的模板项目时,内部已经存在了部分样板代码。
具体就是通过给ConfigDroplet添加extension,在extension中实现路由注册。具体代码参考Sources/App/Setup/目录下Config+Setup.swiftDroplet+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中,我们定义全局变量apiv1v2等(根据实际需求)管理路由组。如:

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)

最后

本篇是我在阅读文档和其他开源项目时总结的一些小套路,毕竟我也没有后端开发经验,文中若出现错误,欢迎批评指正。

相关参考

vapor文档

开源项目SRSQ

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

推荐阅读更多精彩内容