Model
Model是任何应用程序模型的基本协议，特别是要持久化的模型。
Model仅适用于Vapor，在Fluent里等价于Entity
Example
我们来创建一个简单的用户模型
final class User {
var name: String
init(name: String) {
self.name = name
}
}
符合模型的第一步要导入Vapor和Fluent。
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")
}
...
}
id和name是我们预期数据库中的列或字段而被命名的。提取调用方法被标记为尝试，因为如果值不存在或者错误类型，它将抛出错误。
Node Representable
现在我们已经涵盖了初始化模型。我们需要显示如何将其保存回数据库。模型使用NodeRepresentable来实现这一点。
final class User: Model {
func makeNode(context: Context) throws -> Node {
return try Node(node: [
"id": id,
"name": name
])
}
...
}
保存用户时，将调用makeNode()方法，并将生成的节点保存到数据库。id和name是我们预期数据库中的列或字段而被命名的。
在大多数情况下，不需要关心
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
模型有几个额外的一致性而Fluent的Entity就没有。
public protocol Model: Entity, JSONRepresentable, StringInitializable, ResponseRepresentable {}
从协议中可以看出，Vapor的Model自动转换为JSON,Response，甚至可以用于类型安全路由。
Options
更改表/集合名称.
static var entity = "new_name"
继续学习vapor学习教程-目录
网友评论