更新时间:2024-11-04 GMT+08:00
分享

HttpUtils工具类预置API一览表

表1 HttpUtils工具类预置API一览表

API

API说明

getCookie

用于获取某个cookie的值。

setCookie

用于设置cookie的值。

getI18n

返回一个Vue18n的实例。

getCsrfToken

通过ajax的方式,调用平台的接口时使用。

refreshToken

用于手动刷新页面的accesstoken。

getUrlParam

用于获取查询字符串中的参数。

getLocalStorage

用于获取某个localStorage的值。

setLocalStorage

用于设置某个localStorage的值。

getCookie

用于获取某个cookie的值,使用方式参考如下:

/* @param {*} cookieID
 */
HttpUtils.getCookie("key")

setCookie

用于设置cookie的值,使用方式参考如下:

/* @param {*} key
 * @param {*} value
 */
HttpUtils.setCookie("key","value")

getI18n

一般用于在初始化阶段返回一个Vue18n的实例,配合Vue和VueI18n使用。使用方式参考如下:

/* 
 * 该Vue18n实例可以在new一个Vue实例时赋值为i18n参数。
 */
HttpUtils.getI18n({
  locale: HttpUtils.getLocale(), 
  messages: thisObj.getMessages()
})

getCsrfToken

通过ajax的方式,调用平台的接口时使用,使用方式参考如下:

/*
 * 如果使用平台桥接器的方式,平台会自动在请求header中添加csrf-token头。
 */
HttpUtils.getCsrfToken(function(csrfToken) {
  $.ajax({
    headers: {
      CSRF-Token: csrfToken
    },
  })
});

refreshToken

用于手动刷新页面的accesstoken,通常用在执行退出逻辑时,执行该方法刷新页面的accesstoken。使用方式参考如下:

/* @param {*} connector
  * @param {*} successCallBack
  * @param {*} errorCallback
  */
HttpUtils.refreshToken(connector,successCallBack,successCallBack) 

getUrlParam

用于获取查询字符串中的参数,使用方式参考如下:

/* 
 * 例如某个页面的URL为“https://10.10.10.1:12900/magno/render/cool__app_0000000000NABzEjpNIH/page1?param=1”, 通过执行
 * HttpUtils.getUrlParam("param")返回该参数的值“1”。
 */
HttpUtils.getUrlParam("param")

getLocalStorage

用于获取某个localStorage的值,使用方式参考如下:

/* 
 * @param {*} key
 */
HttpUtils.getLocalStorage("key")

setLocalStorage

用于设置某个localStorage的值,使用方式参考如下:

/* @param {string} key
 * @param {string/obj} value
 * @param {number} expires
 */
HttpUtils.setLocalStorage("key","value",1000)

内置API支持设置localstorage的失效时间,单位为s。

相关文档