NestJS装饰器


最近用nestjs做了一个前后端的全栈项目,在nestjs中看到的装饰器无处不在,今天主要回顾下关于装饰器的那些事

本文主要会从以下几点认识装饰器

  • 装饰器是什么,它解决了什么样的问题

  • 装饰器如何作用在类上

  • 装饰器在方法属性形参上有什么区别

什么是装饰器

decorator[1]中有讲到,装饰器是一种函数,增强JS类的能力,它可以装饰函数,装饰属性,或者装饰类。是通过@fn方式来装饰的。

在使用之前,我们必须开启tsconfig.jsonexperimentalDecorators选项,这样我们就可以使用装饰器了

 
// tsconfig.json
{
"compilerOptions": {
"experimentalDecorators": true
}
}

类上的装饰器

 
// index.ts
function test(target: any) {
console.log(target);
console.log(new target().name);
}
@test
class Person {
constructor(public name: string) {
this.name = "Web技术学苑";
}
}

执行npx ts-node index.ts

我们会发现,当我在类上使用一个装饰器时,target这个默认的形参就说class Person这个构造函数

所以我在test的装饰器内部去new target()相当于是new Person()

方法上的装饰器

主要这个装饰器会用在方法上,我们会发现@getName装饰器是放在getName上的

 
function getName(target: any, key: string, descriptor: any) {
console.log(target, key, descriptor);
const fn = descriptor.value;
console.log(fn()) // Maic
}
class Person {
constructor(public name: string) {
this.name = "Web技术学苑";
}
@getName
getName() {
// return this.name;
return 'Maic'
}
}

当我们npx ts-node index.ts时,输出的结果如下

  • target就是一个对象

  • key就是getName方法名

  • descriptor包含了一个value的对象值

当我们发现descriptor的value时一个可执行函数时,其实就是getName返回的值

 
{} 
getName
{
value: [Function: getName],
writable: true,
enumerable: false,
configurable: true
}

我们以另外一个具体的例子来感受下,在方法中使用装饰器

自定义Get装饰器

 
function getName(target: any, key: string, descriptor: any) {
//console.log(target, key, descriptor);
const fn = descriptor.value;
const result = fn();
console.log(result);
}

function Get(url: string) {
return (target: any, key: string, descriptor: any) => {
const request = fetch(url);
const fn = descriptor.value;
request
.then((res) => res.json())
.then((result) => {
fn.call(target,result);
});
};
}
class Person {
constructor(public name: string) {
this.name = "Web技术学苑";
}
@getName
getName() {
return "Maic";
}
@Get("https://movie.douban.com/j/search_tags?type=movie&source=index")
getUserInfo(res: any) {
console.log(res);
}
}

运行npx ts-node index.ts

所以我们通过自定义装饰器@Get('xxx')达到了我们想要的效果,注意在@Get中是接收了一个参数,然后在Get中返回了一个函数

  • Get中有形参

  • 返回了一个函数

  • 在返回的函数的三个参数依次是targetkey, descriptor其中target{},keygetUserInfo,descriptor是一个可枚举对象

Get方法中并没有返回,而是通过回调的方式将结果输出了,所以一个简单的路由装饰器Get方法就已经完成了,这在nestjs中非常的常用,你会看到很多诸如GetPost的装饰器。

函数形参上的装饰器

装饰器也可以用在形参上,因此我们定义了一个@userParams,不过此事装饰器的中的target是一个对象,key是当前函数名,第三个参数是当前形参的索引

 
function userParams(target: any, key: string, index: number) {
console.log(target, key, index, "===");
}

class Person {
constructor(public name: string, public useInfo: any) {
this.name = "Web技术学苑";
this.useInfo = {
age: 18,
sex: "男",
};
}
setUseInfo(@userParams params: any = { age: "10" }) {
return this.name;
}
}

属性上的装饰器

我们从以下代码中发现,在属性上的装饰器与方法上的形参有所不同,属性装饰器只有两个参数,第一个参数返回一个对象,第二个参数是当前属性名称。

 
function getAge(target: any, key: string) {
console.log(target, "==getAge");
console.log(key, "=key");
}
class Person {
@getAge
public age: number;
constructor(public name: string, public useInfo: any) {
this.name = "Web技术学苑";
this.useInfo = {
age: 18,
sex: "男",
};
this.age = 18;
}
}

在关于装饰器的设计中,它帮我们解决了什么样的问题,这点在nestjs中关于装饰器无处不在,在鉴权路由Module等等,都是使用装饰器,这将极大的抽象了复杂的逻辑,方便我们在业务开发中拿来即用。

最后关于装饰器[2]我们也可以参考这篇文章,学习更多关于装饰器更多内容

总结

  • 了解装饰器的用处,本质上装饰器就是函数,通过@修饰函数变成了装饰器,增强了类的能力,可以修饰属性方法形参

  • 比较了装饰器在方法函数形参属性的不同,通过自定义装饰器@Get深入了解到装饰器在方法上的使用

  • code example[3]

参考资料

[1]decorator: https://es6.ruanyifeng.com/#docs/decorator

[2]装饰器: https://github.com/tc39/proposal-decorators

[3]code example: hhttps://github.com/maicFir/lessonNote/tree/master/nest/01-装饰器

相关推荐

  • 苹果M3是英特尔、高通和AMD的威胁吗?
  • 云,哪里贵了?
  • 刷抖音搞出一个小项目,活该他赚钱
  • 史上最全后台开发成长指南
  • 面试官:一台服务器最大能支持多少条 TCP 连接?问倒一大片。。。
  • StarRocks 年度峰会来了!与百名行业大咖,万名开发者一起,共同探索数据进化的力量
  • vivo 重磅官宣自研“蓝河操作系统”:永不兼容安卓应用,由 Rust 编写框架,还引入 AI 大模型!
  • 规则引擎与商业CRM的完美邂逅:将智能决策融入商业扩展
  • 微信Android组的产品经理被调到了iOS组
  • Dubbo路由及负载均衡性能优化
  • 微软推送Windows 11 23H2更新
  • 从0到1入门用户画像掌握大数据技术
  • 夸克 “色色”被罚50万,众多网友发帖为其求情
  • vivo发布自研操作系统蓝河 (BlueOS),系统框架采用Rust编写
  • 中方将出席英国AI安全峰会;文心一言推出会员模式;vivo发布自研蓝心大模型丨AIGC大事日报
  • 南山区最新AI发展规划出炉!三类企业成重点,每年5个超级场景项目
  • 6K Star开源简洁易用的Mac MySQL数据库管理工具
  • 使用Ray轻松进行Python分布式计算
  • 【ICCV2023】无需回放的持续学习:生成实例级提示
  • AI 人像生成再度进化!