TypeScript 学习笔记 之 模块的解析

模板的解析就是编译器通过导入语句如 import { a } from "moduleA" 找到 "moduleA" 模块然后找到 a 的定义的过程。
moduleA 可能是在 .ts.tsx.d.ts 文件中。编译器首先要做的就是找到对应的模块文件。

  1. 首先编译器通过 ClassicNode 策略查找。
  2. 如果第一步查找不到,并且如果模块名并不是相对的,则根据 ambient module 来查找。
  3. 如果以上方式都找不到,则抛出 查找 不到的异常。

Relative vs. No-relative imports

/./../ 开头的称之为相对导入模块名。其他的则称为非相对导入。

相对导入是基于执行导入的当前文件的,而且不会以ambient module 的解析方式去解析。一般只用于内部模块。

而非相对导入,一是可以基于 baseUrl 来查找 。或者根据 path 映射来查找 ,也会通过 ambient module 的声明来查找 。可用于任何外部依赖。

模块解析策略

Classic 策略

假设 /root/src/folder/A.ts 文件中有如下相对导入声明 import { b } from "./moduleB"。 那么将查找以下两个路径:

  1. /root/src/folder/moduleB.ts
  2. /root/src/folder/moduleB.d.ts

假设使用的是非相对导入声明,即 import { b } from "moduleB"
那么将查找以下路径:

  1. /root/src/folder/moduleB.ts
  2. /root/src/folder/moduleB.d.ts
  3. /root/src/moduleB.ts
  4. /root/src/moduleB.d.ts
  5. /root/moduleB.ts
  6. /root/moduleB.d.ts
  7. /moduleB.ts
  8. /moduleB.d.ts

Node 策略

先来看一下 Node.js 中的导入逻辑,Node.js 的导入操作其实是由 require 函数完成
的。
假设 /root/src/moduleA.js 中有如下相对导入声明: var x = require("./moduleB"); 那么 Node.js 将按下面的顺序解析:

  1. /root/src/moduleB.js
  2. 是否有 /root/src/moduleB目录包含了一个 package.json 的文件声明了 main 模块,如果有如: {"main":"lib/mainModule.js"} 则解析 /root/src/moduleB/lib/mainModule.js
  3. 是否有 /root/src/moduleB目录包含了名为 index.js 的文件。

在 Node.js 中对于非相对导入的话,差别就大一些了。
还是按上面的假设。导入声明换成非相对导入,即:var x = require("moduleB")

  1. /root/src/node_modules/moduleB.js

  2. /root/src/node_modules/moduleB/package.json (如果有指定 main 属性)

  3. /root/src/node_modules/moduleB/index.js

  4. /root/node_modules/moduleB.js

  5. /root/node_modules/moduleB/package.json (如果有指定 main 属性)

  6. /root/node_modules/moduleB/index.js

  7. /node_modules/moduleB.js

  8. /node_modules/moduleB/package.json (如果有指定 main 属性)

  9. /node_modules/moduleB/index.js

TS 的模块解析策略

TS 的相对导入

假设 /root/src/moduleA.ts 文件中有如下相对导入声明 import { b } from "./moduleB"。 那么将查找以下路径:

  1. /root/src/moduleB.ts
  2. /root/src/moduleB.tsx
  3. /root/src/moduleB.d.ts
  4. /root/src/moduleB/package.json (如果有指定 types 属性)
  5. /root/src/moduleB/index.ts
  6. /root/src/moduleB/index.tsx
  7. /root/src/moduleB/index.d.ts

TS 的非相对导入

假设 /root/src/moduleA.ts 文件中有如下相对导入声明 import { b } from "moduleB"。 那么将查找以下路径:

  1. /root/src/node_modules/moduleB.ts

  2. /root/src/node_modules/moduleB.tsx

  3. /root/src/node_modules/moduleB.d.ts

  4. /root/src/node_modules/moduleB/package.json (if it specifies a "types" property)

  5. /root/src/node_modules/moduleB/index.ts

  6. /root/src/node_modules/moduleB/index.tsx

  7. /root/src/node_modules/moduleB/index.d.ts

  8. /root/node_modules/moduleB.ts

  9. /root/node_modules/moduleB.tsx

  10. /root/node_modules/moduleB.d.ts

  11. /root/node_modules/moduleB/package.json (if it specifies a "types" property)

  12. /root/node_modules/moduleB/index.ts

  13. /root/node_modules/moduleB/index.tsx

  14. /root/node_modules/moduleB/index.d.ts

  15. /node_modules/moduleB.ts

  16. /node_modules/moduleB.tsx

  17. /node_modules/moduleB.d.ts

  18. /node_modules/moduleB/package.json (if it specifies a "types" property)

  19. /node_modules/moduleB/index.ts

  20. /node_modules/moduleB/index.tsx

  21. /node_modules/moduleB/index.d.ts

TS 的模块解析选项

Base URL

baseUrl 将告诉编译器查找非相对导入起始路径。

  1. 命令行参数指定, 如果是相当路径则表示相对于当前路径。
  2. 如果是通过 tsconfig.json 指定。则表示相对 tsconfig.json 文件所在的路径。

Path mapping

如果一些库的路径无法通过上面的标准解析路径解析。那么可以通过在 tsconfig.json 中配置 paths 属性。
jquery 库的路径是 node_modules/jquery/dist/jquery.slim.min.js,不是一个标记的 node_modules 路径。则可使用如下配置:

{
   "compilerOptions": {
      "baseUrl": ".",
      "paths": {
          "jquery": ["node_modules/jquery/dist/jquery"]
       }
  }
}

值得注意的是 paths 是相对 baseUrl 的。

Virtual Directories with rootDirs

当项目源文件的结构是有多路径,但是编译结果会在一个目录中。此时可以通过 rootDirs 来 指定编译期其他的相对路径查找列表。如下两个 views 目录下的文件就可以通过 ./template1.ts 来方式来引用另一目录的模块。

{
  "compilerOptions": {
    "rootDirs": [
      "src/views",
      "generated/templates/views"
    ]
  }
}

Tracing module resolution

可以通过 tsc --traceResolution 来输出模块的解析日志。

参考 : Module Resolution

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容

  • relative 和 non-relative import Relative Import以/, ./或../为...
    柳正来阅读 10,424评论 0 2
  • 布尔值 let isBoolean: boolean = true; 数字 let num: number = 1...
    田小宝_640c阅读 771评论 0 2
  • nodejs通过require加载模块,require里面分为相对路径和非相对路径,不同的表示方法,node的寻找...
    前端大魔王阅读 885评论 1 2
  • 决不能饿着肚子去超市,因为那会彻底颠覆你的购物清单。但如果是刚吃过饭去呢,呵呵,居然不知买点儿什么好。有的超...
    西楼风雨阅读 188评论 0 0
  • 今天是2月的最后一天,过了今天,18年就过去六分之一了。 1月的一次旅行,让我发现身边比你牛很多的人还比你认真学习...
    灯灯a灯灯阅读 139评论 0 0