Vapor文档学习二十：FLUENT - Model

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

Model只能在Vapor中使用，在Fluent中是使用Entity。

Example

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

final class User {
    var name: String

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

要遵守Model协议，先要引入Vapor和Fluent。

import Vapor
import Fluent

然后遵守协议：

final class User: Model {
    ...
}

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

ID

第一个必须实现的就是id属性，数据库获取model都是通过id作为标识符。如果id为nil，那么在数据保存的时候会自定设置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")
    }
    ...
}

id和name是数据库中存储的字段或者我们需要的列。使用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保存到数据库中。id和name就是我们希望保存的列的名称或者是在数据库中的字段名。

通常情况下，你不需要关心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表，具有id和name两个字段，这与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可以自动转化为JSON，Response对象，并且可以用在类型安全的路由上。

Options

改变 table/collection 名称：

static var entity = "new_name"

Vapor文档学习二十：FLUENT - Model