gk-utils v1.0.0

gk-utils

常用业务工具类库


安装： 

npm install -S gk-utils


全局使用：

main.js中引入


Vue2.x：

import Vue from 'vue';
import { BaseUtil } from 'gk-utils';
Vue.property['$base'] = BaseUtil;


Vue3.x：

import { createApp } from 'vue';
import App from './App.vue';
const app = createApp(App);
import { BaseUtil } from 'gk-utils';
app.config.globalProperties['$base'] = BaseUtil;

BaseUtil（基础工具类）

方法名称：typeEstimate(val)
方法说明：对val进行typeof判断
参数说明：
1、val：any类型（必须）
返回：string类型



方法名称：resetObject(obj)
方法说明：对象所有key值清空（Array类型=[]、Object类型={}、其他类型=null）
参数说明：
1、obj：Object类型（必须）
返回：Object类型



方法名称：uniqueList(list)
方法说明：对数组元素进行去重
参数说明：
1、list：Array类型（必须）
返回：Array类型



方法名称：uniqueListObject(list, key)
方法说明：数组元素是对象类型的某个key值进行去重
参数说明：
1、list：Array类型（必须）
2、key：string类型（必须）
返回：Array类型



方法名称：randomRgbaColor(isRgb)
方法说明：随机生成rgba颜色值
参数说明：
1、isRgb：boolean类型（非必须，默认false）设置为true，alpha为1，设置为false，alpha为0～1之间的随机数
返回：string类型



方法名称：randomHexColor()
方法说明：随机生成hex颜色值
参数：无
返回：string类型



方法名称：getUUID()
方法说明：生成UUID（通用唯一识别码）
参数：无
返回：string类型



方法名称：getFormatMoney(money)
方法说明：货币金额字符串格式化
参数说明：
1、money：string类型（必须）
返回：string类型



方法名称：recursionTreeSearchProperty(list, searchKey, searchValue, resultKey)
方法说明：递归遍历树结构数组（查找某个key值的特定key值）
参数说明：
1、list：Array类型（必须，对象数组）
2、searchKey：string类型（必须）
3、searchValue：非Object类型（必须）
4、resultKey：string类型（必须）
返回：void类型



方法名称：getSearchedTreeList()
方法说明：获取递归遍历树结构数组被查找后的结果
参数：无
返回：Array类型



方法名称：clearSearchedTreeList()
方法说明：清除递归遍历树结构数组被查找后的结果
参数：无
返回：void类型



方法名称：recursionTreeAddPropertiesMap(list, propertyList)
方法说明：向树结构数组添加属性（Map方式）
参数说明：
1、list：Array类型（必须，对象数组）
2、propertyList：Map类型（必须）
格式：[['keyName1', {value: 1}], ['keyName2', {value: 2}]]
返回：void类型



方法名称：recursionTreeAddPropertiesArray(list, propertyList)
方法说明：向树结构数组添加属性（Array方式）
参数说明：
1、list：Array类型（必须，对象数组）
2、propertyList：Array类型（必须）
格式：[{key: 'keyName1', value: 1}, {key: 'keyName2', value: 2}]
返回：void类型



方法名称：getLocalStorageKey(key)
方法说明：获取浏览器本地缓存的某个key值
参数说明：
1、key：string类型（必须）
返回：any类型



方法名称：setLocalStorageKey(key, data)
方法说明：向浏览器本地缓存新建某个key，并存入数据
参数说明：
1、key：string类型（必须）
2、data：any类型（必须）
返回：void类型



方法名称：removeLocalStorageKey(key)
方法说明：删除浏览器本地缓存的某个key
参数说明：
1、key：string类型（必须）
返回：void类型


方法名称：clearLocalStorage()
方法说明：清空浏览器本地缓存所有key
参数：无
返回：void类型

DateUtil（日期处理工具类）

方法名称：getNowFormatDate(format, seperator)
方法说明：当前Date日期对象格式化为字符串
参数说明：
1、format：string类型（非必须，默认"date"）设置为"date"，显示年月日，设置为"datetime"，显示年月日时分
2、seperator：string类型（非必须，默认"-"）间隔符号，如："2021-05-01"、"2021/05/01"
返回：string类型



方法名称：stringToDate(date)
方法说明：字符串日期转换为Date日期对象
参数说明：
1、date：string类型（必须，例如："2021-05-01"、"2021/05/01"）
返回：Date类型



方法名称：dateToString(date, format, seperator)
方法说明：Date日期对象转换为字符串日期
参数说明：
1、date：Date类型（必须）
2、format：string类型（非必须，默认"date"）设置为"date"，显示年月日，设置为"datetime"，显示年月日时分
3、seperator：string类型（非必须，默认"-"）间隔符号，如："2021-05-01"、"2021/05/01"
返回：string类型



方法名称：getWeekDate(val)
方法说明：获取星期的日期
参数说明：
1、val：number类型（必须，2+=昨天、0=明天、-1+=后天），以此类推
返回：string类型



方法名称：getWeekDayFront(date)
方法说明：获取当前日期的近七天（包括当前日期）
参数说明：
1、date：string类型（必须，例如："2021-05-01"、"2021/05/01"）
返回：Array类型



方法名称：getWeekDayAfter(date)
方法说明：获取当前日期的后七天（包括当前日期）
参数说明：
1、date：Date类型（必须）
返回：Array类型



方法名称：getCurrentMonthFirst()
方法说明：获取当前月的第一天
参数：无
返回：string类型



方法名称：getCurrentMonthLast()
方法说明：获取当前月的最后一天
参数：无
返回：string类型

FileUtil（文件处理工具类）

方法名称：getExtName(fileName)
方法说明：获取文件后缀名
参数说明：
1、fileName：string类型（必须）
返回：string类型



方法名称：getBinaryOrTextOrBase64(file, type)
方法说明：将文件转换为二进制、base64URL或读取文本字符串
参数说明：
1、file：File类型（必须）
2、type：number类型（必须）
    0：将文件转成二进制数组
    1：将文件转成二进制字符串
    2：将文件转成base64编码
    3：读取文本字符串
返回：Promise类型



方法名称：getBinaryFile(file)
方法说明：将文件转换成二进制文件
参数说明：
1、file：File类型（必须）
返回：Blob类型


方法名称：getFormData(file)
方法说明：将文件转换成二进制文件后打包到formData
参数说明：
1、file：File类型（必须）
返回：FormData类型



方法名称：exportRaw(name, data)
方法说明：字符串转换成txt文件并导出
参数说明：
1、name：string类型（必须）文件名
2、data：string类型（必须）文本内容
返回：void类型



使用以下两个方法需要安装依赖：
npm install -S xlsx
npm install -S file-saver



方法名称：importExcel(file)
方法说明：导入Excel
备注：
1、使用setTimeout获取FileUtil.excelValueList
2、FileUtil.excelValueList为List类型
参数说明：
1、file：File类型（必须）
返回：void类型



方法名称：exportExcel(domName, fileName)
方法说明：导出Excel
参数说明：
1、domName：string类型（必须）导出的表格DOM id
2、fileName：string类型（必须）导出表格的名称
返回：void类型



方法名称：getSignaturePNG(imgUrl, signName)
方法说明：生成签名图片保存到本地
参数说明：
1、imgUrl：string类型（必须）
2、signName：string类型（非必须）
返回：void类型

RequestUtil（HTTP请求工具类）

getInterfaces（获取接口枚举集方法）

需要安装依赖：
npm install -S axios



使用示例：
const requestFun = async () => {
  const res = RequestUtil.abstractResult(
    await RequestUtil.postResult(
      getInterfaces('InterfaceEnum').interfaceName, 
      RequestUtil.namedParamsData({
        pageNum: 1,
        pageSize: 10
      }));
      
  if (!res.dataIsEmpty) {
    console.log(res); 
    // res.content：获取请求成功后的数据
    // res.msg：请求成功提示文案
  }
};



方法名称：
1、RequestUtil.setBaseUrlAndHeaders(baseUrl, authName);
2、RequestUtil.getResult()
3、RequestUtil.postResult(url, data)
4、RequestUtil.putResult()
5、RequestUtil.deleteResult()
6、RequestUtil.namedParamsData()
7、RequestUtil.abstractResult()
方法说明：
1、设置服务端请求基准路径、请求头部校验属性名称
2、HTTP请求服务端（GET方式）
3、HTTP请求服务端（POST方式）
4、HTTP请求服务端（PUT方式）
5、HTTP请求服务端（DELETE方式）
6、命名参数
7、获取响应结果
参数说明：
1、baseUrl：string类型（必须）
2、authName：string类型（非必须）
3、url：string类型（必须）
4、data：any类型（非必须）
返回：Promise类型

ScreenUtil（屏幕工具类）

方法名称：isMobile()
方法说明：判断是否移动端
参数：无
返回：boolean类型



方法名称：isTop()
方法说明：页面置顶
参数：无
返回：void类型



方法名称：setIntoView(elem)
方法说明：页面锚点
参数说明：
1、elem：string类型（必须）
返回：void类型



方法名称：openNewLink(href)
方法说明：页面跳转到新窗口
参数说明：
1、href：string类型（必须）
返回：void类型



方法名称：prohibitScale()
方法说明：禁止缩放（仅支持移动端）
参数：无
返回：void类型



方法名称：stopPageMove()
方法说明：设置禁止滑动（支持桌面端、移动端）
参数：无
返回：void类型



方法名称：startPageMove()
方法说明：取消禁止滑动（支持桌面端、移动端）
参数：无
返回：void类型



方法名称：debounce(fn, ms)
方法说明：防抖
参数说明：
1、fn：Function类型（必须）
2、ms：number类型（必须）
返回：void类型



方法名称：throttle(fn, ms)
方法说明：节流
参数说明：
1、fn：Function类型（必须）
2、ms：number类型（必须）
返回：void类型

StringUtil（字符串处理工具类）

方法名称：utf16toUtf8(str)
方法说明：UTF-16字符转换UTF-8字符
参数说明：
1、str：string类型（必须）
返回：string类型



方法名称：checkHtmlTag(val)
方法说明：检查字符串是否包含HTML标记
参数说明：
1、val：string类型（必须）
返回：boolean类型



方法名称：delHtmlTag(str)
方法说明：字符串去除HTML标记
参数说明：
1、str：string类型（必须）
返回：string类型



方法名称：oldstrReplaceNewstr(str, oldStr, newStr)
方法说明：字符串中将某个字符替换成新字符
参数说明：
1、str：string类型（必须）
2、oldStr：string类型（必须）
3、newStr：string类型（必须）
返回：string类型



方法名称：checkStrContainChinese(val)
方法说明：检测字符串是否包含中文
参数说明：
1、val：string类型（必须）
返回：boolean类型



方法名称：checkPureNumber(val)
方法说明：检测字符串是否纯数字
参数说明：
1、val：string类型（必须）
返回：boolean类型



方法名称：getCaptionBefore(str, character)
方法说明：获取指定字符之前所有字符
参数说明：
1、str：string类型（必须）
2、character：string类型（必须）
返回：string类型



方法名称：getCaptionLast(str, character)
方法说明：获取指定字符之后所有字符
参数说明：
1、str：string类型（必须）
2、character：string类型（必须）
返回：string类型



方法名称：forWords(str, wordsStr, singleWord)
方法说明：字符串敏感词标红
参数说明：
1、str：string类型（必须）
2、word：string类型（必须）
3、singleWord：boolean类型（非必须， 默认false）设置为true，标红第一个敏感词，设置为false，标红全部敏感词
返回：string类型

VerificationUtil（验证工具类）

方法名称：checkAccount(account)
方法说明：账号验证（用户名至少6位，并包含一个大写字母）
参数说明：
1、account：string类型（必须）
返回：boolean类型



方法名称：checkPassword(passsword)
方法说明：密码验证（密码必须包含大写和小写字母、数字，至少8个字符）
参数说明：
1、password：string类型（必须）
返回：boolean类型



方法名称：checkPhone(phone)
方法说明：手机号验证
参数说明：
1、phone：string类型（必须）
返回：boolean类型



方法名称：checkEmail(email)
方法说明：电子邮箱验证
参数说明：
1、email：string类型（必须）
返回：boolean类型



方法名称：checkURL(url)
方法说明：URL格式验证（包括协议验证）
参数说明：
1、url：string（必须）
返回：boolean类型



方法名称：checkIdCard(idCard)
方法说明：身份证验证
参数说明：
1、idCard：string类型（必须）
返回：boolean类型



方法名称：getIdCardInfo(idCard)
方法说明：读取身份证信息
参数说明：
1、idCard：string类型（必须）
返回：object类型



方法名称：checkChineseName(name)
方法说明：汉字姓名验证（请输入至少两个汉字，不包含字母和数字）
参数说明：
1、name：string类型（必须）
返回：boolean类型



方法名称：checkInputPureNumber(str)
方法说明：input输入纯数字
参数说明：
1、str：string类型（必须）
返回：string类型



方法名称：checkInputTrimAndTabEnter(str)
方法说明：input输入禁止空格、换行
参数说明：
1、str：string类型（必须）
返回：string类型



方法名称：checkInputTrimAndChinese(str)
方法说明：input输入禁止空格和汉字
参数说明：
1、str：string类型（必须）
返回：string类型