初始化仓库

src/http/README.md

@@ -0,0 +1,13 @@
+# 请求库
+
+目前unibest支持3种请求库：
+- 菲鸽简单封装的 `简单版本http`，路径（src/http/http.ts），对应的示例在 src/api/foo.ts
+- `alova 的 http`，路径（src/http/alova.ts），对应的示例在 src/api/foo-alova.ts
+- `vue-query`, 路径（src/http/vue-query.ts）, 目前主要用在自动生成接口，详情看(https://unibest.tech/base/17-generate)，示例在 src/service/app 文件夹
+
+## 如何选择
+如果您以前用过 alova 或者 vue-query，可以优先使用您熟悉的。
+如果您的项目简单，简单版本的http 就够了，也不会增加包体积。（发版的时候可以去掉alova和vue-query，如果没有超过包体积，留着也无所谓 ^_^）
+
+## roadmap
+菲鸽最近在优化脚手架，后续可以选择是否使用第三方的请求库，以及选择什么请求库。还在开发中，大概月底出来（7月31号）。

src/http/alova.ts

@@ -0,0 +1,111 @@
+import type { uniappRequestAdapter } from '@alova/adapter-uniapp'
+import type { IResponse } from './types'
+import AdapterUniapp from '@alova/adapter-uniapp'
+import { createAlova } from 'alova'
+import { createServerTokenAuthentication } from 'alova/client'
+import VueHook from 'alova/vue'
+import { toast } from '@/utils/toast'
+import { ContentTypeEnum, ResultEnum, ShowMessage } from './tools/enum'
+
+// 配置动态Tag
+export const API_DOMAINS = {
+  DEFAULT: import.meta.env.VITE_SERVER_BASEURL,
+  SECONDARY: import.meta.env.VITE_API_SECONDARY_URL,
+}
+
+/**
+ * 创建请求实例
+ */
+const { onAuthRequired, onResponseRefreshToken } = createServerTokenAuthentication<
+  typeof VueHook,
+  typeof uniappRequestAdapter
+>({
+  refreshTokenOnError: {
+    isExpired: (error) => {
+      return error.response?.status === ResultEnum.Unauthorized
+    },
+    handler: async () => {
+      try {
+        // await authLogin();
+      }
+      catch (error) {
+        // 切换到登录页
+        await uni.reLaunch({ url: '/pages/common/login/index' })
+        throw error
+      }
+    },
+  },
+})
+
+/**
+ * alova 请求实例
+ */
+const alovaInstance = createAlova({
+  baseURL: import.meta.env.VITE_APP_PROXY_PREFIX,
+  ...AdapterUniapp(),
+  timeout: 5000,
+  statesHook: VueHook,
+
+  beforeRequest: onAuthRequired((method) => {
+    // 设置默认 Content-Type
+    method.config.headers = {
+      ContentType: ContentTypeEnum.JSON,
+      Accept: 'application/json, text/plain, */*',
+      ...method.config.headers,
+    }
+
+    const { config } = method
+    const ignoreAuth = !config.meta?.ignoreAuth
+    console.log('ignoreAuth===>', ignoreAuth)
+    // 处理认证信息   自行处理认证问题
+    if (ignoreAuth) {
+      const token = 'getToken()'
+      if (!token) {
+        throw new Error('[请求错误]：未登录')
+      }
+      // method.config.headers.token = token;
+    }
+
+    // 处理动态域名
+    if (config.meta?.domain) {
+      method.baseURL = config.meta.domain
+      console.log('当前域名', method.baseURL)
+    }
+  }),
+
+  responded: onResponseRefreshToken((response, method) => {
+    const { config } = method
+    const { requestType } = config
+    const {
+      statusCode,
+      data: rawData,
+      errMsg,
+    } = response as UniNamespace.RequestSuccessCallbackResult
+
+    // 处理特殊请求类型（上传/下载）
+    if (requestType === 'upload' || requestType === 'download') {
+      return response
+    }
+
+    // 处理 HTTP 状态码错误
+    if (statusCode !== 200) {
+      const errorMessage = ShowMessage(statusCode) || `HTTP请求错误[${statusCode}]`
+      console.error('errorMessage===>', errorMessage)
+      toast.error(errorMessage)
+      throw new Error(`${errorMessage}：${errMsg}`)
+    }
+
+    // 处理业务逻辑错误
+    const { code, message, data } = rawData as IResponse
+    if (code !== ResultEnum.Success) {
+      if (config.meta?.toast !== false) {
+        toast.warning(message)
+      }
+      throw new Error(`请求错误[${code}]：${message}`)
+    }
+    // 处理成功响应，返回业务数据
+    return data
+  }),
+})
+
+export const http = alovaInstance

src/http/http.ts

@@ -0,0 +1,118 @@
+import type { CustomRequestOptions } from '@/http/types'
+
+export function http<T>(options: CustomRequestOptions) {
+  // 1. 返回 Promise 对象
+  return new Promise<IResData<T>>((resolve, reject) => {
+    uni.request({
+      ...options,
+      dataType: 'json',
+      // #ifndef MP-WEIXIN
+      responseType: 'json',
+      // #endif
+      // 响应成功
+      success(res) {
+        // 状态码 2xx，参考 axios 的设计
+        if (res.statusCode >= 200 && res.statusCode < 300) {
+          // 2.1 提取核心数据 res.data
+          resolve(res.data as IResData<T>)
+        }
+        else if (res.statusCode === 401) {
+          // 401错误  -> 清理用户信息，跳转到登录页
+          // userStore.clearUserInfo()
+          // uni.navigateTo({ url: '/pages/login/login' })
+          reject(res)
+        }
+        else {
+          // 其他错误 -> 根据后端错误信息轻提示
+          !options.hideErrorToast
+          && uni.showToast({
+            icon: 'none',
+            title: (res.data as IResData<T>).msg || '请求错误',
+          })
+          reject(res)
+        }
+      },
+      // 响应失败
+      fail(err) {
+        uni.showToast({
+          icon: 'none',
+          title: '网络错误，换个网络试试',
+        })
+        reject(err)
+      },
+    })
+  })
+}
+
+/**
+ * GET 请求
+ * @param url 后台地址
+ * @param query 请求query参数
+ * @param header 请求头，默认为json格式
+ * @returns
+ */
+export function httpGet<T>(url: string, query?: Record<string, any>, header?: Record<string, any>, options?: Partial<CustomRequestOptions>) {
+  return http<T>({
+    url,
+    query,
+    method: 'GET',
+    header,
+    ...options,
+  })
+}
+
+/**
+ * POST 请求
+ * @param url 后台地址
+ * @param data 请求body参数
+ * @param query 请求query参数，post请求也支持query，很多微信接口都需要
+ * @param header 请求头，默认为json格式
+ * @returns
+ */
+export function httpPost<T>(url: string, data?: Record<string, any>, query?: Record<string, any>, header?: Record<string, any>, options?: Partial<CustomRequestOptions>) {
+  return http<T>({
+    url,
+    query,
+    data,
+    method: 'POST',
+    header,
+    ...options,
+  })
+}
+/**
+ * PUT 请求
+ */
+export function httpPut<T>(url: string, data?: Record<string, any>, query?: Record<string, any>, header?: Record<string, any>, options?: Partial<CustomRequestOptions>) {
+  return http<T>({
+    url,
+    data,
+    query,
+    method: 'PUT',
+    header,
+    ...options,
+  })
+}
+
+/**
+ * DELETE 请求（无请求体，仅 query）
+ */
+export function httpDelete<T>(url: string, query?: Record<string, any>, header?: Record<string, any>, options?: Partial<CustomRequestOptions>) {
+  return http<T>({
+    url,
+    query,
+    method: 'DELETE',
+    header,
+    ...options,
+  })
+}
+
+http.get = httpGet
+http.post = httpPost
+http.put = httpPut
+http.delete = httpDelete
+
+// 支持与 alovaJS 类似的API调用
+http.Get = httpGet
+http.Post = httpPost
+http.Put = httpPut
+http.Delete = httpDelete

src/http/interceptor.ts

@@ -0,0 +1,65 @@
+import type { CustomRequestOptions } from '@/http/types'
+import { useUserStore } from '@/store'
+import { getEnvBaseUrl } from '@/utils'
+import { platform } from '@/utils/platform'
+import { stringifyQuery } from './tools/queryString'
+
+// 请求基准地址
+const baseUrl = getEnvBaseUrl()
+
+// 拦截器配置
+const httpInterceptor = {
+  // 拦截前触发
+  invoke(options: CustomRequestOptions) {
+    // 接口请求支持通过 query 参数配置 queryString
+    if (options.query) {
+      const queryStr = stringifyQuery(options.query)
+      if (options.url.includes('?')) {
+        options.url += `&${queryStr}`
+      }
+      else {
+        options.url += `?${queryStr}`
+      }
+    }
+    // 非 http 开头需拼接地址
+    if (!options.url.startsWith('http')) {
+      // #ifdef H5
+      // console.log(__VITE_APP_PROXY__)
+      if (JSON.parse(__VITE_APP_PROXY__)) {
+        // 自动拼接代理前缀
+        options.url = import.meta.env.VITE_APP_PROXY_PREFIX + options.url
+      }
+      else {
+        options.url = baseUrl + options.url
+      }
+      // #endif
+      // 非H5正常拼接
+      // #ifndef H5
+      options.url = baseUrl + options.url
+      // #endif
+      // TIPS: 如果需要对接多个后端服务，也可以在这里处理，拼接成所需要的地址
+    }
+    // 1. 请求超时
+    options.timeout = 10000 // 10s
+    // 2. （可选）添加小程序端请求头标识
+    options.header = {
+      platform, // 可选，与 uniapp 定义的平台一致，告诉后台来源
+      ...options.header,
+    }
+    // 3. 添加 token 请求头标识
+    const userStore = useUserStore()
+    const { token } = userStore.userInfo as unknown as IUserInfo
+    if (token) {
+      options.header.Authorization = `Bearer ${token}`
+    }
+  },
+}
+
+export const requestInterceptor = {
+  install() {
+    // 拦截 request 请求
+    uni.addInterceptor('request', httpInterceptor)
+    // 拦截 uploadFile 文件上传
+    uni.addInterceptor('uploadFile', httpInterceptor)
+  },
+}

src/http/tools/enum.ts

@@ -0,0 +1,66 @@
+export enum ResultEnum {
+  Success = 0, // 成功
+  Error = 400, // 错误
+  Unauthorized = 401, // 未授权
+  Forbidden = 403, // 禁止访问（原为forbidden）
+  NotFound = 404, // 未找到（原为notFound）
+  MethodNotAllowed = 405, // 方法不允许（原为methodNotAllowed）
+  RequestTimeout = 408, // 请求超时（原为requestTimeout）
+  InternalServerError = 500, // 服务器错误（原为internalServerError）
+  NotImplemented = 501, // 未实现（原为notImplemented）
+  BadGateway = 502, // 网关错误（原为badGateway）
+  ServiceUnavailable = 503, // 服务不可用（原为serviceUnavailable）
+  GatewayTimeout = 504, // 网关超时（原为gatewayTimeout）
+  HttpVersionNotSupported = 505, // HTTP版本不支持（原为httpVersionNotSupported）
+}
+export enum ContentTypeEnum {
+  JSON = 'application/json;charset=UTF-8',
+  FORM_URLENCODED = 'application/x-www-form-urlencoded;charset=UTF-8',
+  FORM_DATA = 'multipart/form-data;charset=UTF-8',
+}
+/**
+ * 根据状态码，生成对应的错误信息
+ * @param {number|string} status 状态码
+ * @returns {string} 错误信息
+ */
+export function ShowMessage(status: number | string): string {
+  let message: string
+  switch (status) {
+    case 400:
+      message = '请求错误(400)'
+      break
+    case 401:
+      message = '未授权，请重新登录(401)'
+      break
+    case 403:
+      message = '拒绝访问(403)'
+      break
+    case 404:
+      message = '请求出错(404)'
+      break
+    case 408:
+      message = '请求超时(408)'
+      break
+    case 500:
+      message = '服务器错误(500)'
+      break
+    case 501:
+      message = '服务未实现(501)'
+      break
+    case 502:
+      message = '网络错误(502)'
+      break
+    case 503:
+      message = '服务不可用(503)'
+      break
+    case 504:
+      message = '网络超时(504)'
+      break
+    case 505:
+      message = 'HTTP版本不受支持(505)'
+      break
+    default:
+      message = `连接出错(${status})!`
+  }
+  return `${message}，请检查网络或联系管理员！`
+}

src/http/tools/queryString.ts

@@ -0,0 +1,29 @@
+/**
+ * 将对象序列化为URL查询字符串，用于替代第三方的 qs 库，节省宝贵的体积
+ * 支持基本类型值和数组，不支持嵌套对象
+ * @param obj 要序列化的对象
+ * @returns 序列化后的查询字符串
+ */
+export function stringifyQuery(obj: Record<string, any>): string {
+  if (!obj || typeof obj !== 'object' || Array.isArray(obj))
+    return ''
+
+  return Object.entries(obj)
+    .filter(([_, value]) => value !== undefined && value !== null)
+    .map(([key, value]) => {
+      // 对键进行编码
+      const encodedKey = encodeURIComponent(key)
+
+      // 处理数组类型
+      if (Array.isArray(value)) {
+        return value
+          .filter(item => item !== undefined && item !== null)
+          .map(item => `${encodedKey}=${encodeURIComponent(item)}`)
+          .join('&')
+      }
+
+      // 处理基本类型
+      return `${encodedKey}=${encodeURIComponent(value)}`
+    })
+    .join('&')
+}

src/http/types.ts

@@ -0,0 +1,31 @@
+/**
+ * 在 uniapp 的 RequestOptions 和 IUniUploadFileOptions 基础上，添加自定义参数
+ */
+export type CustomRequestOptions = UniApp.RequestOptions & {
+  query?: Record<string, any>
+  /** 出错时是否隐藏错误提示 */
+  hideErrorToast?: boolean
+} & IUniUploadFileOptions // 添加uni.uploadFile参数类型
+
+// 通用响应格式
+export interface IResponse<T = any> {
+  code: number | string
+  data: T
+  message: string
+  status: string | number
+}
+
+// 分页请求参数
+export interface PageParams {
+  page: number
+  pageSize: number
+  [key: string]: any
+}
+
+// 分页响应数据
+export interface PageResult<T> {
+  list: T[]
+  total: number
+  page: number
+  pageSize: number
+}

src/http/vue-query.ts

@@ -0,0 +1,30 @@
+import type { CustomRequestOptions } from '@/http/types'
+import { http } from './http'
+
+/*
+ * openapi-ts-request 工具的 request 跨客户端适配方法
+ */
+export default function request<T = unknown>(
+  url: string,
+  options: Omit<CustomRequestOptions, 'url'> & {
+    params?: Record<string, unknown>
+    headers?: Record<string, unknown>
+  },
+) {
+  const requestOptions = {
+    url,
+    ...options,
+  }
+
+  if (options.params) {
+    requestOptions.query = requestOptions.params
+    delete requestOptions.params
+  }
+
+  if (options.headers) {
+    requestOptions.header = options.headers
+    delete requestOptions.headers
+  }
+
+  return http<T>(requestOptions)
+}