实际项目中如何更优雅的编写网络请求层逻辑,2024年最新拼多多前端二面

先自我介绍一下,小编浙江大学毕业,去过华为、字节跳动等大厂,目前阿里P7

深知大多数程序员,想要提升技能,往往是自己摸索成长,但自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年最新Web前端全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友。
img
img
img
img
img
img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,涵盖了95%以上前端开发知识点,真正体系化!

由于文件比较多,这里只是将部分目录截图出来,全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频,并且后续会持续更新

如果你需要这些资料,可以添加V获取:vip1024c (备注前端)
img

正文

const queryKey: string = this.buildTempKeyByUrl(params);

if (Array.isArray(res.data) && res.data.length) {

RESOURCE_STATION_TREE_DATA.set(queryKey, res.data);

}

return res.data;

}

}

复制代码

今天的文章中来分享一下如何基于注解(装饰器)的方式来编写网络请求层,其中的代码已提交到 源码 感兴趣的同学可以参考参考。

基于代码也打包了 npm 插件 @canyuegongzi/decorator-http-template

npm

插件使用

前置知识


装饰器

装饰器(Decorator)是一种与类(class)相关的语法,用来注释或修改类和类方法。许多面向对象的语言都有这项功能。

javaScript 对于元编程的支持尚不如 ts 完善,因此以 typeScript 来开发此插件。

ts 中装饰器大致分为类装饰器、属性装饰器、方法装饰器、参数装饰器。

类装饰器

此类装饰器可以是普通装饰器(无法传参)也可以是工厂模式(可以传参),工厂模式甚至可以直接重载整个类,ts 中的类型约束如下。

declare type ClassDecorator = (target: TFunction) => TFunction | void;

复制代码

普通装饰器:

此注解中 target 为 被修饰的类,在此可以扩展被修饰的类。

function log(target: T){

// console.log(target)

}

@log

class Test {}

复制代码

工厂模式

此类注解返回函数,可以通柯里化的方式传递参数。

function log(params: any){

return function (target: T) {}

}

@log(‘/login’)

class Test {}

复制代码

属性装饰器

此类装饰器可以修饰类的成员属性,模式如类装饰器一样既可以是传统模式也可以采用工厂模式,此种装饰器在依赖注入中有大量的应用,ts 中的类型约束如下。

declare type PropertyDecorator = (target: Object, propertyKey: string | symbol) => void;

复制代码

export function Inject(id?: string): PropertyDecorator {

return (target: Record<string, any>, propertyKey: string | symbol) => {

// 在此出可以实现与依赖注入相关的逻辑

};

}

class Test {

@Inject(‘configService’)

public configService!: ConfigService;

}

复制代码

方法装饰器

此类装饰器可以重载类的成员函数,后续内容中会大量使用此类装饰器,此类装饰器存在三个参数,其一:target 为被修饰的类,其二:propertyKey是被修饰的成员函数的函数名,其三 descriptor 是被修饰的成员函数,在通常情况下可以通过 descriptor 参数重载此方法。ts 中的类型约束如下。

declare type MethodDecorator = (target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor) => TypedPropertyDescriptor | void;

复制代码

以下代码实现一个简单的接口缓存装饰器。

const ExpriesMemoryCache = new Map();

export function ApiCache(timeout = 120, keyArray = [],): MethodDecorator {

return (target, name, descriptor) => {

// 获取被修饰成员函数的原值

const originalMethod = descriptor.value;

// 重载此函数

descriptor.value = async function (…args) {

const argumentsArr = Array.from(arguments).concat(keyArray);

let key = JSON.stringify(name, Array.from(new Set(argumentsArr)));

let promise = ExpriesMemoryCache.get(key);

if (!promise) {

// 缓存中没有该接口的缓存数据时通过originalMethod.apply 方式调用原函数请求数据

promise = await originalMethod.apply(null, arguments).catch(async error => {

ExpriesMemoryCache.delete(key)

return Promise.reject(error);

});

// 数据请求完成后将数据存入缓存,下一次调用该方式时直接从缓存中获取数据

ExpriesMemoryCache.set(key, promise)

}

return promise;

};

return descriptor;

}

}

class Test {

@ApiCache(120, [])

public getData() {

}

}

复制代码

以上代码实现了一个简易版的接口缓存注解,实现较为简陋,做的好的话可以继续扩展此函数,实现诸如定时缓存、竞速缓存等功能。

参数装饰器

此类装饰器主要用来注解类成员函数中参数,该装饰器有存在参数,其一:target 为 被修饰函数的所属类,其二:propertyKey 为被修饰的函数名,其三:parameterIndex 为参数的索引(第几个参数),该中装饰器在服务端开发中有大量的应用,如 Controller 层中查询参数的应用,ts 类型约束如下。

declare type ParameterDecorator = (target: Object, propertyKey: string | symbol, parameterIndex: number) => void;

复制代码

class Test {

getInfo(@paramDecorator name: string, age: number) {

console.log(name, age);

}

}

function paramDecorator(target: any, method: string, paramIndex: number) {

// target 为 Test 类

// method 为 ‘getInfo’

// paramIndex 为 0 被修饰的参数的参数索引

console.log(target, method, paramIndex);

}

复制代码

reflect-metadata

Reflect Metadata 是 ES7 的一个提案,它主要用来在声明的时候添加和读取元数据。TypeScript 在 1.5+ 的版本已经支持它,你只需要:

  1. npm i reflect-metadata --save 并在入口文件中 import 'reflect-metadata'

  2. 在 tsconfig.json 里配置 emitDecoratorMetadata 选项

defineMetadata

当作 Decorator 使用,当修饰类时,在类上添加元数据,当修饰类属性时,在类原型的属性上添加元数据。

Reflect.defineMetadata(ReqMethodQuery, parameterIndex, target, propertyKey);

复制代码

getMetadata

该 Api 用于获取target的元数据值, 会往原型链上找。

hasOwnMetadata

跟Object.prototype.hasOwnProperty类似, 是只查找对象上的元数据, 而不会继续向上查找原型链上的,如:

const reqQueryIndex: number = Reflect.getOwnMetadata(ReqMethodQuery, target, propertyKey);

复制代码

其他

关于 reflect-metadata 的概念在此处不作详细使用介绍,不过找了几篇文章,可以参考下:

  1. 掘金1

  2. reflect-metadata

  3. github

开始

有之前的前置知识后,现在可以正式开始插件了。

网络请求方法装饰器

通过装饰器方式编写网络请求层。同样需要实现 Get、Post、Delete、Patch。

此处只以 Post、Get 为例,核心方法 createHttpDecoratorFunction 在下一步实现。

/**

* post post请求

* @param url 接口地址   /user/login

* @param data 请求参数 一般参数都是动态参数,不会采用这中方式

* @param options<string[] | string> 请求头部参数 建议直接使用HttpHeader 注解

* @constructor

*/

export function HttpPost(url: string, data?: any, options: string[] = []) {

return createHttpDecoratorFunction(‘POST’, url, data, options)

}

/**

* post get请求  /user/list | /user/usrInfo/:id

* @param url 接口地址

* @param data 请求参数 一般参数都是动态参数,不会采用这中方式

* @param options<string[] | string> 请求头部参数 建议直接使用HttpHeader 注解

* @constructor

*/

export function HttpGet(url: string, data?: any, options: string[] = []) {

return createHttpDecoratorFunction(‘GET’, url, data, options)

}

复制代码

网络查询参数装饰器

通过此类型装饰器可以实现网络请求的参数传递,效果如下:可以通过 HttpParams、HttpQuery、HttpPostData 来设置网络请求的参数。

class Test {

/**

* 获取数据查询

* @protected

*/

@HttpGet(‘/data-search/list’)

@HttpHeader([‘Content-Type: application/json’])

protected async getDataList(@HttpParams() queryDataParams: QueryDataParams, @HttpRes() res?: any) {}

}

复制代码

HttpParams 和 HttpPostData 可以定义需要传递的参数,其实现方式参考了 nest 的使用方式,既可以将整个实体当作参数传递给后端接口,也可以通过对象字段标识只传递对象的一个属性。当通过此类装饰器装饰的成员函数,在代码编译阶段会先通过 Reflect.defineMetadata 绑定参数索引。方便在后续的函数调用中获取参数,也可以通过柯里化的方式保存参数供后续使用。此出代码只以 HttpParams 为例,其他 HttpPostData、HttpQuery 都是同样的道理,代码可以参考源码。

/**

* 请求参数注解   @HttpParams()  | @HttpParams(‘id’)

* @param key 参数key,当存在此参数时,请求参数中只会包含此key的值, 大部分情况下适用于 user/:id  类接口, 默认发送全部参数

* @constructor

*/

export function HttpParams(key?: string) {

return function (target: any, propertyKey: string | symbol, parameterIndex: number) {

// 通过 Reflect.defineMetadata 定义元数据

Reflect.defineMetadata(ReqMethodParams, parameterIndex, target, propertyKey);

// 装饰器存在参数时 需要特殊绑定元数据

if (key) {

Reflect.defineMetadata(ReqMethodKeyParams, key, target, propertyKey);

}

}

}

复制代码

HttpRes装饰器

HttpRes 装饰器的核心作用是标识可以通过该参数可以拿到后端返回的数据。还是以之前的案例,getDataList 的第二个参数通过 HttpRes 修饰,在函数体内部就可以通过 res 获取后端返回的数据。

class Test {

/**

* 获取数据查询

* @protected

*/

@HttpGet(‘/data-search/list’)

@HttpHeader([‘Content-Type: application/json’])

protected async getDataList(@HttpParams() queryDataParams: QueryDataParams, @HttpRes() res?: any) {

// 通过 res 可以拿到后端返回的Reponse, 不过这个 res 是 AxiosResponse 类型,默认情况下,函数体为空时。函数会返回该res.

console.log(res.data);

}

}

复制代码

HttpHeader装饰器

HttpHeader 装饰器可以添加网络请求的头部参数,其参数既可以是字符类型也可以是字符集合。

/**

* 请求头部

* @param headers<string[] | string>

* @constructor

*/

export function HttpHeader(headers: string | string[]) {

return headerDecoratorFactory(headers);

}

function headerDecoratorFactory(headers: string | string[]) {

return function (target: any, propertyKey: string) {

const headersConfig: string[] = typeof headers === ‘string’? [headers]: headers;

Reflect.defineMetadata(ReqMethodHeaders, headersConfig, target, propertyKey);

}

}

复制代码

HttpBaseUrl装饰器

最后

小编的一位同事在校期间连续三年参加ACM-ICPC竞赛。从参赛开始,原计划每天刷一道算法题,实际上每天有时候不止一题,一年最终完成了 600+:

凭借三年刷题经验,他在校招中很快拿到了各大公司的offer。

入职前,他把他的刷题经验总结成1121页PDF书籍,作为礼物赠送给他的学弟学妹,希望同学们都能在最短时间内掌握校招常见的算法及解题思路。

整本书,我仔细看了一遍,作者非常细心地将常见核心算法题和汇总题拆分为4个章节。

而对于有时间的同学,作者还给出了他结合众多数据结构算法书籍,挑选出的一千多道题的解题思路和方法,以供有需要的同学慢慢研究。

网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。

需要这份系统化的资料的朋友,可以添加V获取:vip1024c (备注前端)
img

一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!
,他把他的刷题经验总结成1121页PDF书籍,作为礼物赠送给他的学弟学妹,希望同学们都能在最短时间内掌握校招常见的算法及解题思路。**

整本书,我仔细看了一遍,作者非常细心地将常见核心算法题和汇总题拆分为4个章节。

而对于有时间的同学,作者还给出了他结合众多数据结构算法书籍,挑选出的一千多道题的解题思路和方法,以供有需要的同学慢慢研究。

网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。

需要这份系统化的资料的朋友,可以添加V获取:vip1024c (备注前端)
[外链图片转存中…(img-PnHBwpKX-1713558349802)]

一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值