Vapor文档学习二十:FLUENT - Model

Model协议是你应用中任何model都赢准守的基础协议,尤其是持久化存储的模型。

Model只能在Vapor中使用,在Fluent中是使用Entity

Example

让我们创建一个简单的user模型:

final class User {
    var name: String

    init(name: String) {
        self.name = name
    }
}

要遵守Model协议,先要引入VaporFluent

import Vapor
import Fluent

然后遵守协议:

final class User: Model {
    ...
}

然后编辑器会通知你必须实现某些方法。

ID

第一个必须实现的就是id属性,数据库获取model都是通过id作为标识符。如果idnil,那么在数据保存的时候会自定设置id

final class User: Model {
    var id: Node?
    ...
}

Node Initializable

然后必须实现的就是将持久化存储数据创建为model的方法。Model是遵守了NodeRepresentable协议。

final class User: Model {
    init(node: Node, in context: Context) throws {
        id = try node.extract("id")
        name = try node.extract("name")
    }
    ...
}

idname是数据库中存储的字段或者我们需要的列。使用try来调用extract是因为在字段不存在或者字段类型不正确的情况下会抛出异常。

Node Representable

现在已经介绍了如何初始化模型,那我们来看看如何将模型保存到数据库中。我们借助NodeRepresentable协议实现。

final class User: Model {
    func makeNode(context: Context) throws -> Node {
        return try Node(node: [
            "id": id,
            "name": name
        ])
    }
    ...
}

当User被保存的时候就会调用makeNode方法,并且将Node保存到数据库中。idname就是我们希望保存的列的名称或者是在数据库中的字段名。

通常情况下,你不需要关心makeNode(context :)方法的context参数。 它是协议的一部分,允许在更高级或特定场景中进行扩展。

Preparations

一些数据库,像MySQL,需要对新的模式做准备。在MySQL中这意味着需要创建新的表。Preparations相当于迁移,因为它允许修改已经创建的模式。

Prepare

假设我们正在使用SQL数据库。 要为我们的User类准备数据库,我们需要创建一个表。 如果您使用的是像Mongo这样的数据库,您可以不识闲此方法。

final class User {
    static func prepare(_ database: Database) throws {
        try database.create("users") { users in
            users.id()
            users.string("name")
        }
    }
    ...
}

我们创建了一个users表,具有idname两个字段,这与init(node: Node)makeNode() -> Node方法相匹配。

Revert

当调用vapor run prepare --revert指令时,就会创建一个可选的可还原的preparation

final class User {
    static func revert(_ database: Database) throws {
        try database.delete("users")
    }
    ...
}

这样就删除了users

Preparations as Migrations

在情景初始化之后,如果你想向表中插入一个字段,你只需要创建一个遵守Preparation协议的类或结构体:

struct AddFooToBar: Preparation {
    static func prepare(_ database: Database) throws {
        try database.modify("bars", closure: { bar in
            bar.string("foo", length: 150, optional: false, unique: false, default: nil)
        })
    }

    static func revert(_ database: Database) throws {

    }
}

设置Droplet的时候添加一行代码:drop.preparations.append(AddFooToBar.self)

Droplet

为了启动应用的时候运行这些preparations, 你必须将Model添加到Droplet中。

let drop = Droplet()

drop.preparations.append(User.self)

Note:Preparations必须在drop.run()之前添加。

Full Model

看一下我们最终完成的User模型:

import Vapor
import Fluent

final class User: Model {
    var id: Node?
    var name: String

    init(name: String) {
        self.name = name
    }

    init(node: Node, in context: Context) throws {
        id = try node.extract("id")
        name = try node.extract("name")
    }

    func makeNode(context: Context) throws -> Node {
        return try Node(node: [
            "id": id,
            "name": name
        ])
    }

    static func prepare(_ database: Database) throws {
        try database.create("users") { users in
            users.id()
            users.string("name")
        }
    }

    static func revert(_ database: Database) throws {
        try database.delete("users")
    }
}

Interacting

现在User遵守了Model协议,然后添加了许多新的方法,比如find()query()makeJSON()等等。

Fetch

通过数据库id查询Model:

let user = try User.find(42)
Save

新创建的数据模型可以保存到数据库:

var user = User(name: "Vapor")
try user.save()
print(user.id) // prints the new id
Delete

持久存储的模型可以被删除:

try user.delete()

Model vs. Entity

Model遵守了几个额外的协议,而一个纯粹的Entity没有。

public protocol Model: Entity, JSONRepresentable, StringInitializable, ResponseRepresentable {}

通过以上协议,Model可以自动转化为JSONResponse对象,并且可以用在类型安全的路由上。

Options

改变 table/collection 名称:

static var entity = "new_name"

</br>
<b>总结:</b>本章通过User模型介绍了数据模型Model的创建与使用,并介绍了数据备份的方法。

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

推荐阅读更多精彩内容