声明合并

TypeScript上的一些独特的理念,源自我们从类型上描述JavaScript对象结构(shape)变化的需求。TypeScript中独特的’声明合并’(’declaration merging’)就是其中的一个例子。理解这个概念能够帮助你在TypeScript中更好地处理现有的JavaScript代码。同时它也让实现更高级别的抽象成为了可能。

在理解声明是如何合并的之前,先让我们了解到底什么是’声明合并’。

在这篇文章中,声明合并特指由编译器完成的,将拥有同样名称的,两个独立的的声明合并成一个定义(a single definition)的工作。这个合并而来的定义将同时拥有原来的两个声明的特性。声明合并不限于合并两个声明,符合条件的任意个声明都可以被合并。

基本概念

在TypeScript中,一个声明会来源于下面的三种情况中的一种:命名空间/模块,类型,值。用于创建命名空间/模块的声明可以通过点分隔的表示法获得。用于创建类型的声明会确定一个类型的名称及其结构。第三种创建值的声明在编译输出的JavaScript中可见(如函数和变量)。




















声明类型命名空间类型
模块 X X
X X
接口 X
函数 X
变量 X

在执行一个声明合并时,理解每个声明到底创建了什么能够帮助你更好地确定到底是什么被合并了。

合并接口

最简单也最常见的声明合并莫过于接口的合并。在最简单的情况下,这种合并只是机械地把两个同名接口的成员合并到同一个接口中。

  1. interface Box {
  2. height: number;
  3. width: number;
  4. }
  5. interface Box {
  6. scale: number;
  7. }
  8. var box: Box = {height: 5, width: 6, scale: 10};

接口的非函数的成员必须是独特的。如果两个接口同时声明了一个有着同样名子的非函数的成员的话,编译器会抛出一个错误。

而对于函数成员来说,拥有同样名称的每个函数成员都会被当作是同一个函数的重载情况。同样值得注意的是,当一个接口A在融合另一个接口A时(这里称为A’),A’上的重载的集合将会比接口A上的拥有更高优先级。

比如在下面这个例子中:

  1. interface Document {
  2. createElement(tagName: any): Element;
  3. }
  4. interface Document {
  5. createElement(tagName: string): HTMLElement;
  6. }
  7. interface Document {
  8. createElement(tagName: "div"): HTMLDivElement;
  9. createElement(tagName: "span"): HTMLSpanElement;
  10. createElement(tagName: "canvas"): HTMLCanvasElement;
  11. }

这两个接口将会合并创造出一个声明。注意每个接口中的元素将会维持同样的顺序,只是这些接口身合并时,后出现的重载集合会出现在前面:

  1. interface Document {
  2. createElement(tagName: "div"): HTMLDivElement;
  3. createElement(tagName: "span"): HTMLSpanElement;
  4. createElement(tagName: "canvas"): HTMLCanvasElement;
  5. createElement(tagName: string): HTMLElement;
  6. createElement(tagName: any): Element;
  7. }

合并模块

和接口相似,拥有相同名称的模块也会合并它们的成员。由于模块会同时创建一个命名空间和一个值,这里我们需要同时理解这二者是如何合并的。

当合并两名命名空间时,每个模块输出的接口的声明中所创建的类型的定义会相互合并。它们会创建一个带有合并后的接口的命名空间。

当合并值时,两个模块中的值会合并在一起。如果两个模块中有同名称的值,则第二个模块中的值优先。

下面这个例子中的’Animals’的声明合并:

  1. module Animals {
  2. export class Zebra { }
  3. }
  4. module Animals {
  5. export interface Legged { numberOfLegs: number; }
  6. export class Dog { }
  7. }

等同于:

  1. module Animals {
  2. export interface Legged { numberOfLegs: number; }
  3. export class Zebra { }
  4. export class Dog { }
  5. }

虽然这个模块合并的例子对我们的理解很有帮助,但我们同样也需要知道在未被输出的成员上到底发生了什么,来帮助我们更完整地理解模块合并。未被输出的成员只在原模块(未被合并的模块)中可见。这意味着来自不同声明中的成员即便在合并以后也不能看到对方未被输出的成员。

我们可以通过下面的例子更好地理解这一点:

  1. module Animal {
  2. var haveMuscles = true;
  3. export function animalsHaveMuscles() {
  4. return haveMuscles;
  5. }
  6. }
  7. module Animal {
  8. export function doAnimalsHaveMuscles() {
  9. return haveMuscles; // <-- error, haveMuscles is not visible here
  10. }
  11. }

因为haveMuscles并未被输出,所以只有在未合并前处在同一个模块中的animalsHaveMuscles函数才能知道haveMuscles的存在。虽然在被合并以后,doAnimalsHaveMuscles函数也是Animal模块的一部分,但它无法得知另一个模块中的那些未被输出的成员。

用模块合并类,函数和枚举

事实上模块非常灵活,它也可以合并其他类型的声明。想要合并其他类型的声明的话,这个模块的声明就必须要紧跟在它要合并的其他声明的后面。这样声明得到的结果,会同时拥有这两种声明类型的属性。TypeScript正是通过这一能力来模拟JavaScript和其他一些编程语言上的设计模式的。

我们要看的第一个模块合并的例子是用来合并一个模块和一个类的。这让声明内部类成为了可能。

  1. class Album {
  2. label: Album.AlbumLabel;
  3. }
  4. module Album {
  5. export class AlbumLabel { }
  6. }

这里合并后的成员的可见性同我们在’Merging Modules’部分中描述的是一样的。所以我们必须输出AlbumLabel类,来使被合并的类能够看见它。合并的结果便是是一个类出现在了另一个类中。你用样也可以用模块来给一个已经存在的类添加更多的静态成员。

除了内部类的模式以外,你可能也很熟悉下面这种JavaScript应用:先创建一个函数,然后再给这个函数添加其他的属性。通过TypeScript的声明合并,你可以在保障类型安全(type-safe)的情况下来实现这种定义。

  1. function buildLabel(name: string): string {
  2. return buildLabel.prefix + name + buildLabel.suffix;
  3. }
  4. module buildLabel {
  5. export var suffix = "";
  6. export var prefix = "Hello, ";
  7. }
  8. alert(buildLabel("Sam Smith"));

相似地,模块也可以用静态成员来扩展枚举。

  1. enum Color {
  2. red = 1,
  3. green = 2,
  4. blue = 4
  5. }
  6. module Color {
  7. export function mixColor(colorName: string) {
  8. if (colorName == "yellow") {
  9. return Color.red + Color.green;
  10. }
  11. else if (colorName == "white") {
  12. return Color.red + Color.green + Color.blue;
  13. }
  14. else if (colorName == "magenta") {
  15. return Color.red + Color.blue;
  16. }
  17. else if (colorName == "cyan") {
  18. return Color.green + Color.blue;
  19. }
  20. }
  21. }

不被允许的合并

在TypeScript中,并不是所有类型都能够合并。到目前为止,一个类不能合并另一个类,变量与类之间不能够合并,接口和类之间也不能够合并。如果你想要模拟类的合并的话,你可以通过Mixins部分来了解更多。