1.使用Typescript重构axios(一)——写在最前面
2.使用Typescript重构axios(二)——项目起手,跑通流程
3.使用Typescript重构axios(三)——实现基础功能:处理get请求url参数
4.使用Typescript重构axios(四)——实现基础功能:处理post请求参数
5.使用Typescript重构axios(五)——实现基础功能:处理请求的header
6.使用Typescript重构axios(六)——实现基础功能:获取响应数据
7.使用Typescript重构axios(七)——实现基础功能:处理响应header
8.使用Typescript重构axios(八)——实现基础功能:处理响应data
9.使用Typescript重构axios(九)——异常处理:基础版
10.使用Typescript重构axios(十)——异常处理:增强版
11.使用Typescript重构axios(十一)——接口扩展
12.使用Typescript重构axios(十二)——增加参数
13.使用Typescript重构axios(十三)——让响应数据支持泛型
14.使用Typescript重构axios(十四)——实现拦截器
15.使用Typescript重构axios(十五)——默认配置
16.使用Typescript重构axios(十六)——请求和响应数据配置化
17.使用Typescript重构axios(十七)——增加axios.create
18.使用Typescript重构axios(十八)——请求取消功能:总体思路
19.使用Typescript重构axios(十九)——请求取消功能:实现第二种使用方式
20.使用Typescript重构axios(二十)——请求取消功能:实现第一种使用方式
21.使用Typescript重构axios(二十一)——请求取消功能:添加axios.isCancel接口
22.使用Typescript重构axios(二十二)——请求取消功能:收尾
23.使用Typescript重构axios(二十三)——添加withCredentials属性
24.使用Typescript重构axios(二十四)——防御XSRF攻击
25.使用Typescript重构axios(二十五)——文件上传下载进度监控
26.使用Typescript重构axios(二十六)——添加HTTP授权auth属性
27.使用Typescript重构axios(二十七)——添加请求状态码合法性校验
28.使用Typescript重构axios(二十八)——自定义序列化请求参数
29.使用Typescript重构axios(二十九)——添加baseURL
30.使用Typescript重构axios(三十)——添加axios.getUri方法
31.使用Typescript重构axios(三十一)——添加axios.all和axios.spread方法
32.使用Typescript重构axios(三十二)——写在最后面(总结)
项目源码请猛戳这里!!!
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,参数增加就已经完成了。
查看更多关于使用Typescript重构axios(十二)——增加参数的详细内容...