Merge pull request #21 from fluffff/adapter

refactor: 优化 adapter

src/axios.ts

@@ -20,7 +20,7 @@ export interface AxiosStatic extends AxiosInstance {
   Axios: AxiosConstructor;
   CancelToken: CancelTokenConstructor;
   create(defaults?: AxiosRequestConfig): AxiosInstance;
-  createAdapter(platform: AxiosPlatform): AxiosAdapter | undefined;
+  createAdapter(platform: AxiosPlatform): AxiosAdapter;
   isCancel(value: any): boolean;
 }
 

src/core/Axios.ts

@@ -1,7 +1,7 @@
 import { buildURL } from '../helpers/url';
 import { mergeConfig } from './mergeConfig';
 import {
-  AdapterRequestMethod,
+  AxiosAdapterRequestMethod,
   AxiosAdapter,
   AxiosAdapterTask,
 } from './adapter';
@@ -20,7 +20,9 @@ export type AxiosRequestMethodAlias =
   | 'trace'
   | 'connect';
 
-export type AxiosRequestMethod = AdapterRequestMethod | AxiosRequestMethodAlias;
+export type AxiosRequestMethod =
+  | AxiosAdapterRequestMethod
+  | AxiosRequestMethodAlias;
 
 export type AxiosRequestHeaders = AnyObject;
 

src/core/adapter.ts

@@ -16,9 +16,9 @@ import {
   AxiosResponseError,
 } from './Axios';
 
-export type AdapterRequestType = 'request' | 'download' | 'upload';
+export type AxiosAdapterRequestType = 'request' | 'download' | 'upload';
 
-export type AdapterRequestMethod =
+export type AxiosAdapterRequestMethod =
   | 'OPTIONS'
   | 'GET'
   | 'HEAD'
@@ -29,20 +29,20 @@ export type AdapterRequestMethod =
   | 'CONNECT';
 
 export interface AxiosAdapterRequestConfig extends AxiosRequestConfig {
-  type: AdapterRequestType;
+  type: AxiosAdapterRequestType;
-  method: AdapterRequestMethod;
+  method: AxiosAdapterRequestMethod;
   url: string;
   success(response: AxiosResponse): void;
   fail(error: AxiosResponseError): void;
 }
 
-export interface AxiosAdapterRequestOptions extends AxiosAdapterRequestConfig {
+export interface AxiosAdapterBaseOptions extends AxiosAdapterRequestConfig {
   header?: AxiosRequestHeaders;
   success(response: any): void;
   fail(error: any): void;
 }
 
-export interface AxiosAdapterUploadOptions extends AxiosAdapterRequestOptions {
+export interface AxiosAdapterUploadOptions extends AxiosAdapterBaseOptions {
   filePath: string;
   name: string;
   fileName: string;
@@ -51,14 +51,13 @@ export interface AxiosAdapterUploadOptions extends AxiosAdapterRequestOptions {
   formData?: AxiosRequestData;
 }
 
-export interface AxiosAdapterDownloadOptions
+export interface AxiosAdapterDownloadOptions extends AxiosAdapterBaseOptions {
-  extends AxiosAdapterRequestOptions {
   filePath?: string;
   fileName?: string;
 }
 
 export interface AxiosAdapterRequest {
-  (config: AxiosAdapterRequestOptions): AxiosAdapterTask | void;
+  (config: AxiosAdapterBaseOptions): AxiosAdapterTask | void;
 }
 
 export interface AxiosAdapterUpload {
@@ -144,6 +143,23 @@ export function createAdapter(platform: AxiosPlatform): AxiosAdapter {
     }
   }
 
+  function transformOptions(
+    config: AxiosAdapterRequestConfig,
+  ): AxiosAdapterBaseOptions {
+    return {
+      ...config,
+      header: config.headers,
+      success(response: any): void {
+        transformResult(response);
+        config.success(response);
+      },
+      fail(error: any): void {
+        transformResult(error);
+        config.fail(error);
+      },
+    };
+  }
+
   function injectDownloadData(response: any): void {
     if (!isPlainObject(response.data)) {
       response.data = {};
@@ -165,36 +181,27 @@ export function createAdapter(platform: AxiosPlatform): AxiosAdapter {
     }
   }
 
-  function requestAdapter(
+  function callRequest(
     request: AxiosAdapterRequest,
-    config: AxiosAdapterRequestConfig,
+    baseOptions: AxiosAdapterBaseOptions,
   ): AxiosAdapterTask | void {
-    const options = Object.assign({}, config, {
+    return request(baseOptions);
-      header: config.headers,
-      success(response: any): void {
-        transformResult(response);
-        config.success(response);
-      },
-      fail(error: any): void {
-        transformResult(error);
-        config.fail(error);
-      },
-    });
-
-    return request(options);
   }
 
-  function uploadAdapter(
+  function callUpload(
     upload: AxiosAdapterUpload,
-    config: AxiosAdapterRequestConfig,
+    baseOptions: AxiosAdapterBaseOptions,
   ): AxiosAdapterTask | void {
-    assert(isPlainObject(config.data), '上传文件时 data 需要是一个 object');
     assert(
-      isString(config.data!.fileName),
+      isPlainObject(baseOptions.data),
+      '上传文件时 data 需要是一个 object',
+    );
+    assert(
+      isString(baseOptions.data!.fileName),
       '上传文件时 data.fileName 需要是一个 string',
     );
     assert(
-      isString(config.data!.filePath),
+      isString(baseOptions.data!.filePath),
       '上传文件时 data.filePath 需要是一个 string',
     );
 
@@ -204,46 +211,33 @@ export function createAdapter(platform: AxiosPlatform): AxiosAdapter {
       fileType,
       hideLoading,
       ...formData
-    } = config.data as AxiosRequestFormData;
+    } = baseOptions.data as AxiosRequestFormData;
-    const options = Object.assign({}, config, {
+    const options = {
-      header: config.headers,
+      ...baseOptions,
       name: fileName,
       fileName: fileName,
       filePath,
       fileType: fileType ?? 'image',
       hideLoading,
       formData,
-      success(response: any): void {
+    };
-        transformResult(response);
-        config.success(response);
-      },
-      fail(error: any): void {
-        transformResult(error);
-        config.fail(error);
-      },
-    });
 
     return upload(options);
   }
 
-  function downloadAdapter(
+  function callDownload(
     download: AxiosAdapterDownload,
-    config: AxiosAdapterRequestConfig,
+    baseOptions: AxiosAdapterBaseOptions,
   ): AxiosAdapterTask | void {
-    const options = Object.assign({}, config, {
+    const options = {
-      header: config.headers,
+      ...baseOptions,
-      filePath: config.params?.filePath,
+      filePath: baseOptions.params?.filePath,
-      fileName: config.params?.fileName,
+      fileName: baseOptions.params?.fileName,
       success(response: any): void {
         injectDownloadData(response);
-        transformResult(response);
+        baseOptions.success(response);
-        config.success(response);
       },
-      fail(error: any): void {
+    };
-        transformResult(error);
-        config.fail(error);
-      },
-    });
 
     return download(options);
   }
@@ -251,13 +245,15 @@ export function createAdapter(platform: AxiosPlatform): AxiosAdapter {
   return function adapterDefault(
     config: AxiosAdapterRequestConfig,
   ): AxiosAdapterTask | void {
+    const baseOptions = transformOptions(config);
+
     switch (config.type) {
       case 'request':
-        return requestAdapter(platform.request, config);
+        return callRequest(platform.request, baseOptions);
       case 'upload':
-        return uploadAdapter(platform.upload, config);
+        return callUpload(platform.upload, baseOptions);
       case 'download':
-        return downloadAdapter(platform.download, config);
+        return callDownload(platform.download, baseOptions);
       default:
         throwError(`无法识别的请求类型 ${config.type}`);
     }

src/core/generateType.ts

@@ -1,9 +1,11 @@
 import { toLowerCase } from '../helpers/utils';
-import { AdapterRequestType } from './adapter';
+import { AxiosAdapterRequestType } from './adapter';
 import { AxiosRequestConfig, AxiosRequestMethodAlias } from './Axios';
 
-export function generateType(config: AxiosRequestConfig): AdapterRequestType {
+export function generateType(
-  let requestType: AdapterRequestType = 'request';
+  config: AxiosRequestConfig,
+): AxiosAdapterRequestType {
+  let requestType: AxiosAdapterRequestType = 'request';
 
   const method = toLowerCase<AxiosRequestMethodAlias>(config.method, 'get');
 

src/core/request.ts

@@ -2,7 +2,7 @@ import { isFunction, isPlainObject } from '../helpers/is';
 import { assert, toUpperCase } from '../helpers/utils';
 import {
   AxiosAdapterRequestConfig,
-  AdapterRequestMethod,
+  AxiosAdapterRequestMethod,
   AxiosAdapterTask,
 } from './adapter';
 import { AxiosRequestConfig, AxiosResponse, AxiosResponseError } from './Axios';
@@ -41,7 +41,7 @@ export function request<TData = any>(
       ...config,
       url: config.url ?? '',
       type: generateType(config),
-      method: toUpperCase<AdapterRequestMethod>(config.method, 'GET'),
+      method: toUpperCase<AxiosAdapterRequestMethod>(config.method, 'GET'),
       success,
       fail,
     };