namespace
1019字约3分钟
TypeScript
2023-02-01
namespace 是一种将相关代码组织在一起的方式,中文译为“命名空间”。
它出现在 ES 模块诞生之前,作为 TypeScript 自己的模块格式而发明的。但是,自从有了 ES 模块,官方已经不推荐使用 namespace 了。
✨基本用法
namespace 用来建立一个容器,内部的所有变量和函数,都必须在这个容器里面使用。
namespace Utils {
function isString(value: any) {
return typeof value === "string";
}
// 正确
isString("yes");
}
Utils.isString("no"); // 报错
如果要在命名空间以外使用内部成员,就必须为该成员加上export
前缀,表示对外输出该成员。
namespace Utils {
function isString(value: any) {
return typeof value === "string";
}
// 正确
export isString("yes");
}
Utils.isString("no"); // 可以调用了
注意
namespace 不是一个纯的类型代码,会变成一个值,保留在编译后的代码中。
namespace
内部还可以使用import
命令输入外部成员,相当于为外部成员起别名。当外部成员的名字比较长时,别名能够简化代码。
namespace Utils {
export function isString(value: any) {
return typeof value === "string";
}
}
namespace App {
// 输入外部成员
import isString = Utils.isString;
isString("yes");
// 等同于
Utils.isString("yes");
}
import
命令也可以在namespace
外部,指定别名。
namespace Shapes {
export namespace Polygons {
export class Triangle {}
export class Square {}
}
}
// 外部引入
import polygons = Shapes.Polygons;
// 等同于 new Shapes.Polygons.Square()
let sq = new polygons.Square();
✨namespace 嵌套
namespace Utils {
export namespace Messaging {
export function log(msg: string) {
console.log(msg);
}
}
}
Utils.Messaging.log("hello"); // "hello"
使用嵌套的命名空间,必须从最外层开始引用,比如Utils.Messaging.log()
。
namespace 不仅可以包含实义代码,还可以包括类型代码。
namespace N {
export interface MyInterface {}
export class MyClass {}
}
注意
namespace 与模块的作用是一致的,都是把相关代码组织在一起,对外输出接口。
区别是一个文件只能有一个模块,但可以有多个 namespace。由于模块可以取代 namespace,而且是 JavaScript 的标准语法,还不需要编译转换,所以建议总是使用模块,替代 namespace。
如果 namespace 代码放在一个单独的文件里,那么引入这个文件需要使用三斜杠的语法。
/// <reference path = "SomeFileName.ts" />
✨namespace 的输出
namespace 本身也可以使用export
命令输出,供其他文件使用。
// shapes.ts
export namespace Shapes {
export class Triangle {
// ...
}
export class Square {
// ...
}
}
其他脚本文件使用import
命令,加载这个命名空间。
// 写法一
import { Shapes } from "./shapes";
let t = new Shapes.Triangle();
// 写法二
import * as shapes from "./shapes";
let t = new shapes.Shapes.Triangle();
✨namespace 的合并
多个同名的 namespace 会自动合并,这一点跟 interface 一样。这样做的目的是,如果同名的命名空间分布在不同的文件中,TypeScript 最终会将它们合并在一起。这样就比较方便扩展别人的代码。
namespace Animals {
export class Cat {}
}
namespace Animals {
export interface Legged {
numberOfLegs: number;
}
export class Dog {}
}
// 等同于
namespace Animals {
export interface Legged {
numberOfLegs: number;
}
export class Cat {}
export class Dog {}
}
合并命名空间时,命名空间中的非export
的成员不会被合并,但是它们只能在各自的命名空间中使用。
namespace N {
const a = 0;
export function foo() {
console.log(a); // 正确
}
}
namespace N {
export function bar() {
foo(); // 正确
console.log(a); // 报错
}
}
命名空间还可以跟同名函数合并,但是要求同名函数必须在命名空间之前声明。这样做是为了确保先创建出一个函数对象,然后同名的命名空间就相当于给这个函数对象添加额外的属性。
function f() {
return f.version;
}
namespace f {
export const version = "1.0";
}
f(); // '1.0'
f.version; // '1.0'
命名空间也能与同名 class
合并,同样要求 class
必须在命名空间之前声明,原因同上。
class C {
foo = 1;
}
namespace C {
export const bar = 2;
}
C.bar; // 2
命名空间还能于同名 Enum 合并。
enum E {
A,
B,
C,
}
namespace E {
export function foo() {
console.log(E.C);
}
}
E.foo(); // 2
注意,Enum 成员与命名空间导出成员不允许同名。
enum E {
A, // 报错
B,
}
namespace E {
export function A() {} // 报错
}