ExtJs--数据存储与传输Store Record Connection

**Ext.data命名空间下常用组件简介
**    Ext.data在命名空间中定义了一系列store、reader和proxy。表格和ComboBox都是以Ext.data为媒介获取数据的,它包含异步加载、类型转换、分页等功能。Ext.data默认支持Array、JSON、XML等数据格式,可以通过Memory、HTTP、ScriptTag等方式获得这些格式的数据。如果要实现新的协议和新的数据结构,只需要扩展reader和proxy即可。DWRProxy就实现了自身的proxy和reader.让EXT可以直接从DWR获得数据。
**1. Ext.data.Connection
**    Ext.data.Connection是对Ext.lib.Ajax的封装,它提供了配置使用Ajax昀通用方式,在内部通过EXt.lib.Ajax实现与后台的异步调用。与底层的Ext.lib.Ajax相比Ext.data.Connection提供了更简洁的配置方式,使用起来更方便。
Ext.data.Connection主要用于在Ext.data.HttpProxy和Ext.data.ScriptTagProxy中执行与后台交互的任务,它会从指定的URL获得数据,并把后台返回的数据交给HUpProxy或ScriptTagProxy处理。Ext.data.Connection的使用方式:

var conn = new Ext.data.Connection({   
     autoAbort:false,   
     defaultHeaders:{   
         referer:'http://www.jcodecraeer.com'
     },   
     disableCaching:false,   
     extraParams:{   
         name:'name'
     },   
    method:'GET',   
    timeout:300,   
    url:'01-01.txt'
});

    在使用Ext.data.Connection之前,都要像上面这样创建一个新的Ext.Connection实例。可以在构造方法里配置对应的参数,比如autoAbort表示链接是否会自动断开、def aultHeaders参数表示请求的默认首部信息、disableCaching参数表示请求是否会禁用缓存、extraParams参数代表请求的额外参数、method参数表示请求方法、timeout参数表示连接的超时时间、url参数表示请求访问的网址等。
在创建了conn之后.可以调用request()函数发送请求,处理返回的结果,如下面的代码所示:

conn.request({    
    success:function(response){    
        Ext.Msg.alert('info',response.responseText);    
    },    
    failure:function(){    
        Ext.Msg.alert('warn','failure');    
    }    
});

Request()函数中可以设置success和failure两个回调函数,分别在请求成功和请求失败时调用.请求成功时.success函数的参数就是后台返回的信息。
下面来看一下request函数中的其他参数。

url:String: 请求url。  
params:Object/String/Function: 请求传递的参数。  
methos:String:请求方法,通常为GET或POST   
callback:Function:请求完成后的回调函数,无论是否成功还是失败,都会执行。   
success:Function:请求成功时的回调函数。   
failure:Function:请求失败时的回调函数。   
scope:Object:回调函数的作用域。   
form:Object:绑定的form表单。   
isUpload:Boolean:是否执行文件上传。  
headers:Object:请求首部信息   
xmlData:Object:XML文档对象,可以通过URL附加参数的方式发起请求。   
disableCaching:Boolean:是否禁用缓存,默认为禁用。   

    Ext.data.Connection还提供了abort([Number transactionId]函数),当同时有多个请求发生时,根据指定的事务id放弃其中的某一个请求。如果不指定事务id,就会放弃最后一个请求。isLoading(Number transactionId)函数的用法与abort()类似,可以根据事务id判断对应的请求是否完成。如果未指定事务id,就判断最后一个请求是否完成。

**2.Ext.data.Record
**
Ext.data.Record就是一个设定了内部数据类型的对象,它是Ext.data.Store的最基本组成部分。如果Ext.data.Store看作是二维表,那么它的每一行就对应一个Ext.data.Record实例。   

    Ext.data.Record的主要功能是保存数据,并旦在内部数据发生改变时记录修改的状态,它还可以保留修改之前的原始值。
使用Ext.data.Record时通常都是由create()函数开始的,首先用create()函数创建一个自定义的Record类型,如下面的代码所示:

var PersonRecord = Ext.data.Record.create({  
     {name:'name',type:'string'},  
     {name:'sex',type:'int'}  
 });

    PersonRecord就是我们定义的新类型,包含字符串类型的name和整数类型的sex两个属性,然后使用new关键字创建PersonRecord的实例,如下面的代码所示:

var boy = new PersonRecord({  
     name:'boy',  
     sex:0  
 });

    创建对象时,可以直接通过构造方法为对象赋予初始值,将‘boy’赋值给name,0赋值给sex。
现在,我们得到了PersonRecord的实例boy。如何才能得到它的属性呢?以下3种方式都可以获得boy中name属性的数据,如下面的代码所示:

alert(boy.data.name);  
alert(boy.data\['name'\]);  
alert(boy.get('name'));

    这里涉及Ext.data.Record的data属性,这是定义在Ext.data.Record中的一个公共属性,用于保存当前record对象的所有数据。它是一个JSON对象,可以直接从它里面获得需要的数据。可以通过Ext.data.Record的get()函数方便地从data属性中获得指定的属性值。
如果需要修改boy中的数据,请不要使用以下方式直接操作data:

boy.data.name = 'boy name';  
boy.data\['name'\] = 'boy name';

而应该使用set()函数:

boy.set('name','boy name');

 set()函数会判断属性值是否发生了改变,如果改变了,就要将当前对象的dirty属性设置为true.并将修改之前的原始值放入modified对象中,供其他函数使用。如果直接操作data中的值,record就无法记录属性数据的修改情况。
在Record的属性数据被修改后,可以执行如下几种操作。

    commit()(提交):这个函数的效果是设置dirty为false,并删除modif ied中保存的原始数据。
reject()(撤销):这个函数的效果是将data中已经修改了的属性值都恢复成modified中保存的原始数据,然后将dirty设置为false,并删除保存原始数据的modified对象。
getChanges()(获得修改的部分):这个函数会把data中经过修改的属性和数据放在一个JSON对象里并返同。例如上例中,getChanges()返回的结果是{name:'body name'}。
还可以调用isModified()判断当前record中的数据是否被修改。
Ext.data.Record还提供了用于复制record实例的函数copy()。
var  copyBoy=boy_copy();
这样就得到了boy的一个副本,它里面包含了boy的data数据,但copy()函数不会复制dirty
和modified等额外的属性值。
Ext.data.Record中其他的参数大多与Ext.data.Store有关,请参考Ext.data.Store。

3.Ext.data.Store

    Ext.data.Store是EXT中用来进行数据交换和数据交互的标准中间件,无论是Grid还是ComboBox,都是通过它实现数据读取、类型转换、排序分页和搜索等操作的。

    Ext.data.Store中有一个Ext.data.Record数组,所有数据都存放在这些Ext.data. Record实例中,为后面的读取和修改操作做准备。

    在使用之前,首先要创建一个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的最基本用法。

    对数据进行排序

    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()时都要去后台重新加载数据,而不能只对本地数据进行排序。

    从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; 
    }));

    更新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记录。

    加载及显示数据

    store创建好后,需要调用load()函数加载数据,加载成功后才能对store中的数据进行操作。load()调用的完整过程如下面的代码所示。

store.load({ 
    params: {start:0,limit:20}, 
    callback: function(records, options, success){ 
        Ext.Msg.alert('info', '加载完毕'); 
    }, 
    scope: store, 
    add: true
});

    params是在store加载时发送的附加参数。

     callback是加载完毕时执行的回调函数,它包含3个参数:records参数表示获得的数据,options表示执行load()时传递的参数,success表示是否加载成功。

    Scope用来指定回调函数执行时的作用域。

    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()函数进行判断。

    其他功能

    除了上面提到的数据获取、排序、更新、显示等功能外,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还提供了一系列事件,让我们可以为对应操作设定操作函数。

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等组件已经讲解完毕。