ts 动态加载import()

import()函数 

简介

import命令会被 JavaScript 引擎静态分析,先于模块内的其他模块执行(叫做”连接“更合适)。所以,下面的代码会报错。

  1. // 报错
  2. if (x === 2) {
  3. import MyModual from './myModual';
  4. }

上面代码中,引擎处理import语句是在编译时,这时不会去分析或执行if语句,所以import语句放在if代码块之中毫无意义,因此会报句法错误,而不是执行时错误。也就是说,importexport命令只能在模块的顶层,不能在代码块之中(比如,在if代码块之中,或在函数之中)。

这样的设计,固然有利于编译器提高效率,但也导致无法在运行时加载模块。在语法上,条件加载就不可能实现。如果import命令要取代 Node 的require方法,这就形成了一个障碍。因为require是运行时加载模块,import命令无法取代require的动态加载功能。

  1. const path = './' + fileName;
  2. const myModual = require(path);

上面的语句就是动态加载,require到底加载哪一个模块,只有运行时才知道。import语句做不到这一点。

因此,有一个提案,建议引入import()函数,完成动态加载。

  1. import(specifier)

上面代码中,import函数的参数specifier,指定所要加载的模块的位置。import命令能够接受什么参数,import()函数就能接受什么参数,两者区别主要是后者为动态加载。

ES6 import()返回一个 Promise 对象。下面是一个例子。

  1. const main = document.querySelector('main');
  2. import(`./section-modules/${someVariable}.js`)
  3. .then(module => {
  4. module.loadPageInto(main);
  5. })
  6. .catch(err => {
  7. main.textContent = err.message;
  8. });

import()函数可以用在任何地方,不仅仅是模块,非模块的脚本也可以使用。它是运行时执行,也就是说,什么时候运行到这一句,也会加载指定的模块。另外,import()函数与所加载的模块没有静态连接关系,这点也是与import语句不相同。

import()类似于 Node 的require方法,区别主要是前者是异步加载,后者是同步加载。

适用场合

下面是import()的一些适用场合。

(1)按需加载。

import()可以在需要的时候,再加载某个模块。

  1. button.addEventListener('click', event => {
  2. import('./dialogBox.js')
  3. .then(dialogBox => {
  4. dialogBox.open();
  5. })
  6. .catch(error => {
  7. /* Error handling */
  8. })
  9. });

上面代码中,import()方法放在click事件的监听函数之中,只有用户点击了按钮,才会加载这个模块。

(2)条件加载

import()可以放在if代码块,根据不同的情况,加载不同的模块。

  1. if (condition) {
  2. import('moduleA').then(...);
  3. } else {
  4. import('moduleB').then(...);
  5. }

上面代码中,如果满足条件,就加载模块 A,否则加载模块 B。

(3)动态的模块路径

import()允许模块路径动态生成。

  1. import(f())
  2. .then(...);

上面代码中,根据函数f的返回结果,加载不同的模块。

注意点

import()加载模块成功以后,这个模块会作为一个对象,当作then方法的参数。因此,可以使用对象解构赋值的语法,获取输出接口。

  1. import('./myModule.js')
  2. .then(({export1, export2}) => {
  3. // ...·
  4. });

上面代码中,export1export2都是myModule.js的输出接口,可以解构获得。

如果模块有default输出接口,可以用参数直接获得。

  1. import('./myModule.js')
  2. .then(myModule => {
  3. console.log(myModule.default);
  4. });

上面的代码也可以使用具名输入的形式。

  1. import('./myModule.js')
  2. .then(({default: theDefault}) => {
  3. console.log(theDefault);
  4. });

如果想同时加载多个模块,可以采用下面的写法。

  1. Promise.all([
  2. import('./module1.js'),
  3. import('./module2.js'),
  4. import('./module3.js'),
  5. ])
  6. .then(([module1, module2, module3]) => {
  7. ···
  8. });

import()也可以用在 async 函数之中。

  1. async function main() {
  2. const myModule = await import('./myModule.js');
  3. const {export1, export2} = await import('./myModule.js');
  4. const [module1, module2, module3] =
  5. await Promise.all([
  6. import('./module1.js'),
  7. import('./module2.js'),
  8. import('./module3.js'),
  9. ]);
  10. }
  11. main();

       import("../script/XMDefine").then(
            (moudle) => {
                console.log(moudle);
                moudle.XMDefine.ActicitiesID;
                console.log(moudle.XMDefine.ActicitiesID);
            });

        let ts = import("../script/XMDefine");
        console.log((await ts).XMDefine.ActicitiesID);

### 如何在TypeScript项目中导入JavaScript文件 为了使TypeScript能够识别并处理JavaScript模块,在`tsconfig.json`文件中的配置至关重要。通常情况下,TypeScript会忽略`.js`文件除非特别指定了允许加载这些文件以及定义它们的类型声明方式。 #### 修改 `tsconfig.json` 确保项目的根目录下存在一个名为`tsconfig.json`的文件,并对其进行如下设置: ```json { "compilerOptions": { "allowJs": true, "checkJs": false, "esModuleInterop": true, "skipLibCheck": true, "strict": true, "target": "es6", "moduleResolution": "node" }, "include": ["src/**/*"] } ``` 上述配置项解释如下: - `"allowJs"` 设置为 `true` 表示允许TypeScript编译器读取和理解JavaScript源码。 - `"checkJs"` 默认设为 `false` 可以防止TypeScript对JavaScript文件执行严格的类型检查;如果希望启用此功能,则可将其改为 `true`[^1]。 - `"esModuleInterop"` 启用了ES Module互操作模式,使得CommonJS风格导出可以在ESM环境中被正确解析。 - `"skipLibCheck"` 跳过库类型的验证加快构建速度。 - `"strict"` 开启严格模式来帮助发现潜在错误。 - `"target"` 定义了目标ECMAScript版本以便于兼容不同环境下的浏览器或Node.js实例。 - `"moduleResolution"` 使用 Node 的算法来进行模块查找,这有助于更好地支持npm包管理工具所安装依赖之间的相互引用关系。 #### 导入 JavaScript 文件到 TypeScript 中 当需要在一个TypeScript文件里引入外部未打字面量化的JavaScript资源时,可以通过两种方法实现这一点: ##### 方法一:直接通过相对路径引用 假设有一个位于同一级目录下的`helperFunctions.js`文件想要在其对应的TypeScript文件内调用其中的方法,可以直接按照下面的方式书写import语句: ```typescript // 假定 helperFunctions.js 和当前 ts 文件在同一目录级别 import { someFunction } from './helperFunctions'; someFunction(); ``` 这种方法适用于简单的场景,即不需要额外提供.d.ts声明文件的情况。然而对于更复杂的案例来说,推荐采用第二种方案——创建自定义声明文件。 ##### 方法二:编写 `.d.ts` 类型声明文件 针对较为复杂的应用程序结构或是第三方库的情况下,应该考虑为每一个要使用的JavaScript模块单独建立相应的`.d.ts`描述符文档。这样做不仅可以让编辑器获得更好的提示体验,同时也提高了代码的安全性和可靠性。 例如,如果有这样一个来自node_modules之外位置的javascript脚本叫做`customLibrary.js`, 那么就需要为其配套制作一份同名但扩展名为`.d.ts`的新文件(`customLibrary.d.ts`),并在里面明确定义该库公开接口的形式签名: ```typescript declare module 'customLibrary' { export function customMethod(param: string): void; } ``` 之后就可以像平常一样正常使用这个库而不用担心缺少必要的类型信息了: ```typescript import * as CustomLib from 'customLibrary'; CustomLib.customMethod('test'); ``` 以上就是关于如何在TypeScript工程内部顺利集成JavaScript组件的主要介绍[^2]。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

VCHH

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值