ajax data model(adm)

Module: adm

全局数据模型 model
提供数据的读取、保存/缓存、删除、更新等操作。各模块 model 可继承该模型，以进行模块范围内的数据存取操作。

Since:
  • 2016-03-31
Author:
  • lzwy0820@qq.com
Source:

Examples

import adm from 'ajax-data-model';
const upsModel = $.extend(true, {}, adm, {aa: 'ccc', restapi: {task_type: '/rest/task/type'}});
// 支持的方法：upsModel.get、upsModel.save、upsModel.delete、upsModel.clear
// 配置了 url，则都返回 Promise 对象，不管是否缓存
upsModel.get({url: '/rest/xxx'}).done().fail().then();
// 保存数据到 localStorage 中
upsModel.save('appList', [{music: 'test'}], 'localStorage');
// 通过名字获取，返回存储的数据或者 undefined
upsModel.get('appList');
upsModel.get('appList', 'localStorage');
// 获取 task_type 数据
const data = {type: 10};
adm.get({
    url: upsModel.restapi.task_type,
    data: data,
    cache: 'sessionStorage',             // 缓存到 sessionStorage
    fromCache: 'sessionStorage',         // 获取时优先从 sessionStorage 读取
    cacheName: 'task_type_' + data.type, // 缓存、从缓存读取时使用的名称
    expires: 1000 * 60 * 5,              // 数据有效时间为 5 分钟
}).then((result) => {
    let taskTypeList = result.value || [];
    console.log(taskTypeList);
}, (err) {
    console.log(err);
});

Methods

<static> clear(cacheType) → {scope}

根据存储类型清空存储的所有数据

Parameters:
Name Type Description
cacheType String
Source:
Returns:

this

Type
scope

<static> delete(config)

删除一个数据

Parameters:
Name Type Description
config Object

为字符串时，作为 cacheName 尝试从缓存中删除数据。否则格式如下：

{
    url: '',       // 配置了 url，从远程删除数据，否则从缓存中删除
    cache: false,  // 配置了 url，是否还尝试从缓存中删除数据。可取值：false/true/sessionStorage/localStorage
    cacheName: ''  // 从缓存中删除数据时，提供其名称。
}
Source:

<static> get(config, callback, errCallback)

数据获取，可为远程url、缓存等

Parameters:
Name Type Description
config Object

为字符串时，从缓存中读取数据，否则为从远程获取数据，参数如下：

{
    url: '',          // API url 地址，可为空。为空时应存在 cacheName，此时为从缓存中读取数据
    data: {},         // url 请求参数
    cache: false,     // 配置了 url 获取数据时，是否缓存数据。可取值：`false/true/sessionStorage/localStorage`
    fromCache: false, // 配置了 url，是否首先尝试从缓存中读取数据。可取值：`false/true/sessionStorage/localStorage`
    cacheName: '',    // 配置了 url 并且 cache 为 true，配置缓存数据的名称，不配置则取值 url (/ 会替换为 . 作为深度路径)
    expires: 0,       // 如果 cache 为 true，设置缓存数据的有效期，可为 毫秒数，或 Date 类型日期
    tipConfig: {delay: 2000} // ajax 出错时的提示配置。配置为 false 时，禁用全局的系统提示，包括 成功/出错/404/50x 等
    errAlert: true    // ajax error 时是否给出全局提示，优先级高于 settings.errAlert
    waiting: {}       // 按钮等待等配置，用于传递给 settings.fnWaiting 方法
    ajaxParam: null   // ajax 额外参数扩展，如涉及文件上传等，需要修改部分参数。其中 url 参数无效，应当使用 config.url
}
callback Object

成功回调方法
errCallback Object

从 url 获取时，失败后需要做一些处理的回调方法
}
Source:

<static> getAll(cacheType) → {Object}

返回所有存储中的所有数据

Parameters:
Name Type Description
cacheType String

存储的类型：sessionStorage、localStorage 或 memory
Source:
Returns:
Type
Object

<static> getJSON(url, data, callback, errCallback) → {Promise}

module:dataModel.get 的 ajax 快捷方法

Parameters:
Name Type Description
url String

url 地址
data Object

要传递的参数，可省略
callback function

成功回调
errCallback function

失败回调
Source:
See:
  • module:dataModel.get
Returns:
Type
Promise

<static> post(url, data, callback, errCallback) → {Promise}

module:dataModel.save 的 ajax 快捷方法

Parameters:
Name Type Description
url String

url 地址
data Object

要传递的参数
callback function

成功回调
errCallback function

失败回调
Source:
See:
  • module:dataModel.save
Returns:
Type
Promise

<static> save(config, callback, errCallback)

设置/存储数据

Parameters:
Name Type Description
config Object | String

配置信息。也可以为字符串，则为需存储的数据名称。与 module:adm~get 的 config 参数相同
callback function | Object

存储成功后回调方法。当 config 为字符串时，为需存储的数据，或方法执行后返回要存储的数据
errCallback function | String

从 url 获取时，失败后需要做一些处理的回调方法。config 为字符串时，为配置信息，如 {cacheType, expires}
Source:
Examples
// 存储数据到 localStorage，名称为 testdataName
adm.save('testdataName', {test: 1}, 'localStorage');
// 存储数据到远程，同时存储到 sessionStorage
adm.save({url: '/rest/dd', data: {test: 1}, cache: 'sessionStorage'});

<static> setCachePrefix(prefix, clear[)

修改缓存数据的前缀

Parameters:
Name Type Default Description
prefix String

以下划线开头，由字母、数字、或下划线组成
clear[ Boolean true

修改前缀前，是否移除已有的数据
Source:

<static> setSettings(setting)

设置配置项

Parameters:
Name Type Description
setting Object
Source:

<inner> requestAjax(config, callback, errCallback, param, fnCB) → {Promise}

ajax 请求通用方法

Parameters:
Name Type Description
config Object

请求参数配置

Properties
Name Type Description
url String

ajax url，必须存在，config.ajaxParam 中配置此参数无效
ajaxParam Object

ajax 额外参数扩展，如涉及文件上传等
data Object

ajax 请求的参数
waiting Object

用于传递给 settings.fnWaiting 方法使用的参数配置
tipConfig[true Object

ajax 出错时的提示配置。配置为 false 时，禁用全局的系统提示，包括 成功/出错/404/50x 等
errAlert[true Object

ajax error 时是否给出提示
callback function

ajax 请求成功时回调
errCallback function

ajax 请求失败或 code !== 200 时回调
param Object

传递给 ajax 请求的额外参数
fnCB function

请求到数据之后的立即回调方法，用于请求成功后需要前置处理的情况
Source:
Returns:

用于自定义回调处理。
注意：ajax 请求的 done/fail 回调，与 callback/errCallback 可能有区别，具体取决于 fnAjaxDone 与 fnAjaxFail 回调的实现

Type
Promise