深入理解 TypeScript Reflect Metadata

在定义类或者类方法的时候，可以设置一些元数据，我们可以获取到在类与类方法上添加的元数据，用的方法就是 Reflect Metadata。元数据指的是描述东西时用的数据。

在 TypeScript 里使用 Reflect Metadata 需要做下面这样的配置：

{
 "compilerOptions": {
  "experimentalDecorators": true ,
  "emitDecoratorMetadata": true
 },
}

然后在项目里安装 reflect-metadata 这个包：

npm install reflect-metadata --save

然后做个实验：

import 'reflect-metadata';

@Reflect.metadata('role', 'admin')
class Post {}

const metadata = Reflect.getMetadata('role', Post);

console.log(metadata); // admin

先导入 reflect-metadata 这个包，然后在定义的 Post 类的上面用 Reflect.metadata 装饰器添加了一条元数据，role 是这条元数据的名字，admin 是我们给这条数据设置的对应的值。

稍后如果想获取到在类上添加的这些元数据，可以使用 Reflect.getMetadata 方法，role 是元数据的名字，Post 是对应的类的名字。执行上面代码，会返回 admin 这个字符串。

自定义装饰器

在上面的例子里我们用了 Reflect.metadata 设置的元数据。我们也可以自定义一个装饰器去完成同样的事情。像下面这样：

import 'reflect-metadata';

function Role(name: string): ClassDecorator {
 return target => {
  Reflect.defineMetadata('role', name, target);
 };
}

@Role('admin')
class Post {}

const metadata = Reflect.getMetadata('role', Post);

console.log(metadata);

Role 是自定义的一个装饰器，接收一个 name 参数，这是一个装饰器工厂，返回的是 ClassDecorator。返回的东西应该是个适合在类上使用的装饰器，所以接收一个 target 参数，这个东西就是类的构造方法。在方法里用 Reflect.defineMetadata 方法设置了一个自定义的元数据叫 role，对应的值是 name，也就是使用这个装饰器的时候提供的参数值，第三个参数是 target，就是要添加元数据的那个类。

有了这个自定义的装饰器，使用它的时候可以像这样： @Role('admin')，功能就是在它装饰的类的上面添加了一条叫 role 的元数据，设置的对应的值是 admin。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。

赞 (0)

相关推荐

  • JavaScript Reflect Metadata实现详解

    引言 在 ES6 的规范当中,就已经存在 Reflect API 了.简单来说这个 API 的作用就是可以实现对变量操作的函数化,也就是反射.具体的关于这个 API 的内容,可以查看这个教程 然而我们在这里讲到的,却是 Reflect 里面还没有的一个规范,那么就是 Reflect Metadata. Metadata 想必对于其他语言的 Coder 来说,比如说 Java 或者 C#,Metadata 是很熟悉的.最简单的莫过于通过反射来获取类属性上面的批注(在 JS 当中,也就是所谓的装饰器

  • 深入理解 TypeScript Reflect Metadata

    在定义类或者类方法的时候,可以设置一些元数据,我们可以获取到在类与类方法上添加的元数据,用的方法就是 Reflect Metadata.元数据指的是描述东西时用的数据. 在 TypeScript 里使用 Reflect Metadata 需要做下面这样的配置: { "compilerOptions": { "experimentalDecorators": true , "emitDecoratorMetadata": true }, } 然后在

  • 从reflect metadata理解Nest实现原理

    从reflect metadata理解Nest实现原理

    目录 正文 入口Module 引入模块 CatsService操作数据库 Reflect Metadata 那元数据存在哪呢? nest 的源码: 总结 正文 Nest 是 Node.js 的服务端框架,它最出名的就是 IOC(inverse of control) 机制了,也就是不需要手动创建实例,框架会自动扫描需要加载的类,并创建他们的实例放到容器里,实例化时还会根据该类的构造器参数自动注入依赖. 它一般是这样用的: 入口Module 引入模块 比如入口 Module 里引入某个模块的 Mo

  • 前端深入理解Typescript泛型概念

    首先介绍一下泛性的概念 泛型程序设计(generic programming)是程序设计语言的一种风格或范式.泛型允许程序员在强类型程序设计语言中编写代码时使用一些以后才指定的类型,在实例化时作为参数指明这些类型. 泛型是指在定义函数,接口或者类的时候,不预先定义好具体的类型,而在使用的时候在指定类型的一种特性. 先举一个简单的例子 假设我们定义一个函数,它可以接收一个number类型做为参数,并且返回一个number类型. function genericDemo(data: number):

  • 深入理解typescript中的infer关键字的使用

    infer 这个关键字,整理记录一下,避免后面忘记了.有点难以理解呢. infer infer是在 typescript 2.8中新增的关键字. infer 可以在 extends 条件类型的字句中,在真实分支中引用此推断类型变量,推断待推断的类型. 例如:用infer推断函数的返回值类型 type ReturnType<T> = T extends (...args: any[]) => infer R ? R : any; type fn = () => number type

  • 使用NestJS开发Node.js应用的方法

    NestJS 最早在 2017.1 月立项,2017.5 发布第一个正式版本,它是一个基于 Express,使用 TypeScript 开发的后端框架.设计之初,主要用来解决开发 Node.js 应用时的架构问题,灵感来源于 Angular.在本文中,我将粗略介绍 NestJS 中的一些亮点. 组件容器 NestJS 采用组件容器的方式,每个组件与其他组件解耦,当一个组件依赖于另一组件时,需要指定节点的依赖关系才能使用: import { Module } from '@nestjs/commo

  • 深入理解 ES6中的 Reflect用法

    Reflect对象是一个全局的普通的对象.Reflect的原型就是Object. 我们首先来验证下 看看Reflect的原型是否是Object, 基本代码如下: let obj = {}; console.log(Reflect.__proto__ === Object.prototype); // true console.log(obj.__proto__ === Reflect.__proto__); // true let str = '111'; console.log(str.__p

  • 简单了解TypeScript中如何继承 Error 类

    前言 在JavaScript 中很多时候都需要自定义错误,尤其是开发 Node.js 应用的时候. 比如一个典型的网站服务器可能需要有 NetworkError, DatabaseError, UnauthorizedError 等. 我们希望这些类都拥有 Error 的特性:有错误消息.有调用栈.有方便打印的 toString 等. 最直观的实现方式便是 继承 Error 类. 但考虑 TypeScript 需要编译到 ES5 兼容性问题会较为复杂, 本文用来帮助理解 TypeScript 中

  • TypeScript魔法堂之枚举的超实用手册

    前言 也许前端的同学会问JavaScript从诞生至今都没有枚举类型,我们不是都活得挺好的吗?为什么TypeScript需要引入枚举类型呢? 也许被迫写前端的后端同学会问,TypeScript的枚举类型是和Java/.NET的一样吗? 下面我们来一起探讨和尝试解答吧! 前端一直都需要枚举 我敢保证,前端的同学都会万分肯定地告诉大家:我们从来没有写过枚举.那是因为虽然ECMAScript将enum作为保留字,但至ES2020为止还没有提出枚举的实现规范.语言没有提供规范和语言实现,不代表思想活跃勇

  • TypeScript 背后的结构化类型系统原理详解

    目录 前言 什么是结构化类型系统? 什么是标称类型系统? 结构化类型系统等价于鸭子类型系统吗? 如何在 TypeScript 中模拟标称类型系统? 交叉类型实现 类实现 总结 前言 你能说清楚类型.类型系统.类型检查这三个的区别吗?在理解TypeScript的结构化类型系统之前,我们首先要搞清楚这三个概念和它们之间的关系 类型:即对变量的访问限制与赋值限制.如 TypeScript 中的原始类型.对象类型.函数类型和字面量类型等类型,当一个变量类型确定后,你不能访问这个类型中不存在的属性或方法,

随机推荐