commonutil

455 阅读4分钟

对象初始化

commonUtil = new CommonUtil({
    webName: '当前系统跟文件名',
    alertMMUrl: '更改密码接口路径',
    imgUrl: '获取动态图片的默认地址,只在生产环境下生效',
    libSite: 'lib目录相对当前系统根路径所在位置,便于在老系统中扩展'
})

公共基础数据

对外提供的该方法生成的部分内部数据,用于对外自定义扩充或重新方法使用,保持数据的通用性与一致性

console.log(commonUtil.data) // Object

返回数据说明

属性名类型描述
indexString首页文件相对当前系统根路径所在位置,默认值为:/web/index.html
loginString登陆文件相对当前系统根路径所在位置,默认值为:/index.html

公共方法

常用方法集合:如js加减乘除数据结果误差处理,数组转树形结构数据等

layerLoading (遮罩层)

自定义遮罩层显示,等同于layui.layer.loading()

示例

  var loadings = commonUtil.layerLoading();
  commonUtil.layerCloseLoading(loadings); (关闭遮罩)

参数说明

暂不支持自定义参数

返回数据说明

返回数据数据类型备注
resString遮罩层层级,在关闭遮罩层时候使用

session

临时存储数据,对sessionStorage方法的重写,实现存取一体化操作

示例

commonutil.session('a', '1')
// 等同于
sessionStorage.setItem('a', JSON.stringify('1'))

commonutil.session('a')
// 等同于
JSON.parse(sessionStorage.getItem('a'))

commonutil.session('a', null)
// 等同于
sessionStorage.removeItem('a')

参数说明

参数名类型必填描述
nameString临时数据存储名称
val-临时存储数据值域
undefined   获取数据
null              移除该临时数据
其它             保存数据

返回数据说明

| 返回数据 | 数据类型 | 备注 |

| ---- | ---- | ---- |

| res | - | 所存储的数据或者undifined |

local

长期存储数据,对localStorage方法的重写,实现存取一体化操作

示例

commonutil.local('a', '1')
// 等同
sessionStorage.setItem('a', JSON.stringify('1'))

commonutil.local('a')
// 等同于
JSON.parse(localStorage.getItem('a'))

commonutil.local('a', null)
// 等同于
localStorage.removeItem('a')

参数说明

参数名类型必填描述
nameString临时数据存储名称
val-长期存储数据值域
undefined   获取数据
null              移除该长期数据
其它             保存数据

返回数据说明

返回数据数据类型备注
val-所存储的数据或者undifined

getAjax

ajax的get同步请求,获取服务器端数据

依赖项

commonutil.layerLoading

示例

//获取返回的数据
commonutil.getAjax(www.baidu.com,'网络连接超时');

参数说明

参数名类型必填描述
urlURL接口请求地址
msgString/boolean请求失败时弹出的错误信息

返回数据

返回数据数据类型备注
res-返回的数据。

getAjaxSync

ajax异步get请求 获取服务器端数据

依赖项

commonutil.layerLoading

示例

commonutil.getAjaxSync('http://www.baidu.com').then(data => {
    // 成功后的处理函数
}).catch(e => {
    // 失败后的处理函数
})

参数说明

参数名类型必填描述
urlURL需要传入的url地址

参数说明

返回promise对象,具体使用方法参照示例,方法说明如下表:

参数名类型描述
resolvePromise.then成功调用resolve方法
rejectPromise.catch失败调用reject方法

commonHttppost

ajax同步post请求数据,获取服务端数据

依赖项

commonutil.getPostData

commonutil.layerLoading

Jquery

示例


var url = www.jt.com;

var data = {};

var msg = "网络请求错误";

//不需要获取用户信息就可以执行的操作

var resultData = commonutil.commonHttppost(url,data,msg,true);

//获取用户信息,如果获取成功,便成功执行以下方法

var resultData = commonutil.commonHttppost(url,data,msg,false);

参数说明

参数名类型必填描述
urlURL请求url
msgString/boolean请求失败时弹出的错误信息
dataobject请求数据
judgeboolean判断是否需要获取登录信息 默认为false
true     不需要获取登录信息
false     需要获取登录信息

返回数据

返回数据数据类型备注
resobject返回的数据结果

commonQueryAsyncHttppost_callback

ajax异步post请求数据,获取服务端数据

依赖项

commonutil.getPostData

commonutil.layerLoading

Jquery

示例

var url = www.jt.com;
var data = {};
var msg = "网络请求错误";
//不需要获取用户信息就可以执行的操作
var resultData = commonQueryAsyncHttppost_callback(url,data,true).then(res = > {
    //成功执行返回的函数
}).catch(e = > {
    //失败执行后返回的函数
})
//获取用户信息,如果获取成功,便成功执行以下方法
var resultData = commonQueryAsyncHttppost_callback(url,data,false).then(res = > {
    //成功执行返回的函数
}).catch(e = > {
    //失败执行后返回的函数

![image.png](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/a6a3e4e4167440f4b5d91f693f76a5b1~tplv-k3u1fbpfcp-watermark.image)
})

参数说明

参数名类型必填描述
urlURL请求的url
dataobject如果成功返回数据不调用msg参数所在的方法。
如果没有返回数据,调用msg参数所在的方法返回失败原因。
judgeboolean判断是否需要获取登录信息 默认为false
true  不需要获取登录信息
false  需要获取登录信息

返回数据

返回promise对象,具体使用方法参照示例,方法说明如下表:

参数名类型描述
resolvePromise.then成功调用resolve方法
rejectPromise.catch失败调用reject方法