为了确保开发者的DataProxy API使用无误,我们定义了Ext.data.Api单例管理这些数据的API。除了创、见、变、灭的这四种CRUD操作进行了定义之外,还分别将这些操作映射到了RESTful的HTTP方法:GET、POST、PUT和DELETE。
我们不妨打开源码看看。var validActions = {}就是保存“反转Ext.data.Api.actions的哈希表hash”,即value变为是key。本单例的一些方法(如getActions、getVerb)会以for (var verb in this.actions)的语句遍历这些actions,所以为了效率更快的话,访问过hash的会保存成为缓存,某些方法首先会检查hash命中匹配的值。需要注意的是,此hash运作过程中不断的读写、修改,因此我们不能够预定义这个hash。
属性actions指定了远程动作所关联的本地动作是哪些,如:
actions: {
create : 'create', // 表示位于服务端创建记录所执行的创建动作。Text representing the remote-action to create records on server.
read : 'read', // 表示位于服务端读取、加载数据所执行的创建动作。Text representing the remote-action to read/load data from server.
update : 'update', // 表示位于服务端更新记录所执行的创建动作。Text representing the remote-action to update records on server.
destroy : 'destroy' // 表示位于服务端消除记录所执行的创建动作。Text representing the remote-action to destroy records on server.
}
至于属性restActions ,就是将HTTP方法与关联的动作定义在一起的{CRUD action}:{HTTP method}的结对,将用于Ext.data.DataProxy.restful的时候。默认为:
restActions : {
create : 'POST',
read : 'GET',
update : 'PUT',
destroy : 'DELETE'
}
执行Ext.data.Api.isAction(action)方法,若传入的动作名称,在常量Ext.data.Api.actions中已经是有的就返回true。该方法的参数也可以是CRUD操作的数组。多次操作的时候传入数组的话会更快。
执行getVerb(name)返回实际的CRUD操作键值,根据传入的动作名称辨认出实际的"create", "read", "update" 或 "destroy"操作类型。一般来说该方法是内置使用的,不会直接地调用它。 Ext.data.Api.actions的key/value结对是相同无异的,但是也不一定的说。有需要的话,开发者可允许覆盖约定的名称。不过,框架内部依据KEY来调用方法的,因此就需要某种方式取得"create"、"read"、"update"和"destroy" 关键字才可以。如果发现KEYS已被缓存在validActions中,那么该就会直接从缓存中返回。
isValid()如果传入的API是有效的,就返回true;这样的话,同时检查到预定义没有的动作,就会传入到数组中,最后返回(错误的动作)。
hasUniqueUrl()使用的场合是, 在传入的proxy在一个原来唯一的proxy地址的时候,并没有其他API动作染指的时候,返回true。当决定是否插入“xaction”的HTTP参数到某个Ajax请求的时候,这个问题就显得重要了。 一般来说该方法是内置使用的,不会直接地调用它。
prepare(Ext.data.DataProxy)方法由Ext.data.DataProxy DataProxy内部使用,一般不宜直接使用。内部定义时,每个DataProxy API的动作可以是String或者是Object。当定义为Object的时候,就可以为其中的CRUD操作精确指定是哪一种HTTP方法(GET、POST…)。该方法会初始化传入的API,将每一项的操作转换为Object的形式。如果你传入的API没有设定HTTP方法的话,那么“method”所指定的配置项就是默认的方法。如果连method的配置项都没有指定的话,那么就是POST了。
new Ext.data.HttpProxy({
method: "POST", // 没有指定时默认的HTTP方法。
api: {
create: 'create.php',
load: 'read.php',
save: 'save.php',
destroy: 'destroy.php'
}
});
// 可选地,也可以对象形式定义。
new Ext.data.HttpProxy({
api: {
load: {url: 'read.php', method: 'GET'},
create: 'create.php',
destroy: 'destroy.php',
save: 'update.php'
}
});
通过执行restify(),可初始化Proxy,让其成为RESTful的。可根据restActions的值定义每个API动作的HTTP方法(GET, POST, PUT, DELETE的任意一种)。
最后Ext为我们提供了一个异常类Ext.data.Api.Error来任何异常的信息,向用户反馈问题的信息。