Vapor 2.0 - 控制器(Controllers)

前往 Vapor 2.0 - 文档目录

控制器帮助您将相关的功能组织到一个地方。它们还可以用于创建RESTful资源。

基本(Basic)

一个基本的控制器看起来像下面这样:

import Vapor
import HTTP

final class HelloController {
    func sayHello(_ req: Request) throws -> ResponseRepresentable {
        guard let name = req.data["name"]?.string else { 
            throw Abort(.badRequest)
        }

        return "Hello, \(name)"
    }
}

简单的控制器不需要遵守任何协议。你可以自由地设计它们,只要你认为合适。

注册(Registering)

唯一需要的结构是控制器中每个方法的签名。为了将这个方法注册到路由器中,它必须有一个签名,(Request) throws -> ResponseRepresentable。通过导入HTTP模块,可以获得请求(Request)和响应(ResponseRepresentable)。

import Vapor
let drop = try Droplet()

let hc = HelloController()
drop.get("hello", handler: hc.sayHello)

由于sayHello”方法的签名与drop.get方法的闭包签名相匹配,我们可以直接传递它。

类型安全(Type Safe)

您还可以使用带有类型安全路由的控制器方法。

final class HelloController {
    ...

    func sayHelloAlternate(_ req: Request) -> ResponseRepresentable {
        let name: String = try req.parameters.next(String.self)
        return "Hello, \(name)"
    }
}

我们在HelloController中添加一个名为sayHelloAlternate的新方法,从请求的参数中获取一个String

let hc = HelloController()
drop.get("hello", String.parameter, handler: hc.sayHelloAlternate)

由于dropget接受了一个签名(Request) throws -> ResponseRepresentable,我们的方法现在可以作为这条路线的终止。

笔记
在路由参数(Routing Parameters)部分阅读更多关于类型安全路由的信息。

资源(Resources)

符合ResourceRepresentable的控制器可以很容易地作为一个RESTful资源被注册到路由器。让我们来看一个UserController的例子。

final class UserController {
    func index(_ req: Request) throws -> ResponseRepresentable {
        return try User.all().makeJSON()
    }

    func show(_ req: Request) throws -> ResponseRepresentable {
        let user = try req.parameters.next(User.self)
        return user
    }
}

这是一个典型的用户控制器,它有一个indexshow路径。索引返回所有用户的JSON列表,并显示返回单个用户的JSON数据。

我们可以像这样注册控制器:

let users = UserController()
drop.get("users", handler: users.index)
drop.get("users", User.self, handler: users.show)

但是,ResourceRepresentable使得这种标准的RESTful结构很容易。

extension UserController: ResourceRepresentable {
    func makeResource() -> Resource<User> {
        return Resource(
            index: index,
            show: show
        )
    }
}

符合ResourceRepresentableUserController需要indexshow方法的签名与Resource<User>的期望相匹配。

现在,UserController可以满足ResourceRepresentable的需要,注册路由很容易。

let users = UserController()
drop.resource("users", users)

drop.resource将只负责注册由调用makeResource()所提供的路由。在这种情况下,只提供indexshow路径。

Note
drop.resource还为选择项(OPTIONS)请求增加了有用的缺省值。这些可以被重载。

行动(Actions)

下面是一个描述所有可用操作的表。

Action Method Path Note
index GET /users Returns all users, optionally filtered by the request data.
store POST /users Creates a new user from the request data.
show GET /users/:id Returns the user with the ID supplied in the path.
replace PUT /users/:id Updates the specified user, setting any fields not present in the request data to nil.
update PATCH /users/:id Updates the specified user, only modifying fields present in the request data.
delete DELETE /users/:id Deletes the specified user.
clear DELETE /users Deletes all users, optionally filtered by the request data.
create GET /users/create Displays a form for creating a new user.
edit GET /users/:id/edit Displays a form for editing the specified user.

提示
replaceupdate之间的差异是很微妙但很重要的:如果请求数据中不存在某个字段(例如,用户的年龄丢失了),update应该不会更新该字段,因为replace应该将其设置为nil。如果replace请求中缺少所需的数据,则应该抛出一个错误。

文件夹(Folder)

控制器可以在应用程序的任何地方进行,但它们通常存储在应用App/Controllers/目录中。

提示
如果您正在构建一个大型应用程序,您可能希望在一个单独的模块中创建控制器。这将允许您在控制器上执行单元测试。

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

推荐阅读更多精彩内容