TypeScript Namespaces (命名空间)
Namespaces(命名空间) 是 TypeScript 提供的一种组织代码的方法，特别适用于大型项目。通过使用 namespaces，可以将代码分隔成不同的模块，从而避免全局命名空间污染并提升代码的可读性和可维护性。
基本语法
声明 Namespace
Namespace 使用 namespace 关键字进行声明，并可以包含变量、函数、类、接口和子命名空间等。
namespace MyNamespace {
export class MyClass {
constructor(public name: string) {}
sayHello() {
console.log(`Hello, ${this.name}!`);
}
}
export function greet() {
console.log('Greetings from MyNamespace!');
}
export const myConst = 42;
}
在这个示例中，MyNamespace 包含一个类 MyClass，一个函数 greet 和一个常量 myConst。需要注意的是，必须使用 export 关键字导出这些成员，否则它们在命名空间外部将不可访问。
使用 Namespace
可以通过点符号访问命名空间中的导出成员：
const myInstance = new MyNamespace.MyClass('TypeScript');
myInstance.sayHello(); // 输出: Hello, TypeScript!
MyNamespace.greet(); // 输出: Greetings from MyNamespace!
console.log(MyNamespace.myConst); // 输出: 42
嵌套 Namespace
命名空间可以嵌套，这对于分层次组织代码非常有用。
namespace OuterNamespace {
export namespace InnerNamespace {
export function innerFunction() {
console.log('Inside InnerNamespace');
}
}
}
OuterNamespace.InnerNamespace.innerFunction(); // 输出: Inside InnerNamespace
合并 Namespaces
在 TypeScript 中，命名空间可以进行合并。这意味着你可以在多个文件中定义同一个命名空间，它们会被合并在一起。这在大型项目中非常有用。
示例：合并命名空间
文件 file1.ts：
namespace MyNamespace {
export function func1() {
console.log('Function 1');
}
}
文件 file2.ts：
namespace MyNamespace {
export function func2() {
console.log('Function 2');
}
}
在编译和使用时，MyNamespace 将包含两个函数 func1 和 func2：
MyNamespace.func1(); // 输出: Function 1
MyNamespace.func2(); // 输出: Function 2
外部模块与 Namespaces
现代 TypeScript 项目通常使用 ES6 模块（即外部模块）来组织代码，而不是命名空间。模块提供了更好的作用域隔离和更灵活的加载机制。
// module1.ts
export class MyClass {
constructor(public name: string) {}
sayHello() {
console.log(`Hello, ${this.name}!`);
}
}
// module2.ts
import { MyClass } from './module1';
const myInstance = new MyClass('TypeScript');
myInstance.sayHello(); // 输出: Hello, TypeScript!
Namespaces 的使用场景
虽然外部模块在现代 TypeScript 项目中更为常见，但命名空间在以下场景中仍然有用：
- 全局库：对于希望在全局范围内使用的库，命名空间是一个不错的选择。
- 旧代码迁移：在将旧的 JavaScript 项目迁移到 TypeScript 时，命名空间可以帮助逐步组织和隔离代码。
- 简单项目：对于小型项目或简单的脚本，命名空间可以快速组织代码而不需要配置模块加载器。
示例项目
以下是一个完整示例，展示了如何在 TypeScript 项目中使用命名空间：
文件结构
/project
├── index.ts
└── myNamespace.ts
myNamespace.ts
namespace MyNamespace {
export class MyClass {
constructor(public name: string) {}
sayHello() {
console.log(`Hello, ${this.name}!`);
}
}
export function greet() {
console.log('Greetings from MyNamespace!');
}
export const myConst = 42;
}
index.ts
/// <reference path="./myNamespace.ts" />
const myInstance = new MyNamespace.MyClass('TypeScript');
myInstance.sayHello(); // 输出: Hello, TypeScript!
MyNamespace.greet(); // 输出: Greetings from MyNamespace!
console.log(MyNamespace.myConst); // 输出: 42
编译和运行
使用 tsc 命令编译 TypeScript 文件：
tsc --outFile output.js index.ts
这会将所有 TypeScript 文件编译为一个单独的 JavaScript 文件 output.js，并可以在浏览器中运行。
总结
Namespaces 是 TypeScript 提供的一种组织代码的方法，特别适用于大型项目。尽管在现代 TypeScript 项目中，模块化的方式更为常见，但命名空间在某些特定场景中仍然有其优势。理解和灵活运用命名空间和模块，可以帮助你更好地组织和管理你的 TypeScript 代码。