VUE3封装axios调用接口

在src的api文件夹下添加一个request.js

import axios from 'axios';
import { ElMessage } from 'element-plus'

const http = axios.create({
  baseURL: '', // 基础URL
  timeout: 10 * 1000, // 请求超时时间
  // 其他配置...
});
 
// 请求拦截器
http.interceptors.request.use(
  config => {
    // 可以在这里添加认证token等
    // if (store.getters.token) {
    //   config.headers['Authorization'] = `Bearer ${store.getters.token}`;
    // }
    return config;
  },
  error => {
    // 请求错误处理
    return Promise.reject(error);
  }
);
 
// 响应拦截器
http.interceptors.response.use(
  response => {
    // 对响应数据做处理,例如只返回data部分
    console.log(response, "response")
    if (response.status == 200 && response.data.code == 200) {
      return response.data;
    } else {
      ElMessage.error(response.data.msg)
      return Promise.reject(response.data.msg)
    }
  },
  error => {
    // 响应错误处理
    console.log(error, "error")
    return Promise.reject(error);
  }
);
 
export default http;

分模块调用如首页接口:

在src下建立一个home.js

import request from './request';
 
// 合作与留言的接口
export function addContact(data) {
  return request({
    url: '/function/contact/addContact',
    method: 'post',
    data: data
  })
}

使用你的数据接口

引入:

import { listDept } from '../../api/enter'

使用:

onMounted(() => {
    let obj = {
        parentId: 100
    }
    listDept(obj).then(response => {
        response.data.forEach(item => {
            item.hasChildren = Boolean(item.hasChildren)
        })
        deptList.value = response.data
    });
})

<think>首先,用户的问题是:“我想在Vue3项目中使用TypeScript封装Axios请求接口 请问vue3 typescript 封装 axios 请求方法”。这基于之前的引用内容,这些引用是关于在Vue3和TypeScript中封装Axios的。 我需要遵循系统级指令: - 所有行内数学表达式使用$...$格式(但这里没有数学表达式,所以可能不适用)。 - 独立公式用$$...$$(同样,不适用)。 - LaTeX语法正确(不适用)。 - 使用中文回答。 - 生成相关问题。 - 在回答中引用的段落末尾自然地添加引用标识,如[^1]。 - 回答结构清晰,帮助用户逐步解决问题。 - 保证回答真实可靠。 参考的引用内容: - [^1]: 描述了在Vue3中安装Axios和设置Vue.prototype,以及如何在组件中使用。 - [^2]: 展示了在Vue3 setup函数中直接调用Axios。 - [^3]: 讨论了封装Axios实例,使用拦截器处理请求和响应。 - [^4]: 提到了类型问题,如config.headers可能未定义,建议降级Axios版本或处理。 用户的问题是封装Axios请求接口,所以我需要提供一个清晰的、逐步的指南来封装AxiosVue3项目中。 回答结构: 1. **介绍**:简要解释为什么要封装Axios(例如,统一处理错误、设置请求头等)。 2. **步骤**:分步指导如何封装。 - 安装依赖。 - 创建Axios实例。 - 添加拦截器。 - 定义请求方法。 - 在Vue组件中使用。 3. **代码示例**:使用TypeScript代码块展示。 4. **处理常见问题**:如类型错误(参考[^4])。 5. **生成相关问题**:在最后添加相关问题。 使用中文回答。 生成相关问题:在回答末尾添加,如示例所示。 引用标识:在回答中引用参考内容时,自然地添加[^n]。例如,提到类型问题时引用[^4]。 确保回答真实可靠:基于Vue3和TypeScript的最佳实践。 大纲回答: 1. **引言**:解释封装Axios的好处(如代码复用、错误处理)。 2. **步骤**: - 步骤1: 安装Axios和TypeScript支持。 - 步骤2: 创建Axios实例文件(如request.ts)。 - 步骤3: 配置Axios实例(设置baseURL、超时等)。 - 步骤4: 添加请求和响应拦截器(处理认证、错误等)。 - 步骤5: 定义请求方法(如get, post)。 - 步骤6: 在Vue组件中使用封装的方法。 3. **代码示例**:提供完整的代码。 4. **注意事项**:讨论类型问题(如config.headers)。 5. **相关问题**:生成2-3个相关问题。 相关问题示例: 1. 如何在封装中处理请求超时? 2. 如何添加全局加载状态? 3. 如何测试封装Axios请求? 现在,构建回答。</think>### Vue3 + TypeScript 封装 Axios 请求方法指南 在 Vue3 项目中结合 TypeScript 封装 Axios 请求接口,可以提升代码复用性、统一处理错误和请求逻辑,避免在多个组件中重复编写 Axios 调用代码。下面我将一步步指导你完成封装过程,确保方法可靠且易于维护。封装的核心是创建一个自定义 Axios 实例,并添加拦截器来处理通用逻辑(如认证、错误处理),最后导出类型安全的请求方法供组件使用。 #### 步骤 1: 安装依赖 首先,确保项目已安装 Axios 和 TypeScript 相关依赖。使用 npm 或 yarn 安装: ```bash npm install axios vue-axios -S # 安装 AxiosVue 集成插件 npm install @types/node -D # 确保类型支持(可选,但推荐) ``` #### 步骤 2: 创建 Axios 实例文件 在 `src` 目录下新建文件 `src/utils/request.ts`,用于封装 Axios 实例。这里我们定义基础配置、拦截器和请求方法。 ```typescript // src/utils/request.ts import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, AxiosError } from &#39;axios&#39;; // 创建 Axios 实例 const service: AxiosInstance = axios.create({ baseURL: &#39;https://your-api-base-url.com&#39;, // 替换为你的 API 基础 URL timeout: 10000, // 请求超时时间(毫秒) headers: { &#39;Content-Type&#39;: &#39;application/json&#39;, // 默认请求头 }, }); // 请求拦截器:处理请求前逻辑(如添加 token) service.interceptors.request.use( (config: AxiosRequestConfig) => { // 添加认证 token(示例) const token = localStorage.getItem(&#39;token&#39;); if (token && config.headers) { config.headers.Authorization = `Bearer ${token}`; // 确保 headers 存在[^4] } return config; }, (error: AxiosError) => { // 请求错误处理 console.error(&#39;Request Error:&#39;, error); return Promise.reject(error); } ); // 响应拦截器:处理响应数据 service.interceptors.response.use( (response: AxiosResponse) => { // 统一处理响应数据(如提取 data 字段) if (response.status === 200) { return response.data; // 直接返回响应数据 } return response; }, (error: AxiosError) => { // 统一处理错误(如 HTTP 错误码) console.error(&#39;Response Error:&#39;, error.response?.data); return Promise.reject(error); } ); // 定义泛型请求方法(支持 GET、POST 等) export function request<T = any>(config: AxiosRequestConfig): Promise<T> { return service(config); } // 导出具体方法(可选:封装常用方法) export const get = <T>(url: string, params?: any) => request<T>({ method: &#39;GET&#39;, url, params }); export const post = <T>(url: string, data?: any) => request<T>({ method: &#39;POST&#39;, url, data }); // 导出实例供特殊需求使用 export default service; ``` #### 步骤 3: 在 Vue 组件中使用封装方法 在 Vue 组件中导入封装的请求方法,并调用 API。使用 TypeScript 类型确保数据安全。 ```typescript // 示例组件:src/components/UserComponent.vue <script lang="ts"> import { defineComponent } from &#39;vue&#39;; import { get, post } from &#39;@/utils/request&#39;; // 导入封装方法 interface User { id: number; name: string; } export default defineComponent({ setup() { // 获取用户数据(GET 请求) const fetchUsers = async () => { try { const users = await get<User[]>(&#39;/api/users&#39;); // 指定响应类型 console.log(&#39;Users:&#39;, users); } catch (error) { console.error(&#39;Fetch Error:&#39;, error); } }; // 创建用户(POST 请求) const createUser = async () => { try { const newUser = { name: &#39;John Doe&#39; }; const result = await post<User>(&#39;/api/users&#39;, newUser); // 指定响应类型 console.log(&#39;Created User:&#39;, result); } catch (error) { console.error(&#39;Create Error:&#39;, error); } }; // 在生命周期或事件中调用 onMounted(() => { fetchUsers(); }); return { createUser }; }, }); </script> ``` #### 关键注意事项 1. **类型安全**:使用 TypeScript 泛型(如 `get<T>()`)确保响应数据类型正确,避免运行时错误。 2. **拦截器处理**:在拦截器中统一添加认证、错误日志等,减少组件代码冗余[^3]。 3. **headers 问题**:在请求拦截器中,检查 `config.headers` 是否未定义(Axios 类型更新可能导致此问题),可通过条件判断处理[^4]。如果遇到类型错误,考虑降级 Axios 版本(如 `npm install axios@1.1.3`)或更新类型定义。 4. **全局加载状态**:结合 Vue3 的 `reactive` 对象,可以在拦截器中添加加载状态管理[^3]。 #### 性能与最佳实践 - **代码复用**:封装后,所有请求逻辑集中管理,便于维护和扩展。 - **错误处理**:拦截器捕获全局错误,避免在每个请求中重复 try-catch。 - **测试建议**:使用 Jest 测试封装的请求方法,模拟 API 响应确保可靠性。 通过以上步骤,你可以高效地在 Vue3 + TypeScript 项目中封装 Axios 请求接口。如果需要更复杂的逻辑(如文件上传或 WebSocket 集成),可以基于此框架扩展。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值