英文原文:http://emberjs.com/guides/models/defining-models/
模型是一个定义了需要呈现给用户的数据的属性和行为的类。任何用户往返于应用(或者刷新页面)能看到的内容都需要使用模型来表示。
应用中所有的模型,都继承与DS.Model
:
App.Person = DS.Model.extend();
在定义了一个模型类之后,就可以开始查询或者创建一个属于这个类型的记录。当与仓库进行交互时,需要使用模型的名称来指定记录的类型。例如,仓库的find()
方法需要一个字符串类型的值作为第一个参数,用于指定需要查询的记录类型:
store.find('person', 1);
下表说明了模型名称是如何映射到模型的类的。
模型名称 | 模型类 |
---|---|
photo |
App.Photo |
adminUserProfile |
App.AdminUserProfile |
定义属性
模型的属性是通过DS.attr
来进行声明的。
var attr = DS.attr;
App.Person = DS.Model.extend({
firstName: attr(),
lastName: attr(),
birthday: attr()
});
属性主要由两个作用,其一是用于转换从服务器返回的JSON数据到记录;其二是序列化一个被修改的记录,将其变动保存到服务器端。
属性(Attribute)可以跟其他属性(Property)一样看待,包括计算属性。应用中经常需要使用计算属性来联合或者转换一个原生属性(Attribute)的值。
var attr = DS.attr;
App.Person = DS.Model.extend({
firstName: attr(),
lastName: attr(),
fullName: function() {
return this.get('firstName') + ' ' + this.get('lastName');
}.property('firstName', 'lastName')
});
关于如何为类添加计算属性,可以参看计算属性。
如果没有指定属性的类型,属性类型与服务器端返回的保持一致。可以通过attr
设定属性的类型type
,来确保将服务器返回的数据强制转换为指定的类型。
App.Person = DS.Model.extend({
birthday: DS.attr('date')
});
默认情况下,REST 适配器支持的属性类型有string
, number
, boolean
和date
。
传统的适配器会提供额外的属性类型,并支持你注册自定义的属性类型。
详情请查看documentation section on the REST Adapter。
选项
DS.attr
第二个参数是一个可选的哈希对象,当前支持的选项是:
defaultValue
:传入一个字符串或者将被调用来设置属性的初始值的函数。示例
var attr = DS.attr;
App.User = DS.Model.extend({
username: attr('string'),
email: attr('string'),
verified: attr('boolean', {defaultValue: false}),
createdAt: DS.attr('string', {
defaultValue: function() { return new Date(); }
})
});
定义关联模型
Ember Data 包括了几个内置的关联类型,以帮助你确定你的模型如何相互关联的。
一对一
使用DS.belongsTo
在两个模型间声明一对一的关系。
App.User = DS.Model.extend({
profile: DS.belongsTo('profile')
});
App.Profile = DS.Model.extend({
user: DS.belongsTo('user')
});
一对多
使用DS.belongsTo
结合DS.hasMany
来声明两个模型间的一对多关系,示例如下:
App.Post = DS.Model.extend({
comments: DS.hasMany('comment')
});
App.Comment = DS.Model.extend({
post: DS.belongsTo('post')
});
多对多
使用DS.hasMany
来声明两个模型间的多对多关系。
App.Post = DS.Model.extend({
tags: DS.hasMany('tag')
});
App.Tag = DS.Model.extend({
posts: DS.hasMany('post')
});
显式反转
Ember
Data会尽最大努力去自动发现关联关系的映射关系。在上例的一对多的情况下,修改了comments
会自动更新post
,应为这是唯一的一个关联模型。
但是,有时候对同一个类型有多个belongsTo
/hasMany
关联关系。这时可以通过指定在反向端使用DS.hasMany
的inverse
选项来指定其关联的模型:
var belongsTo = DS.belongsTo,
hasMany = DS.hasMany;
App.Comment = DS.Model.extend({
onePost: belongsTo("post"),
twoPost: belongsTo("post"),
redPost: belongsTo("post"),
bluePost: belongsTo("post")
});
App.Post = DS.Model.extend({
comments: hasMany('comment', {
inverse: 'redPost'
})
});
当然也可以在belongsTo
一侧指定,它将按照预期那样工作。