TypeScript中的模块系统总结

1,798 阅读4分钟

一、TS 模块系统

虽然早期的时候,TypeScript 有一套自己的模块系统实现,但是随着更新,以及 JavaScript 模块化的日趋成熟,TypeScriptESM 模块系统的支持也是越来越完善

1.模块

无论是 JavaScript 还是 TypeScript 都是以一个文件作为模块最小单元

  • 任何一个包含了顶级 import 或者 export 的文件都被当成一个模块
  • 相反的一个文件不带有顶级的 import 或者 export ,那么它的内容就是全局可见的

2.全局模块

如果一个文件中没有顶级 import 或者 export ,那么它的内容就是全局的,整个项目可见的,这就容易造成变量命名冲突

// a.ts
let a1 = 100;
let a2 = 200;
// b.ts
// ok, 100
console.log(a1);
// error,因为a.ts没有`import` 或者 `export`,所有a.ts里的a2是个全局变量,b.ts里再声明一个a2就冲突了
let a2 = 300;

不推荐使用全局模块,因为它会容易造成代码命名冲突(全局变量污染)

3.文件模块

任何一个包含了顶级 import 或者 export 的文件都会当做一个模块,在 TypeScript 中也称为外部模块。

二、模块语法

TypeScriptESM 语法类似

导出模块内部数据

使用 export 导出模块内部数据(变量、函数、类、类型别名、接口……)

导入外部模块数据

使用 import 导入外部模块数据

三、模块编译

TypeScript 编译器也能够根据相应的编译参数,把代码编译成指定的模块系统使用的代码

module 选项

TypeScript 编译选项中,module 选项是用来指定生成哪个模块系统的代码,可设置的值有:"none""commonjs""amd""udm""es6"/"es2015/esnext""System"

  • target=="es3" or "es5":默认使用 commonjs

四、模块导出默认值的问题

如果一个模块没有默认导出

// m1.ts
export let obj = {
  x: 1
}

则在引入该模块的时候,需要使用下列一些方式来导入:解构、别名

// main.ts
// error: 提示 m1 模块没有默认导出
import v from './m1'

// 可以简单的使用如下方式,解构
import {obj} from './m1'
console.log(obj.x)
// 或者设置别名
import * as m1 from './m1'
console.log(m1.obj.x)

五、加载非 TS 文件

有的时候,我们需要引入一些 js 的模块,比如导入一些第三方的使用 js 而非 ts 编写的模块,默认情况下 tsc 是不对非 ts 模块文件进行处理的,比如下面这种情况:

// m1.js
export default 100;
// main.ts
import m1 from './m1.js'

我们可以通过 allowJs 选项开启该特性,在tsconfig.json文件里设置

{
    "compilerOptions": {
        "outDir": "./dist",       // 输出目录
        "target": "es5",		
        "watch": true,			 // 持续监听变化
        "module": "none",		 // 模块编译选项
        "allowJs": true,         //  这个选项,允许处理js文件
        "strictNullChecks": true,
        "noImplicitAny": true,
        "lib": [
            "es6",
            "dom"
        ]
    },
    "include": [
        "./src/**/*"
    ]
}

ESM 模块中的默认值问题

ESM 中模块可以设置默认导出值

export default '开课吧';

但是在 CommonJSAMD 中是没有默认值设置的,它们导出的是一个对象(exports

module.exports.obj = {
    x: 100
}

TypeScript 中导入这种模块的时候会出现 模块没有默认导出的错误提示

这时候,可以有简单一些的做法:

import * as m from './m1.js'

通过tsconfig.json中配置选项解决:

allowSyntheticDefaultImports,设置为:true,允许从没有设置默认导出的模块中默认导入。

虽然通过上面的方式可以解决编译过程中的检测问题,但是编译后的具体要运行代码还是有问题的

esModuleInterop,设置为:true,则在编译的同时生成一个 __importDefault 函数,用来处理具体的 default 默认导出

注意:以上设置只能当 module 不为 es6+ 的情况下有效

以模块的方式加载 JSON 格式的文件

TypeScript 2.9+ 版本添加了一个新的编译选项:resolveJsonModule,它允许我们把一个 JSON 文件作为模块进行加载,在tsconfig.json中把:resolveJsonModule,设置为:true ,可以把 json 文件作为一个模块进行解析

data.json

{
    "name": "zMouse",
    "age": 35,
    "gender": "男"
}

ts文件

import * as userData from './data.json';
console.log(userData.name);

六、命名空间

TS 中,exportimport 称为 外部模块,TS 中还支持一种内部模块 namespace,它的主要作用只是单纯的在文件内部(模块内容)隔离作用域

namespace k1 {
    let a = 10;
    export var obj = {
        a
    }
}

namespace k2 {
    let a = 20;
    console.log(k1.obj);
}