运行Node时如何从TS文件重新编译JS文件并实现动态重载?
TS场景运行时重载模块的优雅实现方案
方案1:使用ts-node作为运行时(最推荐,开发场景首选)
跳过提前执行tsc编译的步骤,直接用ts-node运行TS代码,它会自动在内存中完成TS到JS的转译,修改.ts文件后直接清缓存重载即可,无需手动触发编译:
安装依赖
npm i ts-node typescript -D
CommonJS规范项目使用示例
let a = require('./a.ts').a console.log(a.foo) // {foo:'foo', bar:'bar'} // 编辑a.ts文件后执行 delete require.cache[require.resolve('./a.ts')] a = require('./a.ts').a console.log(a.foo) // 读取修改后的最新值
ES Module规范项目使用示例
如果你的package.json中配置了"type": "module",运行时加上--loader ts-node/esm参数,用动态import实现重载:
// 运行命令:node --loader ts-node/esm 入口文件.ts let mod = await import('./a.ts') console.log(mod.a.foo) // 编辑a.ts文件后执行,加时间戳查询参数强制跳过ES模块缓存 mod = await import(`./a.ts?t=${Date.now()}`) console.log(mod.a.foo)
方案2:调用TypeScript官方API实现编译加载
如果不想更换运行时,还是保持tsc编译后用node运行JS的流程,可以直接调用TS内置API完成单文件编译,不需要调用shell命令,性能更好也更可控:
安装依赖
npm i typescript @types/node -D
封装重载工具函数
import * as fs from 'fs' import * as ts from 'typescript' import * as path from 'path' function loadTsModule(tsFilePath: string) { // 读取TS源文件 const sourceCode = fs.readFileSync(path.resolve(tsFilePath), 'utf-8') // 调用TS API完成编译,配置和你的tsconfig.json保持一致即可 const compileRes = ts.transpileModule(sourceCode, { compilerOptions: { target: ts.ScriptTarget.ES2020, module: ts.ModuleKind.CommonJS, esModuleInterop: true, strict: false } }) // 输出编译后的JS文件,和tsc编译行为对齐 const jsFilePath = tsFilePath.replace(/\.ts$/, '.js') fs.writeFileSync(path.resolve(jsFilePath), compileRes.outputText) // 清除缓存重新加载 delete require.cache[require.resolve(jsFilePath)] return require(jsFilePath) } // 使用示例 let a = loadTsModule('./a.ts').a console.log(a.foo) // {foo:'foo', bar:'bar'} // 编辑a.ts后重新调用即可拿到最新值 a = loadTsModule('./a.ts').a console.log(a.foo)
方案3:使用成熟的第三方工具
如果不需要自定义逻辑,可以直接用现成的工具降低开发成本:
- 开发阶段可以用
ts-node-dev,它会监听TS文件修改自动重启服务/重载模块,不需要手动写重载逻辑 - 运行时重载可以用
hot-import库,已经封装好了TS编译和缓存清理的逻辑,直接调用API即可
注意事项
- 静态
import语法只能写在文件顶层,动态重载必须使用require或者动态import()语法 - 如果你的模块存在副作用代码,重载时会重新执行副作用,需要提前做好资源清理
- 生产环境使用时建议只给需要动态更新的配置文件开重载能力,避免影响整体性能
内容的提问来源于stack exchange,提问作者Meh.
相关产品推荐
相关产品推荐

