使用Typescript重构axios(十二)——增加参数

2023-08-27 21:17:34

0. 系列文章

项目源码请猛戳这里!!!

1. 前言

在上篇文章中，我们实现了混合对象axios，我们既可以把axios当做函数来调用，又能从它身上点出一些快捷接口使用。但是当我们把axios当做函数来调用时，该函数只能接受一个参数，那就是请求配置对象config，而官方的axios不仅能跟我们一样接收一个参数，它还支持接收两个参数：请求的url和除url外的其他配置对象config，像这样：

// 接收一个参数

axios({

  url: '/api/addParameters',

  method: 'post',

  data: {

    msg: 'hi'

  }

})

// 接收两个参数

axios('/api/addParameters', {

  method: 'post',

  data: {

    msg: 'hello'

  }

})

虽然这个功能好像看起来有点鸡肋，但是我们为了跟官方保持一致，接下来就来实现它。

2. 需求分析

一个函数在调用时既可以传一个参数也可以传两个参数，这就是函数的重载。

函数重载：在相同的声明域中的函数名相同的，而参数表不同的，即通过函数的参数表而唯一标识并且来区分函数的一种特殊的函数。

在一些强类型语言中，如C++、java等中，函数重载是个很重要的概念，而javaScript是门弱类型语言，它本身是没有函数重载这个概念的，但是我们可以通过一些技巧来模拟出函数重载的效果。

说了这么多，其实就想说，这个功能可以利用函数重载来实现。虽然JS没有重载，但是我们可以通过判断传入的参数不同来处理不同的逻辑，最终实现重载效果。

OK，接下来就让我们来实现这个功能吧。

3. 改写axios.request方法

我们知道，把混合对象axios当做函数调用时其实是调用了Axios类中的request方法，所以我们就在request方法里面实现函数的重载。

// src/core/Axios.ts

export default class Axios {

  request(url: any, config?:any): AxiosPromise {

    if (typeof url === "string") {

      config = config?config:{}

      config.url = url;

    } else {

      config = url;

    }

    return dispatchRequest(config);

  }

 // ...

}

代码说明：

我们给request方法增加一个参数url，并把url和config参数类型都设置为any;
然后判断传入的url是否为string类型，如果是，表明用户第一个参数传入了url，接着在判断是否传入了config，如果没有传入则赋给默认值空对象{}，然后再将传入的url赋给config中的url上;
如果传入的url不是string类型，我们就认为用户只传入了一个参数，并且该参数就是请求的配置对象config;
最后，依然是调用dispatchRequest(config)将请求发出；

总结一下就是：

如果传入的第一个参数是string类型，我们就认为用户是以传入两个参数的形式调用混合对象axios函数的，那么就把传入的url添加到config上再发出请求。

如果传入的第一个参数不是string类型，我们就认为用户是以传入一个参数的形式调用混合对象axios函数的，那么就把这个参数当做config发出请求。

最后，别忘了还要给混合对象axios接口类型上添加重载的函数类型：

export interface AxiosInstance extends Axios {

  (config: AxiosRequestConfig): AxiosPromise;

  (url: string, config?: AxiosRequestConfig): AxiosPromise;

}

OK，函数重载就已经实现完毕了，接下来，我们就来编写demo看看效果如何。

4. demo编写

在 examples 目录下创建 addParameters目录，在 addParameters目录下创建 index.html:

<!DOCTYPE html>

<html lang="en">

<head>

    <meta charset="UTF-8" />

    <title>addParameters demo</title>

</head>

<body>

<script src="/__build__/addParameters.js"></script>

</body>

</html>

接着再创建 app.ts 作为入口文件：

import axios from "../../src/axios";

axios({

  url: "/api/addParameters",

  method: "post",

  data: {

    msg: "hi"

  }

});

axios("/api/addParameters",{

  method: "post",

  data: {

    msg: "hello"

  }

});

接着在 server/server.js 添加新的接口路由：

// axios增加参数

router.post("/api/addParameters", function(req, res) {

  res.json(req.body);

});

最后在根目录下的index.html中加上启动该demo的入口：

<li><a href="examples/addParameters">addParameters</a></li>

OK,我们在命令行中执行：

# 同时开启客户端和服务端

npm run server | npm start

接着我们打开 chrome 浏览器，访问 http://localhost:8000/ 即可访问我们的 demo 了，我们点击 addParameters，通过F12的 network 部分我们可以看到所有的请求都已正常发出：

OK，参数增加就已经完成了。

码农公寓

0. 系列文章

1. 前言

2. 需求分析

3. 改写axios.request方法

4. demo编写

相关文章