swordajax组件
sword封装好的ajax方法,省去了一些常用的默认参数,增加了遮罩框,按钮禁用等功能,使用的参数结构和传统的ajax也十分类似。 snippets:
sword.ajax
swordajax上送参数说明
| 属性名 | 属性值 | 说明 |
|---|---|---|
| data | json对象 | 上送后台的参数 |
| dataType | 提交对象类型 │ 默认'json' | 提交参数的类型 |
| type | GET │ POST │ 默认'POST' | ajax提交方式 |
| url | url地址 | 提交的地址 |
| loadMask | true │ false │ 默认'true' | 提交时是否显示遮罩 |
| selector | 符合选择器的范式 | 送此参数后,当ajax提交时,会将该选择器相应的按钮进行禁用,防止重复提交 |
| returnCodeKey | 后台返回参数的标志位key │ 'none' │ 默认'hostRspCode' | 用于判断后台返回交易类型为成功还是失败 |
| returnMsgKey | 后台返回参数的日志key │ 默认'hostRspMsg' | 用于提取后台返回交易日志 |
| successCode | 后台返回交易表示成功类型的状态码 │ 默认'00000' | 配合上述字段,可以实现当后台返回交易为失败市,sowrdajax组件会自动调用lobibox控件显示错误类型和错误日志,当returnCodeKey送'none'时,则将后台返回的数据直接透传至success函数,不进行交易状态校验 |
| success | function | ajax成功时调用的函数方法。当送returnCodeKey和successCode,只有成功交易才会调用此方法;如果returnCodeKey送'none'时,则无论交易成功还是失败,均调用此方法 |
| error | function │ 默认打印错误日志方法 | ajax提交失败时调用的函数方法 |
代码展示
//最基础的提交代码
//后台返回的json数据为:
returnJson ={
hostRspCode:00000,
hostRspMsg:'提交成功'
data:1
}
$.swordajax({
url: "<%=pathhere%>/json/data.json",
data: param, //传入组装的参数
success: function (result) {
Lobibox.alert('success', {
msg: '工单完成成功!'
});
}
});
//增加按钮禁用
//在参数的提交过程中,会禁用id为submit的按钮,直至提交完成。
$.swordajax({
url: "<%=pathhere%>/json/data.json",
data: param, //传入组装的参数
selector: "#submit",
success: function (result) {
Lobibox.alert('success', {
msg: '工单完成成功!'
});
}
});
//数据透传
//适用于取数据,并且返回数据无交易状态字段。
//后台返回的json数据为:
returnJson ={
data:1
}
$.swordajax({
url: "<%=pathhere%>/json/data.json",
data: param, //传入组装的参数
returnCodeKey: "none",
success: function (result) {
Lobibox.alert('success', {
msg: '工单完成成功!'
});
}
});
//返回字段自定义
//适用于返回的数据字段中,交易状态的key或者msg和默认参数不一致的情况。
//后台返回的json数据为:
returnJson ={
retrCode:0000,
retMsg:'提交成功'
data:1
}
$.swordajax({
url: "<%=pathhere%>/json/data.json",
data: param, //传入组装的参数
returnCodeKey: "retrCode",
returnMsgKey:"retMsg",
successCode:"0000",
success: function (result) {
Lobibox.alert('success', {
msg: result.retMsg
});
}
});