写点什么

五分钟了解 Node.js Shebang

2020 年 9 月 11 日

五分钟了解 Node.js Shebang

本文最初发布于 Medium 网站,经原作者授权由 InfoQ 中文站翻译并分享。



JavaScript是一种解释性语言,需要将其源代码提供给某些解释器才能运行。如果要使用Node.js运行 JavaScript 文件,通常会运行以下命令:


$ node yourfile.js
复制代码


输入解释器(node)的名称后,你就明确告诉了外壳如何运行脚本。


但是这些知识可以放在脚本本身中,这样就可以像运行二进制文件一样直接运行它:


$ ./yourfile.js
复制代码


仅当你对该文件有执行权限(例如,可以使用 chmod u+x yourfile.js 设置)并设置了正确的“Shebang”时,此方法才有效。


Shebang


Shebang 或 hashbang(#!代码的英文发音)是文件的第一行,它告诉 OS 使用哪个解释器。它通常看起来像这样:


#!/absolute/path/to/the/interpreter [optional params]
复制代码


Shebang 是一项操作系统特性,可用于运行任何解释语言:Python、Perl 等。对于 Node.js,它可以(但通常不会)看起来像这样:


#!/usr/bin/node
复制代码


只有 Shebang 在文件的第一行时,Node.js 才会高兴地将其忽略为注释(即使它前面有空行或//comment 行也不会起作用)。浏览器也会将其忽略(Chrome74+,FF67+)。


多数人在/usr/bin/node 上都有一个 Node.js 二进制文件或符号链接。如果 Node.js 不在/usr/bin/node 上,操作系统就会抱怨了。例如 bash 会说 bad interpreter: No such file or directory script won’t execute。但有没有办法告诉操作系统使用 Node.js 运行脚本,而不用在乎它安装在哪里呢?


#!node是没用的,因为 Shebang 需要绝对路径。


认识一下 env 吧


env 主要用于在修改后的环境中运行命令。这里的重点是“命令”,因为 env 几乎总是位于/usr/bin/env,而“命令”可以是 PATH 上的任何内容。


如果我们不是写/usr/bin/node 而是写/usr/bin/env node,我们就会告诉 OS 运行 env,而 env 将运行 node,最后 node 将依次执行脚本。


简单来说


这是 Node 脚本最常见的 Shebang:


#!/usr/bin/env node
复制代码


但是,env 还可以使用其他一些技巧。


将参数传递给 Node.js


将-S 选项传递给 env 会使它解析之后发生的一切,从而打开一扇新的大门:将参数传递给命令。


例如,假设我们要运行带有特殊标志的 node,以在运行当前文件时启用 ESM 模块。我们可以使用这个 Shebang:


#!/usr/bin/env -S node --experimental-module
复制代码


再举一个例子:如果我们想在运行当前脚本之前运行另一个脚本,可以使用 Node 的-r 选项:


#!/usr/bin/env -S node -r ./my/other/file.js
复制代码


或打开检查口:


#!/usr/bin/env -S node --inspect
复制代码


请注意,如果你运行诸如 nodeyourfile.js 之类的脚本,Node.js 将不会尝试解析 Shebang 中的参数,而只会忽略它。内核在运行文件之前使用 Shebang 来确定如何运行它。


设置环境变量


还记得我们说过 env 可以在修改后的环境中运行命令吗?实际上这就是它名称的来源,而且它的功能非常强大。假设我们希望脚本以生产模式运行,我们可以设置 NODE_ENV 环境变量:


#!/usr/bin/env -S NODE_ENV=production node
复制代码


否则,运行脚本时 NODE_ENV 将为 undefined 或使用用户终端的设置。


Node.js支持许多环境变量。例如,我们可以使用 NODE_OPTIONS 传递下列 CLI 标志:


#!/usr/bin/env -S NODE_OPTIONS=--experimental-modules node
复制代码


从一个空环境开始


如果我们希望脚本在运行时不访问用户终端上的任何环境变量,则可以使用-i 标志来运行它,该标志代表“忽略环境”:


#!/usr/bin/env -S -i node
复制代码


符号-相当于-i,所以我们也可以这样写:


#!/usr/bin/env -S - node
复制代码


强制禁用 DEBUG


也许我们不想清除所有环境变量,但要屏蔽其中一些。例如 DEBUG(如果你使用的是流行的 debug 包)。也许我们不希望脚本用户将 DEBUG 作为脚本运行时设置标志。那么我们使用-u 标志代表未设置的环境变量。


#!/usr/bin/env -S -u=DEBUG - node
复制代码


如果用户以DEBUG=* ./yourfile.js运行脚本,他们将看不到任何调试信息,但你还是可以用DEBUG=* node ./yourfile.js运行脚本,从而看到 DEBUG 输出。


锁定 Node.js 运行时版本


有时你想锁定用于运行脚本的 node 版本。在 NPM@3 之前,我们可以使用 engineStrict,但是该功能已移除,现在我们只能在package.json中设置engines,它可能位于脚本旁边也可能不在,取决于 engine-strictconfig 配置标志的设置。


但是有一种更简单的方法。由于 node 也是 NPM 包,并且 npx 允许运行任何 NPM 包,因此你可以编写:


#!/usr/bin/env -S npx node@6
复制代码


这可能会在运行脚本后尝试下载请求的 Node 版本(因此,如果 NPX 缓存中不存在所请求版本的 Node,则无法在没有互联网连接的情况下运行)。


提示:你可以使用 process.version 检查节点版本


使用 TypeScript 运行它


没有规则说我们必须运行 node。假设TypeScript和 TS Node 全局可用(npm -i g typescript ts-node),我们可以指定 ts-node 作为解释器:


#!/usr/bin/env ts-node
复制代码


并让它作为 TypeScript 程序运行文件。


在这些示例中,文件都可以使用.js 扩展名或你喜欢的其他任何文件类型,甚至可以没有扩展!


原文链接:《Node Shebang》


2020 年 9 月 11 日 09:571412

评论

发布
暂无评论
发现更多内容

2020 — iOS 面试败北感悟

iOSer

ios iOS Document 大厂面试 iOS面试 底层知识

测开之函数进阶· 第7篇《装饰器装饰类,通用装饰器,有啥区别呢?》

清菡

测试

架构师训练营 - 第 13周课后作业(1 期)

Pudding

如何防止短信验证码接口被恶意调用攻击?

香芋味的猫丶

短信 短信防刷 接口安全 验证码

OpenKruise 2021 规划曝光:More than workloads

阿里巴巴云原生

阿里云 开源 容器 云原生 调度器

案例展示自定义C函数的实现过程

华为云开发者社区

数据库 数据 C语言 字符串

架构训练营 - 第12周课后作业 - 学习总结

Pudding

从根上理解高性能、高并发(三):深入操作系统,彻底理解I/O多路复用

JackJiang

网络编程 高并发 高性能 即时通讯

电商平台如何激发内容生态

马踏飞机747

内容 内容分发网络 电商

美团四面,offer已拿;分享个人面经以及刷题经验!

Java成神之路

Java 程序员 架构 面试 编程语言

掏空各大厂面试题库的“380JAVA面试题(性能优化+微服务+并发编程+开源框架+分布式)”跳槽大厂必备!

Java成神之路

Java 程序员 架构 面试 编程语言

别再问我“阿里架构师和普通程序员的区别了!”看完这篇文章之后你就知道自己差在哪了!

Java成神之路

Java 程序员 架构 面试 编程语言

软件测试--中间件介绍

测试人生路

软件测试 中间件

抽象照进现实

小型火焰🔥

抽象 视觉化

Linux进程知识干货|收藏

赖猫

c++ Linux 后台开发 运维

浅析整洁架构之道(一) 为什么需要整洁架构

御剑

架构 DDD 整洁架构 The Clean Architecture Robert C. Martin

IT2.0:中台构建还应从企业业务实际出发

华为云开发者社区

区块链 分布式 安全 数据 身份安全

架构训练营 - 第 13 周课后作业 - 学习总结

Pudding

分布式身份:重新定义你的“身份”管理

华为云开发者社区

区块链 数据 隐私保护 分布式身份标识

架构师训练营 - 大作业一

Pudding

Linux的进程pid编号极限

程序员架构进阶

Linux 进程

如果腾讯、阿里是弱生态,那么谁是强生态?

ToB行业头条

四年三次获奖,PostgreSQL再度荣获“年度数据库”桂冠!

PostgreSQLChina

数据库 postgresql 开源

架构师训练营 - 大作业二

Pudding

获奖名单|七日更挑战成功!

InfoQ写作平台官方

奖品 活动专区 七日更

anyRTC 2020年12月SDK更新

anyRTC开发者

uni-app android 音视频 WebRTC sdk

云原生2.0时代,华为云DevOps立体运维实践

华为云开发者社区

DevOps 运维 云原生 华为云

纵观 ActiveX 平台的兴衰史,看开发控件的技术演变

Geek_Willie

SpreadJS activex

深度解析!滴滴内部开源Spring IoC和AOP源码小册

Java架构追梦

Java spring 架构 aop ioc

Python的GIL

yunson

Python GIL

敏捷团队的质量保障赋能

BY林子

质量保障 质量赋能 敏捷测试

飞猪Flutter技术演进及业务改造的实践与思考

飞猪Flutter技术演进及业务改造的实践与思考

五分钟了解 Node.js Shebang-InfoQ