JavaScript Reflect Metadata实现详解

2023-08-04 16:17:03 75

引言

在ES6的规范当中，就已经存在ReflectAPI了。简单来说这个API的作用就是可以实现对变量操作的函数化，也就是反射。具体的关于这个API的内容，可以查看这个教程

然而我们在这里讲到的，却是Reflect里面还没有的一个规范，那么就是ReflectMetadata。

Metadata

想必对于其他语言的Coder来说，比如说Java或者C#，Metadata是很熟悉的。最简单的莫过于通过反射来获取类属性上面的批注（在JS当中，也就是所谓的装饰器）。从而可以更加优雅的对代码进行控制。

而JS现在有装饰器，虽然现在还在Stage2阶段。但是JS的装饰器更多的是存在于对函数或者属性进行一些操作，比如修改他们的值，代理变量，自动绑定this等等功能。

所以，后文当中我就使用TypeScript来进行讲解，因为TypeScript已经完整的实现了装饰器。

虽然Babel也可以，但是需要各种配置，人懒，不想配置那么多。

但是却无法实现通过反射来获取究竟有哪些装饰器添加到这个类/方法上。

于是ReflectMetadata应运而生。

ReflectMetadata

RelfectMetadata，简单来说，你可以通过装饰器来给类添加一些自定义的信息。然后通过反射将这些信息提取出来。当然你也可以通过反射来添加这些信息。就像是下面这个例子所示。

@Reflect.metadata('name','A')
classA{
@Reflect.metadata('hello','world')
publichello():string{
return'helloworld'
}
}

Reflect.getMetadata('name',A)//'A'
Reflect.getMetadata('hello',newA())//'world'
//这里为什么要用newA()，用A不行么？后文会讲到

是不是很简单，那么我简单来介绍一下~

概念

首先，在这里有四个概念要区分一下：

MetadataKey{Any}后文简写k。元数据的Key，对于一个对象来说，他可以有很多元数据，每一个元数据都对应有一个Key。一个很简单的例子就是说，你可以在一个对象上面设置一个叫做'name'的Key用来设置他的名字，用一个'createdtime'的Key来表示他创建的时间。这个Key可以是任意类型。在后面会讲到内部本质就是一个Map对象。
MetadataValue{Any}后文简写v。元数据的类型，任意类型都行。
Target{Object}后文简写o。表示要在这个对象上面添加元数据
Property{String|Symbol}后文简写p。用于设置在那个属性上面添加元数据。大家可能会想，这个是干什么用的，不是可以在对象上面添加元数据了么？其实不仅仅可以在对象上面添加元数据，甚至还可以在对象的属性上面添加元数据。其实大家可以这样理解，当你给一个对象定义元数据的时候，相当于你是默认指定了undefined作为Property。下面有一个例子大家可以看一下。

大家明白了上面的概念之后，我之前给的那个例子就很简单了~不用我多说了。

安装/使用

下面不如正题，我们怎么开始使用ReflectMetadata呢？

首先，你需要安装reflect-metadatapolyfill，然后引入之后就可以看到在Reflect对象下面有很多关于Metadata的函数了。因为这个还没有进入正式的协议，所以需要安装垫片使用。

啥，Reflect是啥，一个全局变量而已。

你不需要担心这个垫片的质量，因为连Angular都在使用呢，你怕啥。

之后你就可以安装我上面写的示例，在TypeScript当中去跑了。

类/属性/方法装饰器

看这个例子。

@Reflect.metadata('name','A')
classA{
@Reflect.metadata('name','hello')
hello(){}
}

constobjs=[A,newA,A.prototype]
constres=objs.map(obj=>[
Reflect.getMetadata('name',obj),
Reflect.getMetadata('name',obj,'hello'),
Reflect.getOwnMetadata('name',obj),
Reflect.getOwnMetadata('name',obj,'hello')
])
//大家猜测一下res的值会是多少？

想好了么？再给你10秒钟

10
9
8
7
6
5
4
3
2
1

res

[
['A',undefined,'A',undefined],
[undefined,'hello',undefined,undefined],
[undefined,'hello',undefined,'hello'],
]

那么我来解释一下为什么回是这样的结果。

首先所有的对类的修饰，都是定义在类这个对象上面的，而所有的对类的属性或者方法的修饰，都是定义在类的原型上面的，并且以属性或者方法的key作为property，这也就是为什么getMetadata会产生这样的效果了。

那么带Own的又是什么情况呢？

这就要从元数据的查找规则开始讲起了

原型链查找

类似于类的继承，查找元数据的方式也是通过原型链进行的。

就像是上面那个例子，我实例化了一个newA()，但是我依旧可以找到他原型链上的元数据。

举个例子

classA{
@Reflect.metadata('name','hello')
hello(){}
}

constt1=newA()
constt2=newA()
Reflect.defineMetadata('otherName','world',t2,'hello')
Reflect.getMetadata('name',t1,'hello')//'hello'
Reflect.getMetadata('name',t2,'hello')//'hello'
Reflect.getMetadata('otherName',t2,'hello')//'world'

Reflect.getOwnMetadata('name',t2,'hello')//undefined
Reflect.getOwnMetadata('otherName',t2,'hello')//'world'

用途

其实所有的用途都是一个目的，给对象添加额外的信息，但是不影响对象的结构。这一点很重要，当你给对象添加了一个原信息的时候，对象是不会有任何的变化的，不会多property，也不会有的property被修改了。
但是可以衍生出很多其他的用途。

Anuglar中对特殊字段进行修饰(Input)，从而提升代码的可读性。
可以让装饰器拥有真正装饰对象而不改变对象的能力。让对象拥有更多语义上的功能。

API

namespaceReflect{
//用于装饰器
metadata(k,v):(target,property?)=>void

//在对象上面定义元数据
defineMetadata(k,v,o,p?):void

//是否存在元数据
hasMetadata(k,o,p?):boolean
hasOwnMetadata(k,o,p?):boolean

//获取元数据
getMetadata(k,o,p?):any
getOwnMetadata(k,o,p?):any

//获取所有元数据的Key
getMetadataKeys(o,p?):any[]
getOwnMetadataKeys(o,p?):any[]

//删除元数据
deleteMetadata(k,o,p?):boolean
}

大家可能注意到，针对某些操作，会有Own的函数。这是因为有的操作是可以通过原型链进行操作的。这个后文讲解。

深入ReflectMetadata

实现原理

如果你去翻看官网的文档，他会和你说，所有的元数据都是存在于对象下面的[[Metadata]]属性下面。一开始我也是这样认为的，新建一个Symbol('Metadata')，然后将元数据放到这个Symbol对应的Property当中。直到我看了源码才发现并不是这样。请看例子

@Reflect.metadata('name','A')
classA{}

Object.getOwnPropertySymbols(A)//[]

哈哈，并没有所谓的Symbol，那么这些元数据都存在在哪里呢？

其实是内部的一个WeakMap中。他正是利用了WeakMap不增加引用计数的特点，将对象作为Key，元数据集合作为Value，存到WeakMap中去。

如果你认真探寻的话，你会发现其内部的数据结构其实是这样的

WeakMap>>

是不是超级绕，但是我们从调用的角度来思考，这就一点都不绕了。

weakMap.get(o).get(p).get(k)

先根据对象获取，然后在根据属性，最后根据元数据的Key获取最终要的数据。

End

因为ReflectMetadata实在是比较简单，这里就不多讲解了。更多内容请查看Spec

题外话

其实看了源码之后还是挺惊讶的，按照一般的套路，很多polyfill会让你提供一些前置的polyfill之后，当前的polyfill才能使用。但是reflect-metadata竟然内部自己实现了很多的polyfill和算法。比如Map,Set,WeakMap,UUID。最惊讶的莫过于WeakMap了。不是很仔细的阅读了一下，好像还是会增加引用计数。

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

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

JavaScript Reflect Metadata实现详解

热门推荐

随机推荐