@gx-design-vue/create-gx-cli 0.1.20 → 0.1.21

package/template-mobile-vant-cli/src/utils/request/axiosCancel.ts

@@ -0,0 +1,69 @@
+import type { Canceler } from 'axios'
+import type { GAxiosOptions } from './typings'
+import { isFunction } from '@gx-design-vue/pro-utils'
+import axios from 'axios'
+
+export const getPendingUrl = (
+  config: GAxiosOptions,
+  key?: string
+) => key || config.cancelKey || [ config.method, config.url ].join('&')
+
+export class AxiosCanceler {
+  ignoreCancelToken: boolean
+  pendingMap: Map<string, Canceler>
+
+  constructor(ignoreCancel?: boolean) {
+    this.pendingMap = new Map<string, Canceler>()
+
+    this.ignoreCancelToken = !!ignoreCancel
+  }
+
+  /**
+   * Add request
+   * @param {object} config
+   */
+  addPending(config: GAxiosOptions) {
+    !this.ignoreCancelToken && this.removePending(config)
+
+    const url = getPendingUrl(config)
+    config.cancelToken = config.cancelToken || new axios.CancelToken((cancel) => {
+      if (!this.pendingMap.has(url)) {
+        // If there is no current request in pending, add it
+        this.pendingMap.set(url, cancel)
+      }
+    })
+  }
+
+  /**
+   * @description: Clear all pending
+   */
+  removeAllPending() {
+    this.pendingMap.forEach((cancel) => {
+      cancel && isFunction(cancel) && cancel()
+    })
+    this.pendingMap.clear()
+  }
+
+  /**
+   * Removal request
+   * @param {object} config
+   */
+  removePending(config: GAxiosOptions, key?: string) {
+    const url = getPendingUrl(config, key)
+
+    if (this.pendingMap.has(url)) {
+      // If there is a current request identifier in pending,
+      // the current request needs to be cancelled and removed
+      const cancel = this.pendingMap.get(url)
+      cancel && cancel(url)
+      this.pendingMap.delete(url)
+    }
+  }
+
+  /**
+   * @description: reset
+   */
+  reset(): void {
+    this.pendingMap = new Map<string, Canceler>()
+  }
+}

package/template-mobile-vant-cli/src/utils/request/checkStatus.ts

@@ -0,0 +1,25 @@
+import { router } from '@/router'
+import { useStoreUser } from '@/store'
+import { showToast } from 'vant'
+
+/**
+ * @author gx12358 2539306317@qq.com
+ * @description 处理code异常
+ * @param {*} code
+ * @param {*} msg
+ */
+export const handleCode = (code: number, msg: string) => {
+  const user = useStoreUser()
+  switch (code) {
+    case 401:
+      user.resetPermissions()
+      router.push({ path: '/user/login' })
+      break
+    default:
+      showToast({
+        type: 'fail',
+        message: msg || '后端接口异常'
+      })
+      break
+  }
+}

package/template-mobile-vant-cli/src/utils/request/index.ts

@@ -0,0 +1,155 @@
+import type { GAxiosOptions, XhtInstance } from './typings'
+import { useStoreUser } from '@/store'
+import { isDev, typeViteEnv } from '@/utils/env'
+import { tansParams } from '@/utils/util'
+import { checkURL } from '@/utils/validate'
+import { defaultSettings, network } from '@gx-config'
+import { isBoolean } from '@gx-design-vue/pro-utils'
+import { showToast } from 'vant'
+import { handleCode } from './checkStatus'
+import { RequestEnum } from './typings'
+import { GAxios } from './XHR'
+
+const { token, mock } = defaultSettings
+
+const { requestTimeout, successCode } = network
+
+const xhtInstance: XhtInstance = {
+  /**
+   * @description: 处理响应数据。如果数据不是预期格式，可直接抛出错误
+   */
+  transformResponseHook: (res, options) => {
+    const { customize, isReturnNativeResponse } = options
+    // 是否返回原生响应头 比如：需要获取响应头时使用该属性
+    if (isReturnNativeResponse) {
+      return res
+    }
+    // 不进行任何处理，直接返回
+    // 用于页面代码可能需要直接获取code，data，message这些信息时开启
+    if (customize) {
+      return res.data
+    }
+    // 错误的时候返回
+
+    const { data }: { data: ResponseResult } = res
+    if (!data) {
+      throw new Error('请求出错，请稍候重试')
+    }
+    //  这里 code，result，message为 后台统一的字段，需要在 types.ts内修改为项目自己的接口返回格式
+    const { code, message = '' } = data
+
+    const codeVerificationArray = successCode
+
+    // 这里逻辑可以根据项目进行修改
+    const hasSuccess = codeVerificationArray.includes(code)
+    if (hasSuccess) {
+      return data
+    }
+
+    // 在此处根据自己项目的实际情况对不同的code执行不同的操作
+    // 如果不希望中断当前请求，请return数据，否则直接抛出异常即可
+    handleCode(code, message)
+
+    return Promise.resolve(false)
+  },
+
+  // 请求之前处理config
+  beforeRequestHook: (config) => {
+    // get请求映射params参数
+    if (config.method?.toUpperCase() === RequestEnum.GET && config.params) {
+      let url = config.url + '?' + tansParams(config.params)
+      url = url.slice(0, -1)
+      config.params = {}
+      config.url = url
+    }
+
+    if (!checkURL(config.url)) {
+      const isMock = isBoolean(typeViteEnv('VITE_IS_MOCK')) ? typeViteEnv('VITE_IS_MOCK') : config.isMock
+      const prefix = isDev() && !isMock ? typeViteEnv('VITE_PROXY_PREFIX') : ''
+      const baseUrl = isMock ? mock.prefix : typeViteEnv('VITE_BASE_URL')
+      config.url = `${prefix}${baseUrl}${config.url}`
+    }
+
+    return config
+  },
+
+  /**
+   * @description: 请求拦截器处理
+   */
+  requestInterceptors: (config) => {
+    const { name } = token
+    const user = useStoreUser()
+    const carryToken = isBoolean(config.carryToken) ? config.carryToken : true
+    if (user.accessToken && carryToken) {
+      if (config.headers) {
+        config.headers[name] = user.accessToken
+      } else {
+        config.headers = {
+          [name]: user.accessToken
+        }
+      }
+    }
+    return config
+  },
+
+  /**
+   * @description: 响应拦截器处理
+   */
+  responseInterceptors: (res) => {
+    return res
+  },
+
+  /**
+   * @description: 响应错误处理
+   */
+  responseInterceptorsCatch: (_, error) => {
+    const { response } = error
+    let errorMessage = error.message || ''
+    if (error.response && error.response.data) {
+      const { status = 404 } = response || {}
+      handleCode(status, errorMessage)
+      return Promise.resolve(false)
+    } else {
+      if (errorMessage === 'Network Error') {
+        errorMessage = '后端接口连接异常'
+      }
+      if (errorMessage.includes('timeout')) {
+        errorMessage = '后端接口请求超时'
+      }
+      if (errorMessage.includes('Request failed with status code')) {
+        const code = errorMessage.substr(errorMessage.length - 3)
+        errorMessage = '后端接口' + code || '' + '异常'
+      }
+      showToast({
+        type: 'fail',
+        message: errorMessage || '后端接口未知异常'
+      })
+      return Promise.resolve(false)
+    }
+  },
+  /**
+   * @description: 处理响应错误数据
+   */
+  requestCatchHook: () => false
+}
+
+function createXhr(opt?: Partial<GAxiosOptions>) {
+  return new GAxios({
+    method: 'get',
+    timeout: requestTimeout,
+    headers: {
+      'Content-Type': 'application/json;charset=UTF-8'
+    },
+    // 忽略重复请求
+    ignoreCancelToken: true,
+    // 是否携带token
+    carryToken: true,
+    ...xhtInstance,
+    ...opt
+  })
+}
+
+const request: <T = any, R = undefined>(opt?: GAxiosOptions) => Promise<ResponseResult<T, R>> = opt => createXhr()
+  .request(opt)
+
+export default request

package/template-mobile-vant-cli/src/utils/request/typings.ts

@@ -0,0 +1,171 @@
+import type {
+  AxiosError,
+  AxiosInstance,
+  AxiosInterceptorManager,
+  AxiosInterceptorOptions,
+  AxiosPromise,
+  AxiosRequestConfig,
+  AxiosResponse,
+  InternalAxiosRequestConfig,
+  Method
+} from 'axios'
+
+export interface GAxiosResponse<T = any> extends Omit<AxiosResponse, 'data' | 'config'> {
+  data: T;
+  config: Omit<GAxiosOptions, 'headers'>;
+}
+
+export interface CancelOptions {
+  cancel: (key?: string) => void,
+  cancelAll: () => void;
+  reset: () => void
+}
+
+export interface XhtInstance {
+  /**
+   * @Author      gx12358
+   * @DateTime    2023/1/6
+   * @lastTime    2023/1/6
+   * @description 请求之前处理config
+   */
+  beforeRequestHook?: (config: GAxiosOptions) => GAxiosOptions;
+
+  /**
+   * @Author      gx12358
+   * @DateTime    2023/11/3
+   * @lastTime    2023/11/3
+   * @description 请求之前返回cancel函数
+   */
+  cancelCallBackHook?: ({ cancel, cancelAll, reset }: CancelOptions) => void;
+
+  /**
+   * @description: 处理响应数据
+   */
+  transformResponseHook?: (res: GAxiosResponse, options: Partial<GAxiosOptions>) => any;
+
+  /**
+   * @description: 请求失败处理
+   */
+  requestCatchHook?: (e: Error) => boolean;
+
+  /**
+   * @description: 请求之前的拦截器
+   */
+  requestInterceptors?: (config: GAxiosOptions) => GAxiosOptions;
+
+  /**
+   * @description: 请求之后的拦截器
+   */
+  responseInterceptors?: (res: GAxiosResponse) => GAxiosResponse;
+
+  /**
+   * @description: 请求之前的拦截器错误处理
+   */
+  requestInterceptorsCatch?: (error: AxiosError) => void;
+
+  /**
+   * @description: 请求之后的拦截器错误处理
+   */
+  responseInterceptorsCatch?: (axiosInstance: GAxiosInstance, error: AxiosError) => void;
+}
+
+export interface GAxiosOptions extends Omit<AxiosRequestConfig, 'headers' | 'method'> {
+  headers?: Record<string, any>;
+  method: Method;
+  isMock?: boolean; // 是否是mock
+  retry?: boolean; // 是否是重试接口
+  isReturnNativeResponse?: boolean; // 直接返回response，不作任何处理（包含响应值等基本信息）
+  customize?: boolean; // 直接返回response.data（接口返回值），错误不做统一提示
+  carryToken?: boolean; // 是否携带token
+  prefix?: string; // 接口自定义前缀
+  ignoreCancelToken?: boolean; // 忽略重复请求
+  cancelKey?: string; // 取消请求key（用来需要请求）
+  /**
+   * @Author      gx12358
+   * @DateTime    2023/1/6
+   * @lastTime    2023/1/6
+   * @description 请求之前处理config
+   */
+  beforeRequestHook?: XhtInstance['beforeRequestHook'];
+
+  /**
+   * @Author      gx12358
+   * @DateTime    2023/11/3
+   * @lastTime    2023/11/3
+   * @description 请求之前返回cancel函数
+   */
+  cancelCallBackHook?: XhtInstance['cancelCallBackHook'];
+
+  /**
+   * @description: 处理响应数据
+   */
+  transformResponseHook?: XhtInstance['transformResponseHook'];
+
+  /**
+   * @description: 请求失败处理
+   */
+  requestCatchHook?: XhtInstance['requestCatchHook'];
+
+  /**
+   * @description: 请求之前的拦截器
+   */
+  requestInterceptors?: XhtInstance['requestInterceptors'];
+
+  /**
+   * @description: 请求之后的拦截器
+   */
+  responseInterceptors?: XhtInstance['responseInterceptors'];
+
+  /**
+   * @description: 请求之前的拦截器错误处理
+   */
+  requestInterceptorsCatch?: XhtInstance['requestInterceptorsCatch'];
+
+  /**
+   * @description: 请求之后的拦截器错误处理
+   */
+  responseInterceptorsCatch?: XhtInstance['responseInterceptorsCatch'];
+}
+
+export interface GAxiosInstance extends Omit<AxiosInstance, 'interceptors'> {
+  (config: GAxiosOptions): AxiosPromise<ResponseResult>;
+
+  (url: string, config?: GAxiosOptions): AxiosPromise<ResponseResult>;
+
+  interceptors: {
+    request: Omit<AxiosInterceptorManager<InternalAxiosRequestConfig>, 'use'> & {
+      use<V>(
+        onFulfilled?: ((value: V) => V | Promise<V>) | null,
+        onRejected?: ((error: any) => any) | null,
+        options?: AxiosInterceptorOptions
+      ): number;
+    };
+    response: Omit<AxiosInterceptorManager<AxiosResponse>, 'use'> & {
+      use<V>(
+        onFulfilled?: ((value: V) => V | Promise<V>) | null,
+        onRejected?: ((error: any) => any) | null,
+        options?: AxiosInterceptorOptions
+      ): number;
+    };
+  }
+}
+
+/**
+ * @description: request method
+ */
+export enum RequestEnum {
+  GET = 'GET',
+  POST = 'POST',
+  PUT = 'PUT',
+  DELETE = 'DELETE',
+}
+
+/**
+ * @description:  contentType
+ */
+export enum ContentTypeEnum {
+  // json
+  JSON = 'application/json;charset=UTF-8',
+  // form-data qs
+  FORM_URLENCODED = 'application/x-www-form-urlencoded;charset=UTF-8',
+}

package/template-mobile-vant-cli/src/utils/storage.ts

@@ -0,0 +1,215 @@
+import { isJSONStr, isNumber, isObject, isString } from '@gx-design-vue/pro-utils'
+import dayjs from 'dayjs'
+import { Decrypt, Encrypt } from './crypto'
+import { isPro, typeViteEnv } from './env'
+
+function isEncryption(status: boolean) {
+  return isPro() ? status : false
+}
+
+function handleStorageValue(value: string) {
+  if (isJSONStr(value))
+    return JSON.parse(value)
+  return value
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019/12/3
+ * @lastTime    2019/12/3
+ * @description 设置Local-key的规则
+ */
+export function getStorageKey(key: string, originKey?: boolean) {
+  const { pkg } = __APP_INFO__
+  return originKey ? key : `${pkg.name}_${pkg.version}_${typeViteEnv('VITE_APP_ENV') === 'dev'
+    ? 'development'
+    : typeViteEnv('VITE_USE_MODE')}_${key}`
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019/12/3
+ * @lastTime    2019/12/3
+ * @description 获取Storage
+ */
+export function getStorage({
+  key,
+  originKey,
+  type = 'local',
+  encryption = true
+}: {
+  key: string;
+  encryption?: boolean;
+  type?: 'local' | 'cookie' | 'session';
+  originKey?: boolean;
+}) {
+  const storageValue = type === 'local'
+    ? localStorage.getItem(getStorageKey(key, originKey))
+    : type === 'session' ? sessionStorage.getItem(getStorageKey(key, originKey)) : getCookie(
+      getStorageKey(
+        key,
+        originKey
+      ))
+  const result: string | LocalResult = storageValue
+    ? isEncryption(encryption) ? Decrypt(storageValue) : handleStorageValue(storageValue)
+    : ''
+  if (result && isObject(result)) {
+    if (result.expired) {
+      const expiredStatus = dayjs().diff(dayjs(result.time)) >= result.expired
+      if (expiredStatus) {
+        removeStorage({ key, originKey, type })
+        return ''
+      }
+    }
+  } else if (result && isString(result)) {
+    return isJSONStr(result) ? JSON.parse(result) : result
+  }
+  return typeof result === 'string' ? result : result?.['value'] || result || ''
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019/12/3
+ * @lastTime    2019/12/3
+ * @description 设置Storage
+ */
+export function setStorage({
+  key,
+  value,
+  expired,
+  originKey,
+  type = 'local',
+  encryption = true
+}: {
+  key: string;
+  value: any;
+  originKey?: boolean;
+  expired?: number;
+  encryption?: boolean;
+  type?: 'local' | 'cookie' | 'session';
+}) {
+  const result: LocalResult = originKey ? value : {
+    value,
+    time: dayjs().format('YYYY-MM-DD HH:mm:ss'),
+    expired: expired || 0
+  }
+  const storageValue = isEncryption(encryption)
+    ? Encrypt(JSON.stringify(result))
+    : isString(result) || isNumber(result) ? result : JSON.stringify(result)
+  if (type === 'local') localStorage.setItem(getStorageKey(key, originKey), storageValue)
+  else if (type === 'cookie') setCookie(getStorageKey(key, originKey), storageValue)
+  else sessionStorage.setItem(getStorageKey(key, originKey), storageValue)
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019/12/3
+ * @lastTime    2019/12/3
+ * @description 删除Storage
+ */
+export function removeStorage({
+  key,
+  originKey,
+  type = 'local'
+}: {
+  key: string;
+  originKey?: boolean;
+  type?: 'local' | 'cookie' | 'session';
+}) {
+  if (type === 'local') localStorage.removeItem(getStorageKey(key, originKey))
+  else if (type === 'cookie') delCookie(getStorageKey(key, originKey))
+  else sessionStorage.removeItem(getStorageKey(key, originKey))
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 获取Cookie-name
+ */
+function getCookies(cname: string) {
+  const name = `${cname}=`
+  const decodedCookie = decodeURIComponent(document.cookie)
+  const ca = decodedCookie.split(';')
+  for (let i = 0; i < ca.length; i += 1) {
+    let c = ca[i]
+    while (c.charAt(0) === ' ') {
+      c = c.substring(1)
+    }
+    if (c.indexOf(name) === 0) {
+      return decodeURIComponent(c.substring(name.length, c.length))
+    }
+  }
+  return ''
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 获取Cookiedomin
+ */
+function GetCookieDomain() {
+  let host = location.hostname
+  const ip = /^(?:\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(?:\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(?:\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(?:\d{1,2}|1\d\d|2[0-4]\d|25[0-5])$/
+  if (ip.test(host) === true || host === 'localhost')
+    return host
+  // eslint-disable-next-line regexp/optimal-quantifier-concatenation
+  const regex = /([\s\S]*).*/
+  const match = host.match(regex)
+  if (typeof match !== 'undefined' && match !== null) {
+    const someIndex = 1
+    host = match[someIndex]
+  }
+  if (typeof host !== 'undefined' && host !== null) {
+    const strAry = host.split('.')
+    if (strAry.length > 1) {
+      host = `${strAry[strAry.length - 2]}.${strAry[strAry.length - 1]}`
+    }
+  }
+  return `.${host}`
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 设置Cookie
+ */
+export function setCookie(cname: string, cvalue: string, exdays?: number) {
+  const d = new Date()
+  d.setTime(d.getTime() + (exdays || 365) * 24 * 60 * 60 * 1000)
+  const expires = `=${d.toUTCString()}`
+  document.cookie = `${cname}=${encodeURIComponent(
+    cvalue
+  )}; expires=${expires}; domain=${GetCookieDomain()}; path=/`
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 获取Cookie
+ */
+export function getCookie(cname: string) {
+  const result = getCookies(cname)
+  if (result === '') {
+    return ''
+  }
+  return decodeURIComponent(result)
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 删除Cookie
+ */
+export function delCookie(name: string) {
+  const exp = new Date()
+  exp.setTime(exp.getTime() - 1)
+  const cval = getCookies(name)
+  if (cval !== null) {
+    document.cookie = `${name}=; expires=Thu, 01 Jan 1970 00:00:00 UTC; domain=${GetCookieDomain()}; path=/`
+  }
+}

package/template-mobile-vant-cli/src/utils/util.ts

@@ -0,0 +1,27 @@
+/**
+ * @Author      gx12358
+ * @DateTime    2021/11/3
+ * @lastTime    2021/11/3
+ * @description get参数处理
+ */
+export function tansParams(params) {
+  let result = ''
+  for (const propName of Object.keys(params)) {
+    const value = params[propName]
+    const part = encodeURIComponent(propName) + '='
+    if (value !== null && typeof (value) !== 'undefined' && value !== '') {
+      if (typeof value === 'object') {
+        for (const key of Object.keys(value)) {
+          if (value[key] !== null && typeof (value[key]) !== 'undefined') {
+            const params = propName + '[' + key + ']'
+            const subPart = encodeURIComponent(params) + '='
+            result += subPart + encodeURIComponent(value[key]) + '&'
+          }
+        }
+      } else {
+        result += part + encodeURIComponent(value) + '&'
+      }
+    }
+  }
+  return result
+}