前端请求Axios+TS封装

本文介绍了如何使用Axios库进行HTTP请求的安装和封装,创建了一个名为HttpRequest的类来管理默认配置、拦截器,并在Vue应用中通过Pinia状态管理库进行调用。

axios

  • 安装
pnpm i axios
封装axios.request方法
// utils/http.ts
import axios,{type AxiosInstance,type AxiosRequestConfig} from 'axios';

class HttpRequest {
   private defaults: AxiosRequestConfig;
   private instance: AxiosInstance = {} as AxiosInstance;;
  constructor(options:AxiosRequestConfig){
    this.defaults = {
      baseURL: ''
    }
    this.defaults = Object.assign(this.defaults, options);
  }
  interceptors(install:AxiosInstance){
    install.interceptors.request.use(
      config => {
        let token = localStorage.getItem('token');
        if (token) {  // 判断是否存在token,如果存在的话,则每个http header都加上token
          config.headers!.authorization = `token ${token}`;
        }
        return config;
      },
      err => {
        return Promise.reject(err);
      }
    );
    install.interceptors.response.use(
      res => {
        const { data, status } = res;
        return data;
      },
      err => {
        return Promise.reject(err);
      }
    );
  }
  request(options:AxiosRequestConfig){
    options = Object.assign(this.defaults, options)
    const instance = axios.create(options)
    this.interceptors(this.instance);
    return this.instance
  }
}

const request = new HttpRequest({
  baseURL: '/api'
});
export default request;
对请求进行封装
// api/user.ts
import http from '@/utils/http'
export const getUserInfo = () => {
  return http.request({
    url: '/getUserInfo',
    method: 'get'
  })
}
调用
import { getUserInfo } from '@/api/user'
import { defineStore } from 'pinia'
import {ref} from 'vue'
export const useUserStore = defineStore('user', ()=>{
    const userInfo = getUserInfo()
})
随着前端工程化进一步普及,前端代码规模和复杂度不断提高,前端对于后端API的依赖越来越重要。为了避免重复造轮子和提高开发效率,前端开发中经常会使用第三方HTTP客户端库来封装和管理与后端API的交互。而axios是目前较为流行的HTTP客户端库之一。 在开发中,封装axios是一种较为常见的做法。而在使用TypeScript开发时,通过接口、类型别名等特性,可以进一步提升封装axios的体验和安全性。 以下是在React项目中封装axios的一些思路和示例代码: 1. 安装axios和@types/axios ```bash npm install axios @types/axios ``` 2. 创建axios实例 ```typescript import axios from 'axios'; const instance = axios.create({ baseURL: 'https://api.example.com/', timeout: 5000, headers: { 'Content-Type': 'application/json', }, }); ``` 在创建实例时,我们可以配置一些公共选项,如baseURL、timeout、headers等。这样可以避免在每个请求中都重复设置这些选项。 3. 封装请求方法 ```typescript import { AxiosRequestConfig, AxiosResponse } from 'axios'; interface HttpResponse<T> extends AxiosResponse { data: T; } interface Options extends AxiosRequestConfig { url: string; } function request<T = any>(options: Options): Promise<HttpResponse<T>> { return instance.request<T>(options).then((response) => response.data); } export default request; ``` 在封装请求方法时,我们通过泛型和接口定义了请求响应类型,使得在使用时可以轻松推断出响应数据类型。同时,也提供了options类型,使得使用时更加简洁和直观。 4. 使用示例 ```typescript import request from './request'; interface User { id: number; name: string; email: string; } function getUser(id: number): Promise<User> { return request<User>({ url: `/users/${id}`, method: 'get', }); } async function test() { const user = await getUser(1); console.log(user); } test(); ``` 在使用封装axios时,我们只需要按照自己定义的接口类型,传递对应的参数即可。通过这种方式,我们可以大大减少代码中的硬编码和类型错误,提高代码的可读性和健壮性。 总的来说,封装axios是React项目中的一项常见工作,使用TypeScript可以进一步提升封装的体验和质量。在实践中,我们可以根据具体场景灵活运用接口、类型别名、泛型等特性,来构建出更符合自己项目需要的axios封装方案。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小源学AI

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值