TypeScript是一种静态类型的JavaScript超集语言,它支持模块化开发和声明文件。
模块化开发是一种将代码分割为独立的模块,每个模块只关注自己的功能,然后通过导入和导出来实现模块之间的交互和复用。在TypeScript中,可以使用import和export关键字来导入和导出模块。
导入模块的方式有两种:命名空间导入和默认导入。
命名空间导入使用import * as语法,可以将整个模块作为一个命名空间引入,然后通过命名空间来访问导出的成员。默认导入使用import语法,可以将模块中的默认导出引入,然后通过自定义的名称来访问导出的成员。
导出模块的方式也有两种:命名导出和默认导出。命名导出使用export关键字,可以将指定的成员导出,其他模块可以通过import语法来导入这些成员。默认导出使用export default关键字,可以将模块中的默认成员导出,其他模块可以通过import语法来导入默认成员。
声明文件是一种补充TypeScript编译器的类型信息的文件,用于描述JavaScript模块、类、方法等的类型。在TypeScript中,通常使用.d.ts文件扩展名的文件来编写声明文件。声明文件中可以定义变量、函数、类、模块等的类型,使其在使用时能够获得正确的类型推导和代码补全。
声明文件可以通过三种方式之一进行使用:全局声明、局部声明和模块声明。
全局声明是将声明文件直接引入到项目中,可以在整个项目中使用声明文件中的类型定义。
局部声明是将声明文件与具体的代码文件进行关联,只在该代码文件中使用声明文件中的类型定义。
模块声明是将声明文件与某个模块进行关联,只在该模块中使用声明文件中的类型定义。
总之,TypeScript的模块化开发和声明文件是提高开发效率和代码可维护性的重要工具。模块化开发可以帮助我们将复杂的代码分割为独立的模块,提升代码的可复用性和可测试性;声明文件可以提供类型信息,使得编码过程更加快速和安全。
TypeScript 模块
TypeScript 模块的设计理念是可以更换的组织代码。
模块是在其自身的作用域里执行,并不是在全局作用域,这意味着定义在模块里面的变量、函数和类等在模块外部是不可见的,除非明确地使用 export 导出它们。类似地,我们必须通过 import 导入其他模块导出的变量、函数、类等。
两个模块之间的关系是通过在文件级别上使用 import 和 export 建立的。
模块使用模块加载器去导入其它的模块。 在运行时,模块加载器的作用是在执行此模块代码前去查找并执行这个模块的所有依赖。 大家最熟知的JavaScript模块加载器是服务于 Node.js 的 CommonJS 和服务于 Web 应用的 Require.js。此外还有有 SystemJs 和 Webpack。
模块导出使用关键字 export 关键字,语法格式如下:
// 文件名 : SomeInterface.ts
export interface SomeInterface
{
// 代码部分
}
要在另外一个文件使用该模块就需要使用 import 关键字来导入:
import someInterfaceRef = require("./SomeInterface");
实例
/// <reference path = "IShape.ts" />
export interface IShape {
draw();
}
import shape = require("./IShape");
export class Circle implements shape.IShape {
public draw() {
console.log("Cirlce is drawn (external module)");
}
}
import shape = require("./IShape");
export class Triangle implements shape.IShape {
public draw() {
console.log("Triangle is drawn (external module)");
}
}
import shape = require("./IShape");
import circle = require("./Circle");
import triangle = require("./Triangle");
function drawAllShapes(shapeToDraw: shape.IShape) {
shapeToDraw.draw();
}
drawAllShapes(new circle.Circle());
drawAllShapes(new triangle.Triangle());
TypeScript 声明文件
TypeScript 作为 JavaScript 的超集,在开发过程中不可避免要引用其他第三方的 JavaScript 的库。
虽然通过直接引用可以调用库的类和方法,但是却无法使用TypeScript 诸如类型检查等特性功能。为了解决这个问题,需要将这些库里的函数和方法体去掉后只保留导出类型声明,而产生了一个描述 JavaScript 库和模块信息的声明文件。通过引用这个声明文件,就可以借用 TypeScript 的各种特性来使用库文件了。
假如我们想使用第三方库,比如 jQuery,我们通常这样获取一个 id 是 foo 的元素:
$('#foo');
// 或
jQuery('#foo');
但是在 TypeScript 中,我们并不知道 $ 或 jQuery 是什么东西:
jQuery('#foo');
// index.ts(1,1): error TS2304: Cannot find name 'jQuery'.
declare 定义的类型只会用于编译时的检查,编译结果中会被删除。
上例的编译结果是:
jQuery('#foo');
声明文件
声明文件以 .d.ts 为后缀,例如:
zachen.d.ts
声明文件或模块的语法格式如下:
declare module Module_Name {
}
TypeScript 引入声明文件语法格式:
/// <reference path = " zachen.d.ts" />
当然,很多流行的第三方库的声明文件不需要我们定义了,比如 jQuery 已经有人帮我们定义好了:jQuery in DefinitelyTypedhttps://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery/index.d.ts
实例
以下定义一个第三方库来演示:
var Zachen;
(function(Zachen) {
var Calc = (function () {
function Calc() {
}
})
Calc.prototype.doSum = function (limit) {
var sum = 0;
for (var i = 0; i <= limit; i++) {
sum = sum + i;
}
return sum;
}
Zachen.Calc = Calc;
return Calc;
})(Zachen|| (Zachen= {}));
var test = new Zachen.Calc();
如果我们想在 TypeScript 中引用上面的代码,则需要设置声明文件 Calc.d.ts,代码如下:
declare module Zachen {
export class Calc {
doSum(limit:number) : number;
}
}
声明文件不包含实现,它只是类型声明,把声明文件加入到 TypeScript 中:
/// <reference path = "Calc.d.ts" />
var obj = new Zachen.Calc();
// obj.doSum("Hello"); // 编译错误
console.log(obj.doSum(10));
下面这行导致编译错误,因为我们需要传入数字参数:
obj.doSum("Hello");
使用 tsc 命令来编译以上代码文件:
tsc CalcTest.ts
生成的 JavaScript 代码如下:
/// <reference path = "Calc.d.ts" />
var obj = new Zachen.Calc();
//obj.doSum("Hello"); // 编译错误
console.log(obj.doSum(10));
最后我们编写一个 zachen.html 文件,引入 CalcTest.js 文件及第三方库 CalcThirdPartyJsLib.js:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Zachen(zachen)</title>
<script src = "CalcThirdPartyJsLib.js"></script>
<script src = "CalcTest.js"></script>
</head>
<body>
<h1>声明文件测试</h1>
<p>测试一下。</p>
</body>
</html>