feat: 支持合并自定义配置

#38

Author: zjxxxxxxxxx

docs/config/adapter.md

@@ -13,6 +13,8 @@ axios.defaults.adapter = function adapter(adapterConfig) {
     url,
     // 请求方法
     method,
+    // 请求参数
+    params,
     // 请求数据
     data,
     // 请求头 同 headers
@@ -53,7 +55,7 @@ axios.defaults.adapter = function adapter(adapterConfig) {
       return wx.downloadFile({
         url,
         method,
-        filePath: data.filePath,
+        filePath: params.filePath,
         header: headers,
         success,
         fail,

global.d.ts

@@ -1,12 +1 @@
-declare const uni: unknown;
-declare const wx: unknown;
-declare const my: unknown;
-declare const swan: unknown;
-declare const tt: unknown;
-declare const qq: unknown;
-declare const qh: unknown;
-declare const ks: unknown;
-declare const dd: unknown;
-declare const jd: unknown;
-
 type AnyObject<T = any> = Record<string, T>;

global.variables.d.ts

@@ -0,0 +1,10 @@
+declare const uni: unknown;
+declare const wx: unknown;
+declare const my: unknown;
+declare const swan: unknown;
+declare const tt: unknown;
+declare const qq: unknown;
+declare const qh: unknown;
+declare const ks: unknown;
+declare const dd: unknown;
+declare const jd: unknown;

rollup.config.js

@@ -23,7 +23,7 @@ function main() {
 function buildConfig(format) {
   const isDts = format === 'dts';
   const output = {
-    file: resolvePath(format, isDts),
+    file: resolveOutput(format, isDts),
     format: isDts ? 'es' : format,
     name: pkg.name,
     exports: 'default',
@@ -51,7 +51,7 @@ function buildConfig(format) {
   };
 }
 
-function resolvePath(format, isDts) {
+function resolveOutput(format, isDts) {
   return path.resolve(
     distPath,
     `${pkg.name}${isDts ? '.d.ts' : `.${format}.js`}`,

scripts/test.utils.ts

@@ -8,7 +8,7 @@ export function asyncTimeout(delay = 0) {
   return new Promise((resolve) => setTimeout(resolve, delay));
 }
 
-export function captureError<T = any>(fn: () => void): T {
+export function captureError<T = any>(fn: () => void) {
   try {
     fn();
     throw new Error('without Error');
@@ -17,7 +17,7 @@ export function captureError<T = any>(fn: () => void): T {
   }
 }
 
-export function cleanedStack(error: Error) {
+export function checkStack(error: Error) {
   if (error.stack) {
     return error.stack.indexOf('at') === error.stack.indexOf('at /');
   }
@@ -28,7 +28,7 @@ export function noop() {
   return;
 }
 
-export function mockResponse(
+export function mockResponseBase(
   status: number,
   statusText: string,
   headers: AnyObject,
@@ -42,12 +42,15 @@ export function mockResponse(
   };
 }
 
-export function mockSuccess(headers: AnyObject = {}, data: AnyObject = {}) {
-  return mockResponse(200, 'OK', headers, data);
+export function mockResponse(headers: AnyObject = {}, data: AnyObject = {}) {
+  return mockResponseBase(200, 'OK', headers, data);
 }
 
-export function mockFail(headers: AnyObject = {}, data: AnyObject = {}) {
-  return mockResponse(400, 'FAIL', headers, data);
+export function mockResponseError(
+  headers: AnyObject = {},
+  data: AnyObject = {},
+) {
+  return mockResponseBase(400, 'FAIL', headers, data);
 }
 
 export interface MockAdapterOptions {
@@ -58,29 +61,39 @@ export interface MockAdapterOptions {
   after?: () => void;
 }
 
-export function mockAdapter(
-  type: 'success' | 'fail',
+export function mockAdapterBase(
+  type: 'success' | 'error' | 'fail' = 'success',
   options: MockAdapterOptions = {},
 ) {
   const { headers = {}, data = {}, delay = 0, before, after } = options;
 
   return (config: AxiosAdapterRequestConfig) => {
     before?.(config);
     setTimeout(() => {
-      if (type === 'success') {
-        config.success(mockSuccess(headers, data));
-      } else {
-        config.fail(mockFail(headers, data));
+      switch (type) {
+        case 'success':
+          config.success(mockResponse(headers, data));
+          break;
+        case 'error':
+          config.success(mockResponseError(headers, data));
+          break;
+        case 'fail':
+          config.fail(mockResponseError(headers));
+          break;
       }
       after?.();
     }, delay);
   };
 }
 
-export function mockAdapterSuccess(options: MockAdapterOptions = {}) {
-  return mockAdapter('success', options);
+export function mockAdapter(options: MockAdapterOptions = {}) {
+  return mockAdapterBase('success', options);
+}
+
+export function mockAdapterError(options: MockAdapterOptions = {}) {
+  return mockAdapterBase('error', options);
 }
 
 export function mockAdapterFail(options: MockAdapterOptions = {}) {
-  return mockAdapter('fail', options);
+  return mockAdapterBase('fail', options);
 }

src/core/Axios.ts

@@ -198,20 +198,34 @@ export default class Axios {
     this.defaults = defaults;
 
     for (const alias of Axios.as) {
-      this[alias] = (url, config) => {
-        return this._req(alias, url, undefined, config);
+      this[alias] = (url, config = {}) => {
+        return this.request({
+          ...config,
+          method: alias,
+          url,
+        });
       };
     }
 
     for (const alias of Axios.pas) {
-      this[alias] = (url, params, config) => {
-        return this._req(alias, url, params, config);
+      this[alias] = (url, params, config = {}) => {
+        return this.request({
+          ...config,
+          method: alias,
+          params,
+          url,
+        });
       };
     }
 
     for (const alias of Axios.das) {
       this[alias] = (url, data, config) => {
-        return this._reqWithData(alias, url, data, config);
+        return this.request({
+          ...config,
+          method: alias,
+          data,
+          url,
+        });
       };
     }
   }
@@ -249,32 +263,4 @@ export default class Axios {
 
     return promiseResponse as Promise<AxiosResponse<TData>>;
   }
-
-  private _req<TData = unknown>(
-    method: AxiosRequestMethod,
-    url: string,
-    params?: AnyObject,
-    config?: AxiosRequestConfig,
-  ): Promise<AxiosResponse<TData>> {
-    return this.request<TData>({
-      ...(config ?? {}),
-      method,
-      url,
-      params,
-    });
-  }
-
-  private _reqWithData<TData = unknown>(
-    method: AxiosRequestMethod,
-    url: string,
-    data?: AnyObject | AxiosRequestFormData,
-    config?: AxiosRequestConfig,
-  ): Promise<AxiosResponse<TData>> {
-    return this.request<TData>({
-      ...(config ?? {}),
-      method,
-      url,
-      data,
-    });
-  }
 }

src/core/dispatchRequest.ts

@@ -27,32 +27,28 @@ export default function dispatchRequest<TData = unknown>(
     config.transformRequest,
   );
 
-  return request<TData>(config).then(
-    (response: AxiosResponse<TData>) => {
-      throwIfCancellationRequested(config);
-
-      response.data = transformData(
-        response.data as AnyObject,
-        response.headers,
-        config.transformResponse,
-      ) as TData;
+  function transformer(response: AxiosResponse<TData>) {
+    response.data = transformData(
+      response.data as AnyObject,
+      response.headers,
+      config.transformResponse,
+    ) as TData;
+  }
 
+  return request<TData>(config)
+    .then((response: AxiosResponse<TData>) => {
+      throwIfCancellationRequested(config);
+      transformer(response);
       return response;
-    },
-    (reason: unknown) => {
+    })
+    .catch((reason: unknown) => {
       if (!isCancel(reason)) {
         throwIfCancellationRequested(config);
-
-        if (isPlainObject(reason) && isPlainObject(reason.response)) {
-          reason.response.data = transformData(
-            reason.response.data,
-            reason.response.headers,
-            config.transformResponse,
-          );
+        const response = (reason as AnyObject)?.response;
+        if (isPlainObject(response)) {
+          transformer(response as AxiosResponse<TData>);
         }
       }
-
       throw config.errorHandler?.(reason) ?? reason;
-    },
-  );
+    });
 }

src/core/mergeConfig.ts

@@ -2,69 +2,54 @@ import { isUndefined, isPlainObject } from '../helpers/isTypes';
 import { deepMerge } from '../helpers/deepMerge';
 import { AxiosRequestConfig } from './Axios';
 
-type AxiosRequestConfigKey = keyof AxiosRequestConfig;
-
-const onlyFromConfig2Keys: AxiosRequestConfigKey[] = [
-  'url',
-  'method',
-  'data',
-  'upload',
-  'download',
-];
-const priorityFromConfig2Keys: AxiosRequestConfigKey[] = [
-  'adapter',
-  'baseURL',
-  'paramsSerializer',
-  'transformRequest',
-  'transformResponse',
-  'errorHandler',
-  'cancelToken',
-  'dataType',
-  'responseType',
-  'timeout',
-  'enableHttp2',
-  'enableQuic',
-  'enableCache',
-  'sslVerify',
-  'validateStatus',
-  'onUploadProgress',
-  'onDownloadProgress',
-];
-const deepMergeConfigKeys: AxiosRequestConfigKey[] = ['headers', 'params'];
+const fromConfig2Map: Record<string, boolean> = {
+  url: true,
+  method: true,
+  data: true,
+  upload: true,
+  download: true,
+};
+const deepMergeConfigMap: Record<string, boolean> = {
+  headers: true,
+  params: true,
+};
 
 export function mergeConfig(
   config1: AxiosRequestConfig = {},
   config2: AxiosRequestConfig = {},
 ): AxiosRequestConfig {
   const config: AxiosRequestConfig = {};
 
-  for (const key of onlyFromConfig2Keys) {
-    const value = config2[key];
-
-    if (!isUndefined(value)) {
-      config[key] = value as any;
-    }
-  }
+  // 所有已知键名
+  const keysSet = Array.from(
+    new Set([...Object.keys(config1), ...Object.keys(config2)]),
+  );
 
-  for (const key of priorityFromConfig2Keys) {
-    const value1 = config1[key];
-    const value2 = config2[key];
+  for (const key of keysSet) {
+    const val1 = config1[key] as any;
+    const val2 = config2[key] as any;
 
-    if (!isUndefined(value2)) {
-      config[key] = value2 as any;
-    } else if (!isUndefined(value1)) {
-      config[key] = value1 as any;
+    // 只从 config2 中取值
+    if (fromConfig2Map[key]) {
+      if (!isUndefined(val2)) config[key] = val2;
     }
-  }
-
-  for (const key of deepMergeConfigKeys) {
-    const value1 = config1[key];
-    const value2 = config2[key];
-
-    if (isPlainObject(value2)) {
-      config[key] = deepMerge(value1 ?? {}, value2) as any;
-    } else if (isPlainObject(value1)) {
-      config[key] = deepMerge(value1) as any;
+    // 深度合并 config1 和 config2 中的对象
+    else if (deepMergeConfigMap[key]) {
+      if (isPlainObject(val1) && isPlainObject(val2)) {
+        config[key] = deepMerge(val1, val2);
+      } else if (isPlainObject(val1)) {
+        config[key] = deepMerge(val1);
+      } else if (isPlainObject(val2)) {
+        config[key] = deepMerge(val2);
+      }
+    }
+    // 优先从 config2 中取值，如果没有值就从 config1 中取值
+    else {
+      if (!isUndefined(val2)) {
+        config[key] = val2;
+      } else if (!isUndefined(val1)) {
+        config[key] = val1;
+      }
     }
   }