Backbone 裡最基礎的概念就是 Model。它有點像後端開發中數據庫映射的那個 model,是數據對象的模型,並且通常會與後端 model 保持相同的屬性(僅限需要通過前端操作的部分)。
先搭一個最簡單的 HTML 頁面:
<!DOCTYPE html>
<html>
<head>
<title>the5fire-backbone-model</title>
</head>
<body>
</body>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js"></script>
<script src="https://ajax.cdnjs.com/ajax/libs/underscore.js/1.1.4/underscore-min.js"></script>
<script src="https://ajax.cdnjs.com/ajax/libs/backbone.js/0.3.3/backbone-min.js"></script>
<script>
(function ($) {
/**
* 此處填充代碼
**/
})(jQuery);
</script>
</html>
接下來的代碼都填到 script 標籤中的那個 function 裡。
Man = Backbone.Model.extend({
initialize: function(){
alert('Hey, you create me!');
}
});
var man = new Man;
沒有定義任何屬性,只有一個初始化方法,也就是構造函數。
第一種是直接定義默認值:
Man = Backbone.Model.extend({
initialize: function(){
alert('Hey, you create me!');
},
defaults: {
name:'張三',
age: '38'
}
});
var man = new Man;
alert(man.get('name'));
第二種是在賦值時定義:
Man = Backbone.Model.extend({
initialize: function(){
alert('Hey, you create me!');
}
});
man.set({name:'the5fire',age:'10'});
alert(man.get('name'));
取值一律用 get。
Man = Backbone.Model.extend({
initialize: function(){
alert('Hey, you create me!');
},
defaults: {
name:'張三',
age: '38'
},
aboutMe: function(){
return '我叫' + this.get('name') + ',今年' + this.get('age') + '歲';
}
});
var man = new Man;
alert(man.aboutMe());
Man = Backbone.Model.extend({
initialize: function(){
alert('Hey, you create me!');
// 初始化時綁定監聽
this.bind("change:name",function(){
var name = this.get("name");
alert("你改變了 name 屬性為:" + name);
});
},
defaults: {
name:'張三',
age: '38'
},
aboutMe: function(){
return '我叫' + this.get('name') + ',今年' + this.get('age') + '歲';
}
});
var man = new Man;
man.set({name:'the5fire'}) // 觸發綁定的 change 事件
Man = Backbone.Model.extend({
initialize: function(){
alert('Hey, you create me!');
this.bind("change:name",function(){
var name = this.get("name");
alert("你改變了 name 屬性為:" + name);
});
this.bind("error",function(model,error){
alert(error);
});
},
defaults: {
name:'張三',
age: '38'
},
validate:function(attributes){
if(attributes.name == '') {
return "name 不能為空!";
}
},
aboutMe: function(){
return '我叫' + this.get('name') + ',今年' + this.get('age') + '歲';
}
});
var man = new Man;
man.set({name:''}); // 根據驗證規則彈出錯誤提示
首先需要為對象定義一個 url 屬性,調用 save 時會把對象的所有屬性 POST 到服務端。
Man = Backbone.Model.extend({
url:'/save/',
initialize: function(){
alert('Hey, you create me!');
this.bind("change:name",function(){
var name = this.get("name");
alert("你改變了 name 屬性為:" + name);
});
this.bind("error",function(model,error){
alert(error);
});
},
defaults: {
name:'張三',
age: '38'
},
validate:function(attributes){
if(attributes.name == '') {
return "name 不能為空!";
}
},
aboutMe: function(){
return '我叫' + this.get('name') + ',今年' + this.get('age') + '歲';
}
});
var man = new Man;
man.set({name:'the5fire'});
man.save(); // 會發送 POST 到模型對應的 url,數據格式為 json {"name":"the5fire","age":38}
// 從服務器端獲取數據使用 fetch([options])
var man1 = new Man;
// 第一種情況:直接使用 fetch,會發送 get 請求到 model 的 url
// 服務器端可以通過判斷是 get 還是 post 進行對應操作
man1.fetch();
// 第二種情況:在 fetch 中加入參數
man1.fetch({url:'/getmans/'});
// 這樣會發送 get 請求到 /getmans/
// 服務器返回的結果應是對應的 json 格式數據,同 save 時 POST 過去的格式
// 接受服務器端返回數據的寫法
man1.fetch({url:'/getmans/',success:function(model,response){
alert('success');
// model 為獲取到的數據
alert(model.get('name'));
},error:function(){
// 當返回格式不正確或者是非 json 數據時,會執行此方法
alert('error');
}});
補充一點:所有異步操作都由 Backbone.sync 完成,調用時它會自動傳入一個參數,據此向服務端發送對應請求。比如 save 時,Backbone 會判斷對象是否為新建——新建則參數為 create,已存在只是修改則為 update;fetch 對應 read,destroy 對應 delete。這就是所謂的 CRUD,四種參數對應的請求類型分別是 POST、GET、PUT、DELETE。服務端可以依據這個 request 類型執行相應操作。
關於 url 與 urlRoot:如果只設置 url,那麼所有 CRUD 都會打到同一個地址上,問題是 delete 請求雖然發了,卻沒帶任何數據,服務端無從知道要刪哪條記錄。因此又引入了 urlRoot——設置它之後,PUT 和 DELETE 請求的地址會變成 /baseurl/[model.id],服務端通過解析 url 後段的值即可定位並更新或刪除對應記錄。
Collection 是 model 對象的有序集合,概念很好理解,看例子更直觀。
Book = Backbone.Model.extend({
defaults : {
// 感謝網友藍色動力指正,改為 defaults
title:'default'
},
initialize: function(){
//alert('Hey, you create me!');
}
});
BookShelf = Backbone.Collection.extend({
model : Book
});
var book1 = new Book({title : 'book1'});
var book2 = new Book({title : 'book2'});
var book3 = new Book({title : 'book3'});
// 注意建構時傳入的是數組,或者使用 add
// var bookShelf = new BookShelf([book1, book2, book3]);
var bookShelf = new BookShelf;
bookShelf.add(book1);
bookShelf.add(book2);
bookShelf.add(book3);
bookShelf.remove(book3);
// 基於 underscore 這個 js 庫,還可以使用 each 遍歷
bookShelf.each(function(book){
alert(book.get('title'));
});
要在 BookShelf 中定義 url(注意 collection 沒有 urlRoot 屬性),或者直接在 fetch 方法裡指定:
bookShelf.fetch({url:'/getbooks/',success:function(collection,response){
collection.each(function(book){
alert(book.get('title'));
});
},error:function(){
alert('error');
}});
返回正確格式的數據會調用 success,錯誤格式則調用 error,error 也可以接同樣的形參。對應的返回格式為:[{'title':'book1'},{'title':'book2'}.....]
collection 在 fetch 到數據之後會調用 reset,因此需要在 collection 中定義或綁定 reset 方法。這裡用綁定演示:
bookShelf.bind('reset', showAllBooks);
showAllBooks = function(){
bookShelf.each(function(book){
// 將 book 數據渲染到頁面
});
}
綁定步驟要在 fetch 之前完成。
<!DOCTYPE html>
<html>
<head>
<title>the5fire-backbone-collection</title>
</head>
<body>
</body>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js"></script>
<script src="https://ajax.cdnjs.com/ajax/libs/underscore.js/1.1.4/underscore-min.js"></script>
<script src="https://ajax.cdnjs.com/ajax/libs/backbone.js/0.3.3/backbone-min.js"></script>
<script>
(function ($) {
// collection 是一個簡單的 models 的有序集合
// 1、一個簡單的例子
Book = Backbone.Model.extend({
defaults : {
title:'default'
},
initialize: function(){
//alert('Hey, you create me!');
}
});
BookShelf = Backbone.Collection.extend({
model : Book
});
var book1 = new Book({title : 'book1'});
var book2 = new Book({title : 'book2'});
var book3 = new Book({title : 'book3'});
var bookShelf = new BookShelf;
bookShelf.add(book1);
bookShelf.add(book2);
bookShelf.add(book3);
bookShelf.remove(book3);
bookShelf.each(function(book){
alert(book.get('title'));
});
// 2、使用 fetch 從服務器端獲取數據,使用 reset 渲染
bookShelf.bind('reset', showAllBooks);
bookShelf.fetch({url:'/getbooks/',success:function(collection,response){
collection.each(function(book){
alert(book.get('title'));
});
},error:function(){
alert('error');
}});
showAllBooks = function(){
bookShelf.each(function(book){
// 將 book 數據渲染到頁面
});
}
})(jQuery);
</script>
</html>
這份代碼需要服務端配合才能完整跑通。總結一下要點:Model 負責單條數據的封裝、驗證與同步,Collection 負責一組模型的管理與批量加載,二者通過 Backbone.sync 與 url/urlRoot 約定和後端打交道。