Class RequestTemplate<CC>`Abstract`

请求封装基类

使用模板方法模式处理请求封装抽象类, 具体类可实现protected的方法替换掉原有方法，需要实现抽象方法

可参考@request-template/axios @request-template/wechat

See

Example

// 主请求封装类
export class PrimaryRequest<CC extends CustomConfig = CustomConfig> extends RequestTemplate<CC> {
  protected fetch(ctx: RetryContext<CC>): Promise<any> {
    // 在此使用自己熟悉的请求工具重写fetch方法
    return Promise.resolve(undefined);
  }

  protected handleCanceler(ctx: Context<CC>): void {
    // 在此重写如何挂载canceler，可为空
  }

  protected isCancel(value: unknown, ctx: Context<CC>): boolean {
    // 在此重写如何判断是取消的请求
    return false;
  }
}

Type Parameters

CC extends CustomConfig = CustomConfig

Hierarchy

RequestTemplate
- AxiosRequestTemplate
- WechatRequestTemplate

Constructors

constructor

new RequestTemplate<CC>(globalConfigs?: Partial<Configs<CC>>): RequestTemplate<CC>
Type Parameters
- CC extends CustomConfig = CustomConfig
Parameters
- globalConfigs: Partial<Configs<CC>> = {}
Returns RequestTemplate<CC>
- Defined in packages/request-template/src/RequestTemplate.ts:71

Properties

`Protected` cache

cache: Cache<Promise<unknown> | AxiosPromise<unknown>>

缓存

`Protected` globalConfigs

globalConfigs: Configs<CC>

全局配置

`Protected` cancelerManager

cancelerManager: Canceler<CustomConfig>

缓存管理器

Accessors

cancelCurrentRequest

get cancelCurrentRequest(): undefined | Canceler
Returns undefined | Canceler
- Defined in packages/request-template/src/RequestTemplate.ts:426

Methods

`Protected` init

init(): void
初始化

Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:79

`Protected` generateRequestKey

generateRequestKey(ctx: Omit<Context<CC>, "requestKey">): string
根据配置生成key
Parameters
- ctx: Omit<Context<CC>, "requestKey">
Returns string
- Defined in packages/request-template/src/RequestTemplate.ts:89

`Protected` handleResponse

handleResponse<T>(ctx: Context<CC>, response: AxiosResponse<any, any>): ResType<T>
转换数据结构为ResType
Type Parameters
- T
Parameters
- ctx: Context<CC>
- response: AxiosResponse<any, any>
Returns ResType<T>
- Defined in packages/request-template/src/RequestTemplate.ts:98

`Protected` registerCanceler

registerCanceler(ctx: Context<CC>, canceler: Canceler): void
注册canceler
Parameters
- ctx: Context<CC>
- canceler: Canceler
Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:105

`Protected` `Abstract` handleCanceler

handleCanceler(ctx: Context<CC>): void
设置取消handler
Parameters
- ctx: Context<CC>
Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:112

`Protected` `Abstract` fetch

fetch(ctx: RetryContext<CC>): Promise<unknown>
请求
Parameters
- ctx: RetryContext<CC>
Returns Promise<unknown>
- Defined in packages/request-template/src/RequestTemplate.ts:117

`Protected` `Abstract` isCancel

isCancel(value: unknown, ctx: RetryContext<CC>): boolean
使isCancel支持子类覆盖
Parameters
- value: unknown
- ctx: RetryContext<CC>
Returns boolean
- Defined in packages/request-template/src/RequestTemplate.ts:122

`Protected` handleRequestConfig

handleRequestConfig(requestConfig: AxiosRequestConfig<any>): AxiosRequestConfig<any>
处理requestConfig
Parameters
- requestConfig: AxiosRequestConfig<any>
Returns AxiosRequestConfig<any>
- Defined in packages/request-template/src/RequestTemplate.ts:127

`Protected` mergeCacheConfig

mergeCacheConfig(cacheConfig: undefined | boolean | CustomCacheConfig): CustomCacheConfig
合并缓存配置
Parameters
- cacheConfig: undefined | boolean | CustomCacheConfig
Returns CustomCacheConfig
- Defined in packages/request-template/src/RequestTemplate.ts:137

`Protected` mergeRetryConfig

mergeRetryConfig(retryConfig: undefined | number | RetryConfig): RetryConfig
合并retry配置
Parameters
- retryConfig: undefined | number | RetryConfig
Returns RetryConfig
- Defined in packages/request-template/src/RequestTemplate.ts:158

`Protected` handleCustomConfig

handleCustomConfig(customConfig: CC): CC
处理CustomConfig
Parameters
- customConfig: CC
Returns CC
- Defined in packages/request-template/src/RequestTemplate.ts:176

`Protected` handleStatus

handleStatus(ctx: Context<CC>, response: AxiosResponse<ResType<unknown>, any>, data: ResType<unknown>): ResType<unknown> | AxiosResponse<ResType<unknown>, any> | Promise<unknown>
处理响应结果
Parameters
- ctx: Context<CC>
- response: AxiosResponse<ResType<unknown>, any>
- data: ResType<unknown>
Returns ResType<unknown> | AxiosResponse<ResType<unknown>, any> | Promise<unknown>
- Defined in packages/request-template/src/RequestTemplate.ts:186

`Protected` useCache

useCache(ctx: Context<CC>, request: (() => Promise<unknown>)): Promise<unknown> | AxiosPromise<unknown>
使用缓存
Parameters
- ctx: Context<CC>
- request: (() => Promise<unknown>)
  - - (): Promise<unknown>
    - Returns Promise<unknown>
Returns Promise<unknown> | AxiosPromise<unknown>
- Defined in packages/request-template/src/RequestTemplate.ts:212

`Protected` handleRetry

handleRetry(ctx: Context<CC>): void
处理重试
Parameters
- ctx: Context<CC>
Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:248

`Protected` beforeExecRequest

beforeExecRequest(ctx: Context<CC>): void
执行请求前回调
Parameters
- ctx: Context<CC>
Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:296

`Protected` beforeRequest

beforeRequest(ctx: Context<CC>): void
请求前回调
Parameters
- ctx: Context<CC>
Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:303

`Protected` afterRequest

afterRequest(ctx: Context<CC>): void
请求后回调
Parameters
- ctx: Context<CC>
Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:310

`Protected` generateContext

generateContext(customConfig: CC, requestConfig: AxiosRequestConfig<any>): Context<CC>
生成上下文
Parameters
- customConfig: CC
- requestConfig: AxiosRequestConfig<any>
Returns Context<CC>
- Defined in packages/request-template/src/RequestTemplate.ts:319

`Protected` execRequest

execRequest(ctx: RetryContext<CC>): Promise<unknown>
执行请求，重试会调用该方法
Parameters
- ctx: RetryContext<CC>
Returns Promise<unknown>
- Defined in packages/request-template/src/RequestTemplate.ts:336

request

request<T, RC>(requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken" | "responseType"> & {
url: string;
responseType?: "json";
}, customConfig?: DynamicCustomConfig<CC, RC>): Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>
json类返回值类型

模板方法，请求入口，重试不会执行该方法
Type Parameters
- T = never
- RC extends boolean = false
Parameters
- requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken" | "responseType"> & {
  url: string;
  responseType?: "json";
  }
- Optional customConfig: DynamicCustomConfig<CC, RC>
Returns Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>
- Defined in packages/request-template/src/RequestTemplate.ts:359
request<T, RC>(requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken"> & {
url: string;
}, customConfig?: DynamicCustomConfig<CC, RC>): Promise<RC extends true ? AxiosResponse<T, any> : T>
非json返回值类型

模板方法，请求入口，重试不会执行该方法
Type Parameters
- T = never
- RC extends boolean = false
Parameters
- requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken"> & {
  url: string;
  }
- Optional customConfig: DynamicCustomConfig<CC, RC>
Returns Promise<RC extends true ? AxiosResponse<T, any> : T>
- Defined in packages/request-template/src/RequestTemplate.ts:373

`Protected` handleError

handleError(ctx: Context<CC>, e: AxiosError<ResType<unknown>, any>): ResType<unknown> | AxiosResponse<ResType<unknown>, any> | Promise<unknown>
请求失败回调
Parameters
- ctx: Context<CC>
- e: AxiosError<ResType<unknown>, any>
Returns ResType<unknown> | AxiosResponse<ResType<unknown>, any> | Promise<unknown>
- Defined in packages/request-template/src/RequestTemplate.ts:397

cancelAll

cancelAll(msg?: string): void
取消所有请求
Parameters
- Optional msg: string
Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:415

cancelWithTag

cancelWithTag(tag: undefined | Tag, msg?: string): void
根据tag标签取消请求
Parameters
- tag: undefined | Tag
- Optional msg: string
Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:422

methodFactory

methodFactory(method: Method, handler?: ((configs: Configs<CustomConfig>) => void)): (<T, RC>(requestConfig: Omit<AxiosRequestConfig<any>, "url" | "method" | "cancelToken"> & {
url: string;
}, customConfig?: DynamicCustomConfig<CC, RC>) => Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>)
简单工厂：生成get post delete等method
Parameters
- method: Method
- Optional handler: ((configs: Configs<CustomConfig>) => void)
  - - (configs: Configs<CustomConfig>): void
    - Parameters
      
      configs: Configs<CustomConfig>
      
      Returns void
Returns (<T, RC>(requestConfig: Omit<AxiosRequestConfig<any>, "url" | "method" | "cancelToken"> & {
url: string;
}, customConfig?: DynamicCustomConfig<CC, RC>) => Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>)
- - <T, RC>(requestConfig: Omit<AxiosRequestConfig<any>, "url" | "method" | "cancelToken"> & {
    url: string;
    }, customConfig?: DynamicCustomConfig<CC, RC>): Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>
  - Type Parameters
    - T = never
    - RC extends boolean = false
    Parameters
    - requestConfig: Omit<AxiosRequestConfig<any>, "url" | "method" | "cancelToken"> & {
      url: string;
      }
    - Optional customConfig: DynamicCustomConfig<CC, RC>
    Returns Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>
- Defined in packages/request-template/src/RequestTemplate.ts:433

simplifyMethodFactory

simplifyMethodFactory(method: Method, urlPrefix?: string): (<T, RC>(url: string, data?: {}, customConfig?: DynamicCustomConfig<CC, RC>) => Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>)
简化版请求方法工厂忽略data还是params；url前缀；只改axios的url，data/params，method,及自定义配置
Parameters
- method: Method
- urlPrefix: string = ''
Returns (<T, RC>(url: string, data?: {}, customConfig?: DynamicCustomConfig<CC, RC>) => Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>)
- - <T, RC>(url: string, data?: {}, customConfig?: DynamicCustomConfig<CC, RC>): Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>
  - Type Parameters
    - T = never
    - RC extends boolean = false
    Parameters
    - url: string
    - data: {} = {}
    - customConfig: DynamicCustomConfig<CC, RC> = ...
    Returns Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>
- Defined in packages/request-template/src/RequestTemplate.ts:453

use

use(configs: Partial<Configs<CC>>): (<T, RC>(requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken"> & {
url: string;
}, customConfig?: DynamicCustomConfig<CC, RC>) => Promise<T>)
本质上跟methodFactory是一样的
Parameters
- configs: Partial<Configs<CC>>
Returns (<T, RC>(requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken"> & {
url: string;
}, customConfig?: DynamicCustomConfig<CC, RC>) => Promise<T>)
- - <T, RC>(requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken"> & {
    url: string;
    }, customConfig?: DynamicCustomConfig<CC, RC>): Promise<T>
  - Type Parameters
    - T = never
    - RC extends boolean = false
    Parameters
    - requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken"> & {
      url: string;
      }
    - Optional customConfig: DynamicCustomConfig<CC, RC>
    Returns Promise<T>
- Defined in packages/request-template/src/RequestTemplate.ts:472

deleteCacheByTag

deleteCacheByTag(tag: Tag): void
根据tag移除缓存

为什么要做这个功能：因为在移动端这类无限上拉下一页分页场景，如果下拉刷新了缓存，那么必须清除这一url下所有分页的缓存，然而分页场景下每一页都会生成一个key，不好删除缓存
Parameters
- tag: Tag
Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:497

clearCache

clearCache(): void
清理所有缓存

Returns void
- Defined in packages/request-template/src/RequestTemplate.ts:504

Class RequestTemplate<CC>Abstract

See

Example

Type Parameters

CC extends CustomConfig = CustomConfig

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

CC extends CustomConfig = CustomConfig

Parameters

globalConfigs: Partial<Configs<CC>> = {}

Returns RequestTemplate<CC>

Properties

Protected cache

Protected globalConfigs

Protected cancelerManager

Accessors

cancelCurrentRequest

Returns undefined | Canceler

Methods

Protected init

Returns void

Protected generateRequestKey

Parameters

ctx: Omit<Context<CC>, "requestKey">

Returns string

Protected handleResponse

Type Parameters

T

Parameters

ctx: Context<CC>

response: AxiosResponse<any, any>

Returns ResType<T>

Protected registerCanceler

Parameters

ctx: Context<CC>

canceler: Canceler

Returns void

Protected Abstract handleCanceler

Parameters

ctx: Context<CC>

Returns void

Protected Abstract fetch

Parameters

ctx: RetryContext<CC>

Returns Promise<unknown>

Protected Abstract isCancel

Parameters

value: unknown

ctx: RetryContext<CC>

Returns boolean

Protected handleRequestConfig

Parameters

requestConfig: AxiosRequestConfig<any>

Returns AxiosRequestConfig<any>

Protected mergeCacheConfig

Parameters

cacheConfig: undefined | boolean | CustomCacheConfig

Returns CustomCacheConfig

Protected mergeRetryConfig

Parameters

retryConfig: undefined | number | RetryConfig

Returns RetryConfig

Protected handleCustomConfig

Parameters

customConfig: CC

Returns CC

Protected handleStatus

Parameters

ctx: Context<CC>

response: AxiosResponse<ResType<unknown>, any>

data: ResType<unknown>

Returns ResType<unknown> | AxiosResponse<ResType<unknown>, any> | Promise<unknown>

Protected useCache

Class RequestTemplate<CC>`Abstract`

`Protected` cache

`Protected` globalConfigs

`Protected` cancelerManager

`Protected` init

`Protected` generateRequestKey

`Protected` handleResponse

`Protected` registerCanceler

`Protected` `Abstract` handleCanceler

`Protected` `Abstract` fetch

`Protected` `Abstract` isCancel

`Protected` handleRequestConfig

`Protected` mergeCacheConfig

`Protected` mergeRetryConfig

`Protected` handleCustomConfig

`Protected` handleStatus

`Protected` useCache

`Protected` handleRetry

`Protected` beforeExecRequest

`Protected` beforeRequest

`Protected` afterRequest

`Protected` generateContext

`Protected` execRequest

requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken" | "responseType"> & {
url: string;
responseType?: "json";
}

`Optional` customConfig: DynamicCustomConfig<CC, RC>

requestConfig: Omit<AxiosRequestConfig<any>, "url" | "cancelToken"> & {
url: string;
}

`Optional` customConfig: DynamicCustomConfig<CC, RC>

`Protected` handleError

`Optional` msg: string

`Optional` msg: string

`Optional` handler: ((configs: Configs<CustomConfig>) => void)

Returns (<T, RC>(requestConfig: Omit<AxiosRequestConfig<any>, "url" | "method" | "cancelToken"> & {
url: string;
}, customConfig?: DynamicCustomConfig<CC, RC>) => Promise<RC extends true ? AxiosResponse<ResType<T>, any> : ResType<T>>)