手写axios库中参数配置的设计与实现
在使用axios
库时,用户在发送请求的时候可以传入一个配置,来决定请求的不同行为。同时axios
也有默认配置,定义一些默认的行为。这样在发送每个请求,用户传递的配置可以和默认配置做一层合并。
官网axios
对象上有一个 defaults
属性,表示默认配置,你甚至可以直接修改这些默认配置:
axios.defaults.headers.common['test'] = 123
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded'
axios.defaults.timeout = 2000
其中对于 headers
的默认配置支持 common
和一些请求 method
字段,common
表示对于任何类型的请求都要添加该属性,而 method
表示只有该类型请求方法才会添加对应的属性。
在上述例子中,会默认为所有请求的 header
添加 test
属性,会默认为 post
请求的 header
添加 Content-Type
属性。
现在我们要实现一个官方库axios
的参数配置实现。
默认配置
默认配置定义
首先定义一个 defaults
常量,它包含默认请求的方法、超时时间,以及 headers
配置。
// defaults.ts
import { AxiosRequestConfig } from './types'
const defaults: AxiosRequestConfig = {
method: 'get',
timeout: 0,
headers: {
common: {
Accept: 'application/json, text/plain, */*'
}
}
}
// 对于没有请求体的方法
const methodsNoData = ['delete', 'get', 'head', 'options']
methodsNoData.forEach(method => {
defaults.headers[method] = {}
})
const methodsWithData = ['post', 'put', 'patch']
// 对于有请求体的方法,content-type有一个默认值,即表单格式
methodsWithData.forEach(method => {
defaults.headers[method] = {
'Content-Type': 'application/x-www-form-urlencoded'
}
})
export default defaults
添加到 axios 对象中
根据需求,我们要给 axios
对象添加一个 defaults
属性,表示默认配置:
export default class Axios {
defaults: AxiosRequestConfig
interceptors: Interceptors
constructor(initConfig: AxiosRequestConfig) {
this.defaults = initConfig
this.interceptors = {
request: new InterceptorManager<AxiosRequestConfig>(),
response: new InterceptorManager<AxiosResponse>()
}
}
// ...
}
我们给 Axios
类添加一个 defaults
成员属性,并且让 Axios
的构造函数接受一个 initConfig
对象,把 initConfig
赋值给 this.defaults
。
接着修改 createInstance
方法,支持传入 config
对象。
import defaults from './defaults'
function createInstance(config: AxiosRequestConfig): AxiosStatic {
const context = new Axios(config)
const instance = Axios.prototype.request.bind(context)
extend(instance, context)
return instance as AxiosStatic
}
const axios = createInstance(defaults)
这样我们就可以在执行 createInstance
创建 axios
对象的时候,把默认配置传入了。
配置合并及策略
定义了默认配置后,我们发送每个请求的时候需要把自定义配置和默认配置做合并,它并不是简单的 2 个普通对象的合并,对于不同的字段合并,会有不同的合并策略。举个例子:
config1 = {
method: 'get',
timeout: 0,
headers: {
common: {
Accept: 'application/json, text/plain, */*'
}
}
}
config2 = {
url: '/config/post',
method: 'post',
data: {
a: 1
},
headers: {
test: '321'
}
}
merged = {
url: '/config/post',
method: 'post',
data: {
a: 1
},
timeout: 0,
headers: {
common: {
Accept: 'application/json, text/plain, */*'
}
test: '321'
}
}
我们在 core/mergeConfig.ts
中实现合并方法。
合并方法
export default function mergeConfig(
config1: AxiosRequestConfig,
config2?: AxiosRequestConfig
): AxiosRequestConfig {
if (!config2) {
config2 = {}
}
const config = Object.create(null)
for (let key in config2) {
mergeField(key)
}
for (let key in config1) {
if (!config2[key]) {
mergeField(key)
}
}
// 在 `mergeField` 方法中会针对不同的属性使用不同的合并策略
function mergeField(key: string): void {
const strat = strats[key] || defaultStrat
config[key] = strat(config1[key], config2![key])
}
return config
}
合并方法的整体思路就是对 config1
和 config2
中的属性遍历,执行 mergeField
方法做合并,这里 config1
代表默认配置,config2
代表自定义配置。
遍历过程中,我们会通过 config2[key]
这种索引的方式访问,所以需要给 AxiosRequestConfig
的接口定义添加一个字符串索引签名:
export interface AxiosRequestConfig {
// ...
[propName: string]: any
}
默认合并策略
这是大部分属性的合并策略,如下:
function defaultStrat(val1: any, val2: any): any {
return typeof val2 !== 'undefined' ? val2 : val1
}
它很简单,如果有 val2
则返回 val2
,否则返回 val1
,也就是如果自定义配置中定义了某个属性,就采用自定义的,否则就用默认配置。
只接受自定义配置合并策略
对于一些属性如 url
、params
、data
,合并策略如下:
const strats = Object.create(null)
function fromVal2Strat(val1: any, val2: any): any {
if (typeof val2 !== 'undefined') {
return val2
}
}
const stratKeysFromVal2 = ['url', 'params', 'data']
stratKeysFromVal2.forEach(key => {
strats[key] = fromVal2Strat
})
因为对于 url
、params
、data
这些属性,默认配置显然是没有意义的,它们是和每个请求强相关的,所以我们只从自定义配置中获取。
复杂对象合并策略
对于一些属性如 headers
,合并策略如下:
function deepMergeStrat(val1: any, val2: any): any {
if (isPlainObject(val2)) {
return deepMerge(val1, val2)
} else if (typeof val2 !== 'undefined') {
return val2
} else if (isPlainObject(val1)) {
return deepMerge(val1)
} else if (typeof val1 !== 'undefined') {
return val1
}
}
const stratKeysDeepMerge = ['headers']
stratKeysDeepMerge.forEach(key => {
strats[key] = deepMergeStrat
})
// helpers/util.ts
export function deepMerge(...objs: any[]): any {
const result = Object.create(null)
objs.forEach(obj => {
if (obj) {
Object.keys(obj).forEach(key => {
const val = obj[key]
if (isPlainObject(val)) {
if (isPlainObject(result[key])) {
result[key] = deepMerge(result[key], val)
} else {
result[key] = deepMerge({}, val)
}
} else {
result[key] = val
}
})
}
})
return result
}
对于 headers
这类的复杂对象属性,我们需要使用深拷贝的方式,同时也处理了其它一些情况,因为它们也可能是一个非对象的普通值。
这段深度合并的代码非常有意思,在遍历的时候后面的元素会不断的覆盖前面元素的值,如果value
是对象,就递归调用。
最后我们在 request
方法里添加合并配置的逻辑:
config = mergeConfig(this.defaults, config)
flatten headers
经过合并后的配置中的 headers
是一个复杂对象,多了 common
、post
、get
等属性,而这些属性中的值才是我们要真正添加到请求 header
中的。
举个例子:
headers: {
common: {
Accept: 'application/json, text/plain, */*'
},
post: {
'Content-Type':'application/x-www-form-urlencoded'
}
}
我们需要把它压成一级的,如下:
headers: {
Accept: 'application/json, text/plain, */*',
'Content-Type':'application/x-www-form-urlencoded'
}
这里要注意的是,对于 common
中定义的 header
字段,我们都要提取,而对于 post
、get
这类提取,需要和该次请求的方法对应。
接下来我们实现 flattenHeaders
方法,helpers/header.ts
:
export function flattenHeaders(headers: any, method: Method): any {
if (!headers) {
return headers
}
headers = deepMerge(headers.common || {}, headers[method] || {}, headers)
const methodsToDelete = ['delete', 'get', 'head', 'options', 'post', 'put', 'patch', 'common']
methodsToDelete.forEach(method => {
delete headers[method]
})
return headers
}
我们可以通过 deepMerge
的方式把 common
、post
的属性拷贝到 headers
这一级,然后再把 common
、post
这些属性删掉。
然后我们在真正发送请求前执行这个逻辑,core/dispatchRequest.ts
:
function processConfig(config: AxiosRequestConfig): void {
config.url = transformURL(config)
config.headers = transformHeaders(config)
config.data = transformRequestData(config)
config.headers = flattenHeaders(config.headers, config.method!)
}
请求和响应配置化
官方的 axios 库 给默认配置添加了 transformRequest
和 transformResponse
两个字段,它们的值是一个数组或者是一个函数。
其中 transformRequest
允许你在将请求数据发送到服务器之前对其进行修改,这只适用于请求方法 put
、post
和 patch
,如果值是数组,则数组中的最后一个函数必须返回一个字符串或 FormData
、URLSearchParams
、Blob
等类型作为 xhr.send
方法的参数,而且在 transform
过程中可以修改 headers
对象。
而 transformResponse
允许你在把响应数据传递给 then
或者 catch
之前对它们进行修改。
当值为数组的时候,数组的每一个函数都是一个转换函数,数组中的函数就像管道一样依次执行,前者的输出作为后者的输入。
举个例子:
axios({
transformRequest: [(function(data) {
return qs.stringify(data)
}), ...axios.defaults.transformRequest],
transformResponse: [axios.defaults.transformResponse, function(data) {
if (typeof data === 'object') {
data.b = 2
}
return data
}],
url: '/config/post',
method: 'post',
data: {
a: 1
}
})
其实逻辑也是非常简单的,就是依次执行转换函数:
export default function transform(
data: any,
headers: any,
fns?: AxiosTransformer | AxiosTransformer[]
): any {
if (!fns) {
return data
}
if (!Array.isArray(fns)) {
fns = [fns]
}
// 因为xhr.send只能发送blob或者字符串,所以data是一个普通类型,因此需要重新赋值,而headers是一个引用类型所以无需赋值
fns.forEach(fn => {
data = fn(data, headers)
})
return data
}
transform
函数中接收 data
、headers
、fns
3 个参数,其中 fns
代表一个或者多个转换函数,内部逻辑很简单,遍历 fns
,执行这些转换函数,并且把 data
和 headers
作为参数传入,每个转换函数返回的 data
会作为下一个转换函数的参数 data
传入。
接下来修改对请求数据和响应数据的处理逻辑,dispatchRequest.ts
:
import transform from './transform'
function processConfig(config: AxiosRequestConfig): void {
config.url = transformURL(config)
config.data = transform(config.data, config.headers, config.transformRequest)
config.headers = flattenHeaders(config.headers, config.method!)
}
function transformResponseData(res: AxiosResponse): AxiosResponse {
res.data = transform(res.data, res.headers, res.config.transformResponse)
return res
}
我们把对请求数据的处理和对响应数据的处理改成使用 transform
函数实现,并把配置中的 transformRequest
及 transformResponse
分别传入。
扩展 axios.create 静态接口
目前为止,我们的 axios 都是一个单例,一旦我们修改了 axios 的默认配置,会影响所有的请求。我们希望提供了一个 axios.create
的静态接口允许我们创建一个新的 axios
实例,同时允许我们传入新的配置和默认配置合并,并做为新的默认配置。
举个例子:
const instance = axios.create({
transformRequest: [(function(data) {
return qs.stringify(data)
}), ...(axios.defaults.transformRequest as AxiosTransformer[])],
transformResponse: [...(axios.defaults.transformResponse as AxiosTransformer[]), function(data) {
if (typeof data === 'object') {
data.b = 2
}
return data
}]
})
instance({
url: '/config/post',
method: 'post',
data: {
a: 1
}
})
create
函数可以接受一个 AxiosRequestConfig
类型的配置,作为默认配置的扩展,也可以接受不传参数。接着我们来实现 axios.create
静态方法。
function createInstance(config: AxiosRequestConfig): AxiosStatic {
const context = new Axios(config)
const instance = Axios.prototype.request.bind(context)
extend(instance, context)
return instance as AxiosStatic
}
axios.create = function create(config) {
return createInstance(mergeConfig(defaults, config))
}
转载自:https://juejin.cn/post/7137586279998292005