js装饰器简单理解

2024-09-05 13:18
文章标签 简单 理解 js 装饰

本文主要是介绍js装饰器简单理解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

装饰器(Decorator)是一种与类(class)相关的语法,用来注释或修改类和类方法。

装饰器是一种函数,写成@函数名。它可以放在类和类方法的定义前面。如下:

@frozen
class Foo {@configurable(false)@enumerable(true)method() {}@throttle(500)expensiveMethod() {}
}

上面代码一共使用了四个装饰器,一个用在类本身,另外三个用在类方法。它们不仅增加了代码的可读性,清晰地表达了意图,而且提供一种方便的手段,增加或修改类的功能。

  1. 类的装饰

装饰器对类的行为的改变,是代码编译时发生的,而不是在运行时

@decorator
class A {}// 等同于
class A {}
A = decorator(A) || A;
  • 可以在装饰器后面再添加提个参数
@log('hi')
class MyClass { }function log(text) {return function(target) {target.prototype.logger = () => `${text}${target.name} 被调用`}
}const test = new MyClass()
test.logger() // hello,MyClass 被调用
  1. 方法的装饰

与装饰类不同,对类方法的装饰本质是操作其描述符。可以把此时的装饰器理解成是 Object.defineProperty(obj, prop, descriptor) 的语法糖

class Person {@readonlyname() { return `${this.first} ${this.last}` }
}
  1. 参数详解

装饰器都具备三个参数,即 target , name , descriptor

  • 装饰器在装饰类时,

target 目标是类本身,也就是例子中的 Hero 类,而此时name 和 descriptor 均为 undefined

@speakName("Julius") 
class Hero {}  function speakName(kingname) {  return function(target, name, descriptor) {  console.log(target);    // ƒ Hero()  console.log(name);      // undefined  console.log(descriptor);    // undefined  target.prototype.name = kingname;   }; 
}
  • 装饰器在装饰类方法时

target 目标是类实例,name 是类方法的名称,descriptor 则是类方法的描述对象,可看到 value 是类方法本身,其他3个值和 Object.defineProperty的属性一样,负责控制值的行为,该例中的 writable 就是其中之一。

class Hero {  name = "Julius";  @readonly  speak() {  console.log(`My name is ${this.name}`);   } 
}  function readonly(target, name, descriptor) {  console.log(target);  // {} __proto__: Object: Object  console.log(name);    // speak  console.log(descriptor);    /*    * configurable: true      * enumerable: false      * value: ƒ speak()      * writable: true      */  descriptor.writable = false; 
}  const hero = new Hero();
  1. 知识拓展
  • Object.defineProperty

Object.defineProperty() 方法会直接在一个对象上定义一个新属性,或者修改一个对象的现有属性, 并返回这个对象。
该方法允许精确添加或修改对象的属性。通过赋值来添加的普通属性会创建在属性枚举期间显示的属性(for…in 或 Object.keys 方法), 这些值可以被改变,也可以被删除。这种方法允许这些额外的细节从默认值改变。默认情况下,使用 Object.defineProperty() 添加的属性值是不可变的。

语法

Object.defineProperty(obj, prop, descriptor)
  • obj:要在其上定义属性的对象。

  • prop:要定义或修改的属性的名称。

  • descriptor:将被定义或修改的属性描述符。

  • 返回值:被传递给函数的对象。

  • 属性描述符

对象里目前存在的属性描述符有两种主要形式:数据描述符和存取描述符。

数据描述符是一个具有值的属性,该值可能是可写的,也可能不是可写的。
存取描述符是由 getter-setter 函数对描述的属性。
描述符必须是这两种形式之一;不能同时是两者。

  1. 数据描述符和存取描述符均具有以下可选键值
  • configurable

当且仅当该属性的 configurable 为 true 时,该属性描述符才能够被改变,同时该属性也能从对应的对象上被删除。默认为 false

  • enumerable

enumerable定义了对象的属性是否可以在 for…in 循环和 Object.keys() 中被枚举。

当且仅当该属性的 enumerable 为 true 时,该属性才能够出现在对象的枚举属性中。默认为 false。

  1. 数据描述符同时具有以下可选键值
  • value

该属性对应的值。可以是任何有效的 JavaScript 值(数值,对象,函数等)。默认为 undefined

  • writable

当且仅当该属性的 writable 为 true 时,value 才能被赋值运算符改变。默认为 false

  1. 存取描述符同时具有以下可选键值
  • get

一个给属性提供 getter 的方法,如果没有 getter 则为 undefined。该方法返回值被用作属性值。默认为 undefined

  • set

一个给属性提供 setter 的方法,如果没有 setter 则为 undefined。该方法将接受唯一参数,并将该参数的新值分配给该属性。默认为 undefined

如果一个描述符不具有value,writable,get 和 set 任意一个关键字,那么它将被认为是一个数据描述符。如果一个描述符同时有(value或writable)和(get或set)关键字,将会产生一个异常

  • Babel编辑
class C {@readonly(false)method() { console.log('cat') }
}function readonly(value) {return function (target, key, descriptor) { // 此处 target 为 C.prototype; key 为 method;// 原 descriptor 为:{ value: f, enumarable: false, writable: true, configurable: true }descriptor.writable = valuereturn descriptor}
}const c = new C()
c.method = () => console.log('dog')c.method() // cat

可以看到装饰器函数接收的三个参数与 Object.defineProperty 是完全一样的,具体实现可以看 babel 转化后的代码,主要实现如下所示:

var C = (function() {class C {method() { console.log('cat') }}var temptemp = readonly(false)(C.prototype, 'method',temp = Object.getOwnPropertyDescriptor(C.prototype, 'method')) || temp // 通过 Object.getOwnPropertyDescriptor 获取到描述符传入到装饰器函数中if (temp) Object.defineProperty(C.prototype, 'method', temp)return C
})()

有多个装饰器作用于同一个方法:

class C {@readonly(false)@logmethod() { }
}

经 babel 转化后的代码如下:

desc = [readonly(false), log].slice().reverse().reduce(function(desc, decorator) {return decorator(target, property, desc) || desc;}, desc);

可以清晰地看出,经过 reverse 倒序后,装饰器方法会至里向外执行

参考

阮一峰-装饰器
JS 装饰器,一篇就够

这篇关于js装饰器简单理解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1139071

相关文章

JS+HTML实现在线图片水印添加工具

《JS+HTML实现在线图片水印添加工具》在社交媒体和内容创作日益频繁的今天,如何保护原创内容、展示品牌身份成了一个不得不面对的问题,本文将实现一个完全基于HTML+CSS构建的现代化图片水印在线工具... 目录概述功能亮点使用方法技术解析延伸思考运行效果项目源码下载总结概述在社交媒体和内容创作日益频繁的

Node.js 数据库 CRUD 项目示例详解(完美解决方案)

《Node.js数据库CRUD项目示例详解(完美解决方案)》:本文主要介绍Node.js数据库CRUD项目示例详解(完美解决方案),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考... 目录项目结构1. 初始化项目2. 配置数据库连接 (config/db.js)3. 创建模型 (models/

深入理解Apache Kafka(分布式流处理平台)

《深入理解ApacheKafka(分布式流处理平台)》ApacheKafka作为现代分布式系统中的核心中间件,为构建高吞吐量、低延迟的数据管道提供了强大支持,本文将深入探讨Kafka的核心概念、架构... 目录引言一、Apache Kafka概述1.1 什么是Kafka?1.2 Kafka的核心概念二、Ka

使用Node.js制作图片上传服务的详细教程

《使用Node.js制作图片上传服务的详细教程》在现代Web应用开发中,图片上传是一项常见且重要的功能,借助Node.js强大的生态系统,我们可以轻松搭建高效的图片上传服务,本文将深入探讨如何使用No... 目录准备工作搭建 Express 服务器配置 multer 进行图片上传处理图片上传请求完整代码示例

使用Python开发一个简单的本地图片服务器

《使用Python开发一个简单的本地图片服务器》本文介绍了如何结合wxPython构建的图形用户界面GUI和Python内建的Web服务器功能,在本地网络中搭建一个私人的,即开即用的网页相册,文中的示... 目录项目目标核心技术栈代码深度解析完整代码工作流程主要功能与优势潜在改进与思考运行结果总结你是否曾经

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

Mysql表的简单操作(基本技能)

《Mysql表的简单操作(基本技能)》在数据库中,表的操作主要包括表的创建、查看、修改、删除等,了解如何操作这些表是数据库管理和开发的基本技能,本文给大家介绍Mysql表的简单操作,感兴趣的朋友一起看... 目录3.1 创建表 3.2 查看表结构3.3 修改表3.4 实践案例:修改表在数据库中,表的操作主要

springboot简单集成Security配置的教程

《springboot简单集成Security配置的教程》:本文主要介绍springboot简单集成Security配置的教程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录集成Security安全框架引入依赖编写配置类WebSecurityConfig(自定义资源权限规则

如何使用Python实现一个简单的window任务管理器

《如何使用Python实现一个简单的window任务管理器》这篇文章主要为大家详细介绍了如何使用Python实现一个简单的window任务管理器,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起... 任务管理器效果图完整代码import tkinter as tkfrom tkinter i

C++中函数模板与类模板的简单使用及区别介绍

《C++中函数模板与类模板的简单使用及区别介绍》这篇文章介绍了C++中的模板机制,包括函数模板和类模板的概念、语法和实际应用,函数模板通过类型参数实现泛型操作,而类模板允许创建可处理多种数据类型的类,... 目录一、函数模板定义语法真实示例二、类模板三、关键区别四、注意事项 ‌在C++中,模板是实现泛型编程