Ext.data.Store

 

Ext.data.Store是EXT中用來進行數據交換和數據交互的標準中間件，無論是Grid還是ComboBox，都是通過它實現數據讀取、類型轉換、排序分頁和搜索等操作的。

Ext.data.Store中有一個Ext.data.Record數組，所有數據都存放在這些Ext.data. Record實例中，爲後面的讀取和修改操作做準備。

10.4.1　基本應用

在使用之前，首先要創建一個Ext.data.Store的實例，如下面的代碼所示。

var data = [

    ['boy', 0],

    ['girl', 1]

];

var store = new Ext.data.Store({

    proxy: new Ext.data.MemoryProxy(data),

    reader: new Ext.data.ArrayReader({}, PersonRecord)

});

store.load();

每個store最少需要兩個組件的支持，分別是proxy和reader，proxy用於從某個途徑讀取原始數據，reader用於將原始數據轉換成Record實例。

這裏我們使用的是Ext.data.MemoryProxy和Ext.data.ArrayReader，將data數組中的數據轉換成對應的幾個PersonRecord實例，然後放入store中。store創建完畢之後，執行store.load()實現這個轉換過程。

經過轉換之後，store裏的數據就可以提供給Grid或ComboBox使用了，這就是Ext.data. Store的最基本用法。

10.4.2　對數據進行排序

Ext.data.Store提供了一系列屬性和函數，利用它們對數據進行排序操作。

可以在創建Ext.data.Store時使用sortInfo參數指定排序的字段和排序方式，如下面的代碼所示。

var store = new Ext.data.Store({

    proxy: new Ext.data.MemoryProxy(data),

    reader: new Ext.data.ArrayReader({}, PersonRecord),

    sortInfo: {field: 'name', direction: 'DESC'}

});

這樣，在store加載數據之後，就會自動根據name字段進行降序排列。對store使用store.setDefaultSort('name','DESC');也會達到同樣效果。

也可以在任何時候調用sort()函數，比如store.sort('name', 'DESC');，對store中的數據進行排序。

如果我們希望獲得store的排序信息，可以調用getSortState()函數，返回的是類似{field: "name", direction: " DESC"}的JSON對象。

與排序相關的參數還有remoteSort，這個參數是用來實現後臺排序功能的。當設置爲remoteSort:true時，store會在向後臺請求數據時自動加入sort和dir兩個參數，分別對應排序的字段和排序的方式，由後臺獲取並處理這兩個參數，在後臺對所需數據進行排序操作。remoteSort:true也會導致每次執行sort()時都要去後臺重新加載數據，而不能只對本地數據進行排序。

詳細的用法可以參考第2章。

10.4.3　從store中獲取數據

從store中獲取數據有很多種途徑，可以依據不同的要求選擇不同的函數。最直接的方法是根據record在store中的行號獲得對應的record，得到了record就可以使用get()函數獲得裏面的數據了，如下面的代碼所示。

store.getAt(0).get('name')

通過這種方式，我們可以遍歷store中所有的record，依次得到它們的數據，如下面的代碼所示。

for (var i = 0; i < store.getCount(); i++) {

    var record = store.getAt(i);

    alert(record.get('name'));

}

Store.getCount()返回的是store中的所有數據記錄，然後使用for循環遍歷整個store，從而得到每條記錄。

除了使用getCount()的方法外，還可以使用each()函數，如下面的代碼所示。

store.each(function(record) {

    alert(record.get('name'));

});

Each()可以接受一個函數作爲參數，遍歷內部record，並將每個record作爲參數傳遞給function()處理。如果希望停止遍歷，可以讓function()返回false。

也可以使用getRange()函數連續獲得多個record，只需要指定開始和結束位置的索引值，如下面的代碼所示。

var records = store.getRange(0, 1);

for (var i = 0; i < records.length; i++) {

    var record = records[i];

    alert(record.get('name'));

}

如果確實不知道record的id，也可以根據record本身的id從store中獲得對應的record，如下面的代碼所示。

store.getById(1001).get('name')

EXT還提供了函數find()和findBy()，可以利用它們對store中的數據進行搜索，如下面的代碼所示。

find( String property, String/RegExp value, [Number startIndex], [Boolean anyMatch],

[Boolean caseSensitive] )

在這5個參數中，只有前兩個是必須的。第一個參數property代表搜索的字段名；第二個參數value是匹配用字符串或正則表達式；第三個參數startIndex表示從第幾行開始搜索，第四個參數anyMatch爲true時，不必從頭開始匹配；第五個參數caseSensitive爲true時，會區分大小寫。

如下面的代碼所示：

var index = store.find('name','g');

alert(store.getAt(index).get('name'));

與find()函數對應的findBy()函數的定義格式如下：

findBy( Function fn, [Object scope], [Number startIndex] ) : Number

findBy()函數允許用戶使用自定義函數對內部數據進行搜索。fn返回true時，表示查找成功，於是停止遍歷並返回行號。fn返回false時，表示查找失敗（即未找到），繼續遍歷，如下面的代碼所示。

index = store.findBy(function(record, id) {

    return record.get('name') == 'girl' && record.get('sex') == 1;

});

alert(store.getAt(index).get('name'));

通過findBy()函數，我們可以同時判斷record中的多個字段，在函數中實現複雜邏輯。

我們還可以使用query和queryBy函數對store中的數據進行查詢。與find和findBy不同的是，query和queryBy返回的是一個MixCollection對象，裏面包含了搜索得到的數據，如下面的代碼所示。

alert(store.query('name', 'boy'));

    alert(store.queryBy(function(record) {

        return record.get('name') == 'girl' && record.get('sex') == 1;

    }));

10.4.4　更新store中的數據

可以使用add(Ext.data.Record[] records)向store末尾添加一個或多個record，使用的參數可以是一個record實例，如下面的代碼所示。

store.add(new PersonRecord({

    name: 'other',

    sex: 0

}));

Add()的也可以添加一個record數組，如下面的代碼所示：

store.add([new PersonRecord({

    name: 'other1',

    sex: 0

}), new PersonRecord({

    name: 'other2',

    sex: 0

})]);

Add()函數每次都會將新數據添加到store的末尾，這就有可能破壞store原有的排序方式。如果希望根據store原來的排序方式將新數據插入到對應的位置，可以使用addSorted()函數。它會在添加新數據之後立即對store進行排序，這樣就可以保證store中的數據有序地顯示，如下面的代碼所示。

store.addSorted(new PersonRecord({

    name: 'lili',

    sex: 1

}));

store會根據排序信息查找這條record應該插入的索引位置，然後根據得到的索引位置插入數據，從而實現對整體進行排序。這個函數需要預先爲store設置本地排序，否則會不起作用。

如果希望自己指定數據插入的索引位置，可以使用insert()函數。它的第一個參數表示插入數據的索引位置，可以使用record實例或record實例的數組作爲參數，插入之後，後面的數據自動後移，如下面的代碼所示。

store.insert(3, new PersonRecord({

    name: 'other',

    sex: 0

}));

store.insert(3, [new PersonRecord({

    name: 'other1',

    sex: 0

}), new PersonRecord({

    name: 'other2',

    sex: 0

})]);

刪除操作可以使用remove()和removeAll()函數，它們分別可以刪除指定的record和清空整個store中的數據，如下面的代碼所示。

store.remove(store.getAt(0));

store.removeAll();

store中沒有專門提供修改某一行record的操作，我們需要先從store中獲取一個record。對這個record內部數據的修改會直接反映到store上，如下面的代碼所示。

store.getAt(0).set('name', 'xxxx');

修改record的內部數據之後有兩種選擇：執行rejectChanges()撤銷所有修改，將修改過的record恢復到原來的狀態；執行commitChanges()提交數據修改。在執行撤銷和提交操作之前，可以使用getModifiedRecords()獲得store中修改過的record數組。

與修改數據相關的參數是pruneModifiedRecords，如果將它設置爲true，當每次執行刪除或reload操作時，都會清空所有修改。這樣，在每次執行刪除或reload操作之後，getModifiedRecords()返回的就是一個空數組，否則仍然會得到上次修改過的record記錄。

10.4.5　加載及顯示數據

store創建好後，需要調用load()函數加載數據，加載成功後才能對store中的數據進行操作。load()調用的完整過程如下面的代碼所示。

store.load({

    params: {start:0,limit:20},

    callback: function(records, options, success){

        Ext.Msg.alert('info', '加載完畢');

    },

    scope: store,

    add: true

});

l    params是在store加載時發送的附加參數。

l    callback是加載完畢時執行的回調函數，它包含3個參數：records參數表示獲得的數據，options表示執行load()時傳遞的參數，success表示是否加載成功。

l    Scope用來指定回調函數執行時的作用域。

l    Add爲true時，load()得到的數據會添加在原來的store數據的末尾，否則會先清除之前的數據，再將得到的數據添加到store中。

一般來說，爲了對store中的數據進行初始化，load()函數只需要執行一次。如果用params參數指定了需要使用的參數，以後再次執行reload()重新加載數據時，store會自動使用上次load()中包含的params參數內容。

如果有一些需要固定傳遞的參數，也可以使用baseParams參數執行，它是一個JSON對象，裏面的數據會作爲參數發送給後臺處理，如下面的代碼所示。

store.baseParams.start = 0;

store.baseParams.limit = 20;

爲store加載數據之後，有時不需要把所有數據都顯示出來，這時可以使用函數filter和filterBy對store中的數據進行過濾，只顯示符合條件的部分，如下面的代碼所示。

filter( String field, String/RegExp value, [Boolean anyMatch], 
[Boolean caseSensitive] ) : void

filter()函數的用法與之前談到的find()相似，如下面的代碼所示。

store.filter('name', 'boy');

對應的filterBy()與findBy()類似，也可以在自定義的函數中實現各種複雜判斷，如下面的代碼所示。

store.filterBy(function(record) {

    return record.get('name') == 'girl' && record.get('sex') == 1;

});

如果想取消過濾並顯示所有數據，那麼可以調用clearFilter()函數，如下面的代碼所示。

store.clearFilter();

如果想知道store上是否設置了過濾器，可以通過isFiltered()函數進行判斷。

10.4.6　其他功能

除了上面提到的數據獲取、排序、更新、顯示等功能外，store還提供了其他一些功能函數。

collect( String dataIndex, [Boolean allowNull], [Boolean bypassFilter] ) : Array

collect函數獲得指定的dataIndex對應的那一列的數據，當allowNull參數爲true時，返回的結果中可能會包含null、undefined或空字符串，否則collect函數會自動將這些空數據過濾掉。當bypassFilter參數爲true時，collect的結果不會受查詢條件的影響，無論查詢條件是什麼都會忽略掉，返回的信息是所有的數據，如下面的代碼所示。

alert(store.collect('name'));

這樣會獲得所有name列的值，示例中返回的是包含了'boy'和'girl'的數組。

getTotalCount()用於在翻頁時獲得後臺傳遞過來的數據總數。如果沒有設置翻頁，get- TotalCount()的結果與getCount()相同，都是返回當前的數據總數，如下面的代碼所示。

alert(store.getTotalCount());

indexOf(Ext.data.Record record)和indexOfId(String id)函數根據record或record的id獲得record對應的行號，如下面的代碼所示。

alert(store.indexOf(store.getAt(1)));

alert(store.indexOfId(1001));

loadData(object data, [Boolean append])從本地JavaScript變量中讀取數據，append爲true時，將讀取的數據附加到原數據後，否則執行整體更新，如下面的代碼所示。

store.loadData(data, true);

Sum(String property, Number start, Number end):Number用於計算某一個列從start到end的總和，如下面的代碼所示。

alert(store.sum('sex'));

如果省略參數start和end，就計算全部數據的總和。

store還提供了一系列事件（見表10-1），讓我們可以爲對應操作設定操作函數。

表10-1　store提供的事件

事件名	參　　數
add	( Store this, Ext.data.Record[] records, Number index )
beforelaod	( Store this, Object options )
clear	( Store this )
datachanged	( Store this )
load	( Store this, Ext.data.Record[] records, Object options )
loadexception	()
metachange	( Store this, Object meta. )
remove	( Store this, Ext.data.Record record, Number index )
update	( Store this, Ext.data.Record record, String operation )

以上就是store和record