简介
@aurelia/metadata 是 Aurelia 框架的一个核心模块之一，用于提供元数据注解系统。通过元数据系统，我们可以为一个模块、类、函数等添加额外的信息，让这些信息在我们开发过程中为我们所用。
安装和使用
在您的项目根目录下使用 npm 来安装 @aurelia/metadata 包。
npm install @aurelia/metadata --save
在您的项目中引用此库：
import {Metadata} from '@aurelia/metadata';
现在，您可以使用 @Metadata 注解系统在您的代码中进行元数据的添加和分析。以下是一个示例代码：
-- -------------------- ---- ------- ------ ---------- ---- -------------------- --------- ----- ------- - ------ ----- - -------- ------ ----- - ---------- - ----- --------------- - --------------------------------------- ----------------------------------- -- ------- ----------------------------------- -- ---------展开代码
在上面的代码中，我们为 MyClass 类添加了两个元数据。然后，我们使用 Metadata.getOwn 方法来获取类的元数据，并通过键名来获取相应的元数据。
深入了解 @Metadata 注解系统
@metadata
使用 @metadata 装饰器来为一个类或一个属性添加元数据。以下是一个添加元数据的示例代码：
import {metadata} from '@aurelia/metadata'; @metadata("value", "Hello from metadata") class MyClass {} console.log(metadata.getOwn(metadata.key(MyClass, "value"))); // Hello from metadata
MetadataStorage
MetadataStorage 类用于存储所有的元数据。以下是一个使用 MetadataStorage 的示例：
-- -------------------- ---- ------- ------ ----------------- ---- -------------------- ----- --------------- - --- ------------------ ----- ------- -- ------------------------------------------ - --------- ------- --------- --- -------------------------------------------------------- -- ---- ----------------------------------------------------------------- -- ------- ---------展开代码
在上面的代码中，我们创建了一个 实例 MetadataStorage 对象 metadataStorage 来存储所有的元数据。然后我们给 MyClass 类添加了元数据，通过 metadata.key 创建元数据的键名，通过 metadataStorage.add 添加元数据。
Metadata
Metadata 类是 @aurelia/metadata 中最为核心的类之一，提供了注解系统所需的大多数特性，它具有以下方法：
get
Metadata.get 方法获取指定类型的元数据。以下是一个使用 Metadata.get 的示例：
import {Metadata} from '@aurelia/metadata'; class MyClass {} Metadata.define("customKey", "Hello from metadata", MyClass); console.log(Metadata.get("customKey", MyClass)); // 'Hello from metadata'
getOwn
Metadata.getOwn 方法获取指定类型的元数据，这里的 Own 表示获取自身的元数据，而不是继承的元数据。以下是一个使用 Metadata.getOwn 的示例：
-- -------------------- ---- ------- ------ ---------- ---- -------------------- ----- ----------- - ------ ---------- - ------- ---------- - ----- ---------- ------- ----------- -- ---------------------------- ------ ---- ----- ------- ------------ ---------------------------------------- ------------- -- ------ ---- ----- ------ ----------------------------------------- ------------- -- ---------展开代码
在上面的代码中，我们定义了一个父类 ParentClass，并为其添加了一个自身的元数据，同时定义一个子类 ChildClass， 并为其添加了一个自身的元数据。通过 Metadata.getOwn 方法可以获取自身的元数据，而不是从父类继承下来的。
has
Metadata.has 方法用于检查一个类型是否具有指定类型的元数据。以下是一个使用 Metadata.has 的示例：
import {Metadata} from '@aurelia/metadata'; class MyClass {} Metadata.define("value", "Hello, Aurelia!", MyClass); console.log(Metadata.has("value", MyClass)); // true console.log(Metadata.has("age", MyClass)); // false
在上面的代码中，我们使用 Metadata.has 来检查一个类中是否有指定的元数据。
define
Metadata.define 方法用于定义一个元数据，其第一个参数是键名，第二个参数是元数据的值，第三个参数是类型。以下是一个使用 Metadata.define 的示例：
import {Metadata} from '@aurelia/metadata'; class MyClass {} Metadata.define("value", "Hello from metadata", MyClass); console.log(Metadata.get("value", MyClass)); // 'Hello from metadata'
在上面的代码中，我们使用 Metadata.define 来定义一个元数据。
metadata.key
metadata.key 是用于构建类或属性的键值的工具函数。以下是一个使用 metadata.key 的示例：
import {metadata} from '@aurelia/metadata'; class MyClass {} console.log(metadata.key(MyClass)); // '_metadata' console.log(metadata.key(MyClass, 'myProperty')); // 'myProperty_metadata'
在上面的代码中，我们使用 metadata.key 函数来为我们的 MyClass 类和 myProperty 属性创建一个唯一的键名。
指导意义
元数据注解系统是一种非常灵活和高效的方式，在前端开发中应用广泛。通过为应用程序和组件添加额外的信息和元数据，我们可以实现更加丰富和灵活的应用程序和组件开发。@aurelia/metadata 模块为我们提供了一种灵活和高效的添加和使用元数据的方式，我们可以在我们的项目中应用此模块来提高应用程序的灵活性和可扩展性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedcaa5b5cbfe1ea0612474
