TS+Axios二次封装

学Ts也有一段时间了,虽然并没有特别难,但是在写的时候还是有很多不习惯的地方,然后想到了之前用js封装的axios,就想着用ts二次封装一下,也是百度了一些资料,才封装好。

为什么要二次封装

其实axios就挺好的,不封装也完全够用,而且axios里边也有拦截器的一些配置,但是进行二次封装的话更加方便的对接口进行管理,如果要换访问接口形式的话也更加方便修改

具体代码

import axios from "axios";

import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";

interface HYIntercepton<T = AxiosResponse> {
  requsetSuccessFn?: (config: AxiosRequestConfig) => AxiosRequestConfig;
  requsetFailureFn?: (err: any) => any;
  responseSuccessFn?: (res: T) => T;
  responseFailureFn?: (err: any) => any;
}
//这里可以添加自己的拦截器对其进行一个更加精细的控制
interface HYRequestConfig<T = AxiosResponse> extends AxiosRequestConfig {
  interceptors?: HYIntercepton<T>;
}




class HYRequest {
  // request实例=>axios的实例
  instance: AxiosInstance;
  constructor(config: HYRequestConfig) {
    this.instance = axios.create(config);
    // 每个实例都添加一个拦截器
    // 发送拦截器
    this.instance.interceptors.request.use(
      (config) => {
        //  全局请求成功的拦截
        // config.headers.Authorization = "";
        return config;
      },
      (err) => {
        console.log("全局请求失败的拦截器");
        return err;
      }
    );
    // 响应拦截器
    this.instance.interceptors.response.use(
      (res) => {
        console.log("全局响应成功的拦截");
        // 这里返回的是res.data
        return res.data;
      },
      (err) => {
        console.log("全局响应失败的拦截");
        return err;
      }
    );
    // 针对特定的添加拦截器
    this.instance.interceptors.request.use(
      config.interceptors?.requsetSuccessFn,
      config.interceptors?.requsetFailureFn
    );
    this.instance.interceptors.response.use(
      config.interceptors?.responseSuccessFn,
      config.interceptors?.responseFailureFn
    );
  }

  //   封装网络请求的方法(这里传入一个泛型T可以对返回进行限制)
  request<T = any>(config: HYRequestConfig<T>) {
    // 单次请求的成功拦截处理
    if (config.interceptors?.requsetSuccessFn) {
      config = config.interceptors.requsetSuccessFn(config);
    }
    // 返回Promise
    return new Promise<T>((resolve, reject) => {
      this.instance
        .request<any, T>(config)
        .then((res) => {
          /* 
          全局拦截器里边已经有了返回res.data
          这里拿到的是后端返回的结果,并对其进行二次限制
          */
          // 单次响应的成功拦截处理
          if (config.interceptors?.responseSuccessFn) {
            res = config.interceptors.responseSuccessFn(res);
          }
          resolve(res);
        })
        .catch((err) => {
          reject(err);
        });
    });
  }
  //
  get<T = any>(config: HYRequestConfig<T>) {
    return this.request({ ...config, method: "GET" });
  }
  post<T = any>(config: HYRequestConfig<T>) {
    return this.request({ ...config, method: "POST" });
  }
  delete<T = any>(config: HYRequestConfig<T>) {
    return this.request({ ...config, method: "DELETE" });
  }
  patch<T = any>(config: HYRequestConfig<T>) {
    return this.request({ ...config, method: "PATCH" });
  }
}

export default HYRequest;

总结

这里的代码更多的都是看王老师的一个代码,不由得感慨大佬的思路,之后也要不断的练习ts,还有从这个封装中也学到了很多知识。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Vue 3和TypeScript的Axios二次封装可以提供更好的代码可维护性和可扩展性。下面是一个示例: 首先,你需要安装axios和@types/axios(用于TypeScript类型定义): ``` npm install axios npm install @types/axios ``` 然后,在你的项目中创建一个`api`文件夹,并在其中创建一个`http.ts`文件,用于封装Axios。 ```typescript import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'; // 创建一个Axios实例 const instance: AxiosInstance = axios.create({ baseURL: 'http://your-api-base-url.com', // 替换为你的API基础URL timeout: 5000, // 设置请求超时时间 }); // 请求拦截器 instance.interceptors.request.use( (config: AxiosRequestConfig) => { // 在发送请求之前做一些处理,例如添加请求头等 // config.headers['Authorization'] = 'Bearer ' + token; return config; }, (error) => { // 处理请求错误 return Promise.reject(error); } ); // 响应拦截器 instance.interceptors.response.use( (response: AxiosResponse) => { // 对响应数据进行处理 // 可以根据实际情况进行全局错误处理、数据转换等 return response.data; }, (error) => { // 处理响应错误 return Promise.reject(error); } ); export default instance; ``` 接下来,在需要使用Axios的地方导入`http.ts`文件,并使用封装好的Axios实例进行网络请求。 ```typescript import http from '@/api/http'; // 示例API请求方法 export const getUser = () => { return http.get('/user'); }; export const createUser = (data: any) => { return http.post('/user', data); }; // 其他API请求方法... ``` 这样,你就可以在Vue组件或其他地方使用这些封装好的API请求方法了。 ```typescript import { getUser } from '@/api/user'; export default { created() { this.fetchUser(); }, methods: { async fetchUser() { try { const user = await getUser(); // 处理返回的用户数据 } catch (error) { // 处理请求错误 } }, }, }; ``` 这就是Vue 3和TypeScript的Axios二次封装的基本示例。你可以根据你的项目需求进一步扩展和优化这个封装
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值