@jetlinks-web/core 2.2.7 → 2.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jetlinks-web/core",
-  "version": "2.2.7",
+  "version": "2.2.8",
   "main": "index.ts",
   "module": "index.ts",
   "keywords": [
@@ -21,8 +21,8 @@
   "dependencies": {
     "axios": "^1.7.4",
     "rxjs": "^7.8.1",
-    "@jetlinks-web/constants": "^1.0.9",
     "@jetlinks-web/types": "^1.0.2",
+    "@jetlinks-web/constants": "^1.0.9",
     "@jetlinks-web/utils": "^1.2.8"
   },
   "publishConfig": {

package/src/axios.ts

@@ -1,4 +1,4 @@
-import { TOKEN_KEY, BASE_API } from '@jetlinks-web/constants'
+import { TOKEN_KEY, BASE_API, LOCAL_BASE_API } from '@jetlinks-web/constants'
 import {getToken, randomString} from '@jetlinks-web/utils'
 import axios from 'axios'
 import type {
@@ -87,7 +87,7 @@ const handleRequest = (config: InternalAxiosRequestConfig) => {
   requestRecords(config)
   const token = getToken();
   const lang = localStorage.getItem(_options.langKey)
-  const localBaseApi = localStorage.getItem('')
+  const localBaseApi = localStorage.getItem(LOCAL_BASE_API)
 
   if (lang) {
     config.headers[_options.langKey] = lang

package/src/axios.ts~

@@ -0,0 +1,419 @@
+import { TOKEN_KEY, BASE_API } from '@jetlinks-web/constants'
+import {getToken, randomString} from '@jetlinks-web/utils'
+import axios from 'axios'
+import type {
+  AxiosInstance,
+  AxiosResponse,
+  AxiosError,
+  InternalAxiosRequestConfig,
+} from 'axios'
+import type { AxiosResponseRewrite } from '@jetlinks-web/types'
+import {isFunction, isObject} from 'lodash-es'
+
+interface Options {
+
+  tokenExpiration: (err: AxiosError<any>, response: AxiosResponse) => void
+  handleReconnect: () => Promise<any>
+  filter_url?: Array<string>
+  code?: number
+  codeKey?: string
+  timeout?: number
+  handleRequest?: () => void
+  /**
+   * 用以获取localstorage中的lang
+   */
+  langKey?: string
+  /**
+   * response处理函数
+   * @param response AxiosResponse实例
+   */
+  handleResponse?: (response: AxiosResponse) => void
+  /**
+   * 错误处理函数
+   * @param msg 错误消息
+   * @param status 错误code
+   * @param error 错误实例
+   */
+  handleError?: (msg: string, status: string | number, error: AxiosError<any>) => void
+  requestOptions?: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Record<string, any>
+  isCreateTokenRefresh?: boolean
+}
+
+interface RequestOptions {
+  url?: string
+  method?: string
+  params?: any
+  data?: any
+  [key: string]: any
+}
+
+let instance: AxiosInstance
+let _options: Options = {
+  filter_url: [],
+  code: 200,
+  codeKey: 'status',
+  timeout: 1000 * 15,
+  handleRequest: undefined,
+  handleResponse: undefined,
+  handleError: undefined,
+  langKey: 'lang',
+  requestOptions: (config) => ({}),
+  tokenExpiration: () => {},
+  handleReconnect: () => Promise.resolve(),
+  isCreateTokenRefresh: false
+}
+
+let failedQueue = [];
+let isRefreshing = false;
+
+const isApp = (window as any).__MICRO_APP_ENVIRONMENT__
+
+const pendingRequests = new Map<string, AbortController>();
+const requestRecords = (config: InternalAxiosRequestConfig) => {
+  const key = randomString(32)
+
+  // 取消重复请求
+  if (pendingRequests.has(key)) {
+    pendingRequests.get(key)?.abort()
+  }
+
+  const controller = new AbortController()
+  config.signal = controller.signal;
+  config.__requestKey = key;
+
+  pendingRequests.set(key, controller)
+}
+const handleRequest = (config: InternalAxiosRequestConfig) => {
+  requestRecords(config)
+  const token = getToken();
+  const lang = localStorage.getItem(_options.langKey)
+  const localBaseApi = localStorage.getItem('')
+
+  if (lang) {
+    config.headers[_options.langKey] = lang
+  }
+
+  if (localBaseApi && !config.baseURL) {
+    const _url = config.url.startsWith('/') ? config.url : `/${config.url}`
+    config.url = localBaseApi + _url
+  }
+
+  // 没有token，并且该接口需要token校验
+  if (!token && !_options.filter_url?.some((url) => config.url?.includes(url))) {
+    // 跳转登录页
+    _options.tokenExpiration?.()
+    return config
+  }
+
+  if (!config.headers[TOKEN_KEY]) {
+    config.headers[TOKEN_KEY] = token
+  }
+
+  if (_options.requestOptions && isFunction(_options.requestOptions)) {
+    const extraOptions = _options.requestOptions(config)
+    if (extraOptions && isObject(extraOptions)) {
+      for (const key in extraOptions) {
+        config[key] = extraOptions[key]
+      }
+    }
+  }
+
+  return config
+}
+
+const handleResponse = (response: AxiosResponse) => {
+  if (_options.handleResponse && isFunction(_options.handleResponse)) {
+    return _options.handleResponse(response)
+  }
+
+  const __key = response.config?.__requestKey
+  if(__key){
+    pendingRequests.delete(__key)
+  }
+
+  if (response.data instanceof ArrayBuffer) {
+    return response
+  }
+
+  const status = response.data[_options.codeKey || 'status']
+
+// 增加业务接口处理成功判断方式，只需要判断返回参数包含：success为true
+  if (
+    typeof response.data === 'object' &&
+    typeof response.data.success === 'undefined'
+  ) {
+    response.data.success = status === _options.code
+  }
+
+  return response.data
+}
+
+const createTokenRefreshHandler = async (err) => {
+  const originalRequest = err.config;
+  if (isRefreshing) { // 记录之后失败的请求
+    return new Promise((resolve, reject) => {
+      failedQueue.push({ resolve, reject });
+    }).then((_token) => {
+      originalRequest.headers[TOKEN_KEY] = _token;
+      return instance(originalRequest)
+    }).catch(err => Promise.reject(err))
+  }
+  originalRequest._retry = true;
+  isRefreshing = true;
+  try {
+    const loginResult = await _options.handleReconnect?.()
+    if(loginResult){
+      const token = getToken() // 更新请求头, 修改全部的token
+      originalRequest.headers[TOKEN_KEY] = token;
+      failedQueue.forEach(a => a.resolve(token));
+      return instance(originalRequest);
+    }
+  } catch (err) {
+    failedQueue.forEach(cb => cb.reject(err));
+    throw err;
+  } finally {
+    failedQueue = [];
+    isRefreshing = false;
+  }
+}
+const errorHandler = async (err: AxiosError<any>) => {
+  let description = err.response?.message || 'Error'
+  let _status: string | number = 0
+  if (err.response) {
+    const {data, status} = err.response
+    _status = status
+    switch (status) {
+      case 400:
+      case 403:
+      case 500:
+        description = (`${data?.message}`).substring(0, 90)
+        break;
+      case 401:
+        description = err.response.data.result?.text || '用户未登录';
+        _options.tokenExpiration?.(err)
+        if(_options.isCreateTokenRefresh){
+          return createTokenRefreshHandler(err)
+        }
+        break;
+      case 404:
+        description = err?.response?.data?.message || `${data?.error} ${data?.path}`
+        break;
+      default:
+        break;
+    }
+  } else if (err.response === undefined) {
+    description = err.message.includes('timeout') ? '接口响应超时' : err.message
+    _status = 'timeout'
+  }
+
+  if (_options.handleError && isFunction(_options.handleError)) {
+    _options.handleError(description, _status, err)
+  }
+
+  return Promise.reject(err)
+}
+
+export const abortAllRequests = () => {
+  pendingRequests.forEach(controller => controller.abort())
+  pendingRequests.clear()
+}
+
+export const crateAxios = (options: Options) => {
+  if (options) {
+    _options = Object.assign(_options, options)
+  }
+
+  instance = axios.create({
+    withCredentials: false,
+    timeout: _options.timeout,
+    baseURL: BASE_API
+  })
+
+  instance.interceptors.request.use(
+    handleRequest,
+    errorHandler
+  )
+
+  instance.interceptors.response.use(
+    handleResponse,
+    errorHandler
+  )
+}
+
+export const post = <T = any>(url: string, data: any = {}, ext?: any) => {
+  return (instance<any, AxiosResponseRewrite<T>>({
+    method: 'POST',
+    url,
+    data,
+    ...ext,
+  }))
+}
+
+export const get = <T = any>(url: string, params: any = undefined, ext?: any) => {
+  return instance<any, AxiosResponseRewrite<T>>({
+    method: 'GET',
+    url,
+    params,
+    ...ext,
+  })
+}
+
+export const put = <T = any>(url: string, data: any = {}, ext?: any) => {
+  return instance<any, AxiosResponseRewrite<T>>({
+    method: 'PUT',
+    url,
+    data,
+    ...ext,
+  })
+}
+
+export const patch = <T = any>(url: string, data: any = {}, ext?: any) => {
+  return instance<any, AxiosResponseRewrite<T>>({
+    method: 'patch',
+    url,
+    data,
+    ...ext,
+  })
+}
+
+export const remove = <T = any>(url: string, params: any = undefined, ext?: any) => {
+  return instance<any, AxiosResponseRewrite<T>>({
+    method: 'DELETE',
+    url,
+    params,
+    ...ext,
+  })
+}
+
+export const getStream = (url: string, params?: any, ext?: any) => {
+  return get(url, params, { responseType: 'arraybuffer', ...ext })
+}
+
+export const postStream = (url: string, data: any, ext?: any) => {
+  return post(url, data, { responseType: 'arraybuffer', ...ext })
+}
+
+export const request = {
+  post, get, put, patch, remove, getStream, postStream
+}
+
+export class Request {
+  modulePath: string
+
+  constructor(modulePath: string) {
+    this.modulePath = modulePath
+  }
+
+  /**
+   * 分页查询
+   * @param {object} data 查询参数
+   * @param {object} options 请求配置
+   * @returns {Promise<AxiosResponse<any>>} 分页查询结果
+   */
+  page(data: any={}, options: RequestOptions= {
+    url: undefined,
+    method: undefined,
+  }) {
+    const { url='/_query', method = 'post', ...rest } = options
+    return request[method](`${this.modulePath}${url}`, data, rest)
+  }
+
+  /**
+   * 不分页查询
+   * @param {object} data 查询参数
+   * @param {object} options 请求配置
+   * @returns {Promise<AxiosResponse<any>>} 不分页查询结果
+   */
+  noPage(data: any={}, options: RequestOptions = {
+    url: undefined,
+    method: undefined,
+  }) {
+    const { url='/_query/no-page', method = 'post', ...rest } = options
+    return request[method](`${this.modulePath}${url}`, { paging: false, ...data}, rest)
+  }
+
+  /**
+   * 详情查询
+   * @param {string} id 详情ID
+   * @param {object} params 查询参数
+   * @param {object} options 请求配置
+   * @returns {Promise<AxiosResponse<any>>} 详情查询结果
+   */
+  detail(id: string, params?: any, options: RequestOptions= {
+    url: undefined,
+    method: undefined,
+  }) {
+    const { url=`/${id}/detail`, method = 'get', ...rest } = options
+    return request[method](`${this.modulePath}${url}`, params, rest)
+  }
+
+  /**
+   * 保存
+   * @param {object} data 保存参数
+   * @param {object} options 请求配置
+   * @returns {Promise<AxiosResponse<any>>} 保存结果
+   */
+  save(data: any={}, options: RequestOptions = {
+    url: undefined,
+    method: undefined,
+  }) {
+    const { url=`/_create`, method = 'post', ...rest } = options
+    return request[method](`${this.modulePath}${url}`, data, rest)
+  }
+
+  /**
+   * 更新
+   * @param {object} data 更新参数
+   * @param {object} options 请求配置
+   * @returns {Promise<AxiosResponse<any>>} 更新结果
+   */
+  update(data: any={}, options: RequestOptions = {
+    url: undefined,
+    method: undefined,
+  }) {
+    const { url=`/_update`, method = 'patch', ...rest } = options
+    return patch(`${this.modulePath}${url}`, data, rest)
+  }
+
+  /**
+   * 删除
+   * @param {string} id 删除ID
+   * @param {object} options 请求配置
+   * @returns {Promise<AxiosResponse<any>>} 删除结果
+   */
+  delete(id: string, params?: any, options: RequestOptions = {
+    url: undefined,
+    method: undefined,
+  }) {
+    const { url=`/${id}`, method = 'post', ...rest } = options
+    return remove(`${this.modulePath}${url}`, params, rest)
+  }
+
+  post(...args) {
+    const [url, data, options] = args
+    return post(`${this.modulePath}${url}`, data, options)
+  }
+
+  get(...args) {
+    const [url, params, options] = args
+    return get(`${this.modulePath}${url}`, params, options)
+  }
+
+  put(...args) {
+    const [url, data, options] = args
+    return put(`${this.modulePath}${url}`, data, options)
+  }
+
+  patch(...args) {
+    const [url, data, options] = args
+    return patch(`${this.modulePath}${url}`, data, options)
+  }
+
+  remove(...args) {
+    const [url, params, options] = args
+    return remove(`${this.modulePath}${url}`, params, options)
+  }
+}
+
+
+