Node.js 中 -r 或 --require 命令行选项的用途与实战详解

星丽君_6880

星丽君_6880

2026-05-21

303人浏览

原创

-r(或 --require)用于在执行主脚本前预加载指定模块,常用于注入全局行为、启用编译器(如 ts-node)、修改内置对象或设置运行时环境,但不适用于直接导出函数供 REPL 使用。

`-r`(或 `--require`)用于在执行主脚本前预加载指定模块,常用于注入全局行为、启用编译器(如 ts-node)、修改内置对象或设置运行时环境,但不适用于直接导出函数供 repl 使用。

-r 是 Node.js 提供的一个强大而常被误解的 CLI 选项。它的核心语义是:在用户代码(即你传入的入口脚本或 REPL 环境)执行之前,同步加载并执行指定的模块。该模块的导出内容不会自动挂载到全局作用域,也不会“暴露”给后续脚本——它只负责完成自身的初始化逻辑。

✅ 正确用法:预加载 + 副作用驱动

最典型的场景是通过副作用(side effect)修改运行时环境。例如,下面这个 hook.js 会劫持 console.log:

// hook.js
const originalLog = console.log;
console.log = (...args) => originalLog('[HOOKED]', ...args);

再创建一个普通脚本 app.js:

// app.js
console.log('Hello from app.js!');

执行命令:

node -r ./hook.js app.js

输出为:

[HOOKED] Hello from app.js!

注意:app.js 完全无需 require('./hook.js') —— -r 已确保它在 app.js 执行前完成加载和执行。

❌ 错误用法:期望“导出即可用”

回到你的 circle.js 示例:

用于自动切换项目中适合的node 版本
用于自动切换项目中适合的node 版本

根据 package.json 中的 engines 字段自动检测 Node.js 版本需求,未安装 nvm 时自动安装并切换至对应版本。支持 Windows、macOS、Linux。适用于 Node.js 项目开发、版本切换和环境配置。

下载
#! /opt/node-v20.6.0-linux-x64/bin/node
'use strict';

function areaOfCircle(circleRadius) {
  return Math.PI * circleRadius ** 2;
}

export areaOfCircle; // ES module 语法

当你运行:

node -r ${XDG_RUNTIME_DIR}/circle.js

Node 启动的是交互式 REPL(因为没指定主脚本),此时:

  • circle.js 被加载并执行;
  • 但由于它是 ES 模块(含 export),且未被任何上下文 import,其内部声明的 areaOfCircle 不会自动提升至全局作用域;
  • REPL 中自然无法访问 areaOfCircle,报错 ReferenceError: areaOfCircle is not defined。

✅ 正确做法有二:

  1. 若需在 REPL 中使用:改用 CommonJS 并显式挂载到 global:

    // circle.cjs
    function areaOfCircle(circleRadius) {
      return Math.PI * circleRadius ** 2;
    }
    global.areaOfCircle = areaOfCircle; // 显式暴露

    然后:

    node -r ./circle.cjs
    > areaOfCircle(5) // ✅ 78.53981633974483
  2. 若需作为模块复用:直接运行脚本(非 -r):

    node circle.js  # ❌ 不推荐(ESM 无默认导出入口)
    # 更好:新建 main.js 导入它
    // main.js
    import { areaOfCircle } from './circle.js';
    console.log(areaOfCircle(3)); // ✅
    node main.js

? 实际工程场景示例

场景 命令 说明
启用 TypeScript 运行 node -r ts-node/register src/index.ts ts-node/register 劫持 .ts 文件加载逻辑
启用 dotenv 配置 node -r dotenv/config src/server.js dotenv_config_path=.env 自动加载环境变量,无需在代码中 require('dotenv').config()
启用源码映射(sourcemap)调试 node -r source-map-support/register app.js 让错误堆栈指向原始 TypeScript/ES6 源码行

⚠️ 注意事项

  • -r 加载的模块必须能被 Node.js 正常解析(路径正确、格式兼容);
  • ES 模块(.mjs 或含 "type": "module" 的 .js)在 -r 中需 Node ≥ v12 且启用 --experimental-modules(旧版本);现代推荐统一用 .cjs 或通过 --loader 配合 ESM;
  • 多个 -r 可叠加,按从左到右顺序执行:node -r a.js -r b.js app.js → 先 a.js,再 b.js,最后 app.js;
  • 在 package.json 的 scripts 中可安全使用:"dev": "node -r dotenv/config -r ts-node/register src/index.ts"。

掌握 -r 的本质——“提前执行、依赖副作用、不自动导出”——就能避开常见陷阱,将其转化为提升开发体验的利器。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js node.js node require函数

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5186

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1269

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

5104

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1916

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3625

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4733

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3100

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

988

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习