vapor学习教程-Model

Model


Model是任何应用程序模型的基本协议,特别是要持久化的模型。

Model仅适用于Vapor,在Fluent里等价于Entity

Example


我们来创建一个简单的用户模型

final class User {
    var name: String

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

符合模型的第一步要导入VaporFluent

import Vapor
import Fluent

然后添加一致性到你的类。

final class User: Model {
    ...
}

接着编译器通知你需要实现一些方法。

ID


第一个必需属性是一个标识符。当从数据库中获取模型时,此属性将包含标识符。如果为nil,则保存模型时将被设置。

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

Node Initializable


下一个要求是从持久化数据创建模型的方法。模型使用NodeInitializable来实现这一点。

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

idname是我们预期数据库中的列或字段而被命名的。提取调用方法被标记为尝试,因为如果值不存在或者错误类型,它将抛出错误。

Node Representable


现在我们已经涵盖了初始化模型。我们需要显示如何将其保存回数据库。模型使用NodeRepresentable来实现这一点。

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

保存用户时,将调用makeNode()方法,并将生成的节点保存到数据库。idname是我们预期数据库中的列或字段而被命名的。

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

Preparations


一些数据库(如MySQL)需要为新模式做好准备。在MySQL中,这意味着创建一个新的表。准备工作也等同于迁移,因为它们可以用于在已创建模式之后更改模式。

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的表,该表具有一个标识符字段和一个具有键名称name的字符串字段。这与init(node:Node)makeNode() - > Node方法相匹配。

Revert


可以创建可选的准备还原。如果vapor run prepare --revert被调用,则这个将被执行。

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


要在应用程序引导时运行这些准备工作,必须将Model添加到Droplet

let drop = Droplet()
drop.preparations.append(User.self)

注意:在Droplet运行前必须附上准备工作。

Full Model


这就是最终的users模型:

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


现在users符合Model,它有很多新的方法,如find()query()makeJSON()等等。

Fetch


Models can be fetched by their database identifier
中文(简体)
模型可以通过其数据库标识符获取

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


模型有几个额外的一致性而FluentEntity就没有。

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

从协议中可以看出,VaporModel自动转换为JSON,Response,甚至可以用于类型安全路由。

Options


更改表/集合名称.

static var entity = "new_name"

继续学习vapor学习教程-目录

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

推荐阅读更多精彩内容