ray-template/apps/docs/guide/requests.md
2026-11-05 10:03:54 +08:00

4.6 KiB
Raw Blame History

接口、取消与 Mock

业务代码调用 apps/admin/src/api 中的函数,后者使用 @/axios 的 request。成功时实例直接解析为响应体 T,失败会拒绝;接口还包了一层业务响应时,由业务层继续解析。需要原始响应头或状态码时,使用保留完整响应的 Axios 实例。

交互示例

::: details 查看示例源码 <<< @/../admin/src/views/demo/axios/index.tsx :::

接入请求和取消

import { request } from '@/axios'

interface Order {
  id: string
  customer: string
}

export function loadOrders(
  params: Record<string, unknown>,
  signal: AbortSignal,
) {
  return request<{ data: Order[]; total: number }>({
    method: 'get',
    url: '/api/orders',
    params,
    signal,
    cancelConfig: { cancel: false },
  })
}

默认取消器按 URL、方法、参数和请求体识别重复请求,默认布局在路由更新前取消受管理的请求。示例将信号交给 TablePro 管理,所以关闭模板的默认注入;否则默认取消器会替换调用方传入的 signal。后台任务禁用默认取消后,需要自行管理生命周期。

配置与拦截器

  • apps/admin/src/app-config/request-config.ts:统一修改 baseURL、超时和默认 headers。
  • apps/admin/src/axios/axios-interceptor/{request,response}/provider.ts:登记插件;请求头、鉴权响应等放入对应的 plugins。
  • useRequest 包装同一请求实例,放在有效的 Vue effect 作用域内使用。

从演示切到真实服务

开发时人员列表请求 GET /api/list,由 Vite Mock 中间件处理。GitHub Pages 只能提供静态文件;插件 build: true 生成的 独立 Mock 服务 需要 Node.js 进程。Pages 打包会跳过 mockServer/。

Pages 上「远端分页」与「查询与分页」直接按需加载 apps/admin/src/demo-data/people.ts,与开发接口复用筛选、排序和分页实现,访问不依赖 /api/list。用 pnpm pages:build 构建后,将 dist/pages 挂载在静态站点的 /ray-template/ 路径,打开 /ray-template/#/tables/remote 验证。不要用 Vite 的接口响应判断 Pages 是否具备 API 能力。

若后续有多个示例必须连同 Axios 拦截器一起演练,可以在演示构建显式启用 MSW 浏览器拦截,将 worker 放在 /ray-template/ 下并等待注册后再启动应用。需要真实认证、共享写入或 HTTP 服务端行为时,另部署 API。业务项目应换成自己的 API 和会话;浏览器端 VITE_* 变量不能放密钥。

请求实例 · 演示接口

useRequest 与手动执行

useRequest<Response>(fetchOptions, options?) 从 @/axios 导入,使用模板 Axios 实例执行同一份配置。options 传给 vue-hooks-plus,例如 manual、成功和失败回调。返回的数据、错误、加载状态与运行方法来自上游 Hook。应用在 setup 或有效 effect scope 内创建它。

import { useRequest } from '@/axios'

export function useOrderSummary() {
  return useRequest<{ total: number }>(
    { url: '/api/orders/summary', method: 'get' },
    { manual: true },
  )
}

调用 run() 触发手动加载。这个包装的请求函数从 fetchOptions 读取配置,不会把 run(...) 参数自动映射成请求体或 query;需要动态 service 时用同入口导出的 useHookPlusRequest(service, options?),在 service 中调用 request。错误提示由业务配置或响应拦截器负责,当前默认拦截器不消费 responseSuccessMessage / responseErrorMessage 两个类型字段。

默认头注入包含演示 X-TOKEN 与示例头。对接真实接口时在请求插件中校验目标来源,并按后端约定设置认证头。模板 Axios 实例用来请求自己的业务接口;第三方地址使用明确配置的独立客户端。

请求 Hook · 请求配置类型 · 头注入实现