Node.js 打包

Node.js - 打包应用程序

为什么要打包 Node.js 应用程序？

通常，部署 Node.js 应用程序涉及将源代码（.js 文件）、静态资源（assets）和 node_modules 目录复制到服务器，确保安装了正确的 Node.js 版本，然后使用 node index.js 或进程管理器运行应用程序。

打包 Node.js 应用程序旨在简化此部署过程。主要优点包括：

简化分发：将应用程序、其依赖项以及可能包括 Node.js 运行时本身打包到一个可执行文件中。
更轻松的部署：只需复制可执行文件即可进行部署，无需在目标机器上安装 Node.js 或运行 npm install。
源代码保护（模糊处理）：虽然不是真正的加密，但打包可以使查看或修改原始源代码变得更加困难。
依赖项管理：避免目标系统上缺少或依赖项不兼容的问题。

现代打包工具

有几种工具可用于将 Node.js 应用程序打包成独立的（standalone）可执行文件。两个流行的选择是：

1. pkg (由 Vercel 开发)

pkg 是一个命令行工具，它将您的 Node.js 项目打包成可执行文件，即使在没有安装 Node.js 的系统上也能运行。它会捆绑您的代码、资源和依赖项。

安装：

npm install -g pkg

基本用法：

# In your project directory
pkg your-entry-file.js

# Example: Target specific platforms
pkg your-entry-file.js --targets node18-linux-x64,node18-macos-x64,node18-win-x64

# Example: Specify output directory
pkg . --output my-app

pkg 分析您的项目以确定要包含的文件，但有时需要在 package.json（"pkg" 部分）中进行配置，以便正确地捆绑（bundle）资源或处理动态的 require 调用。

了解更多：https://github.com/vercel/pkg

2. Nexe

Nexe 是另一个将 Node.js 应用程序编译成单个可执行文件的实用工具。它通过将您的源代码和依赖项直接嵌入到自定义构建的 Node.js 二进制文件（binary）中来实现此功能。

安装：

npm install -g nexe

基本用法：

# In your project directory
nexe your-entry-file.js

# Example: Specify output file name
nexe index.js -o my-application.exe

# Example: Specify Node.js version to build against
nexe index.js -t windows-x64-18.17.0

Nexe 在打包过程中通常需要下载或构建特定的 Node.js 版本，这可能需要一些时间。

了解更多：https://github.com/nexe/nexe

替代方案：容器化 (Docker)

虽然不像前两种工具那样创建单个可执行文件，但使用 Docker 进行容器化是打包和部署 Node.js 应用程序的一种非常常见且强大的方式。

Docker 容器将您的应用程序代码、Node.js 运行时、依赖项（node_modules）以及任何必需的操作系统库捆绑到一个隔离的环境中（称为容器镜像）。这个镜像可以在安装了 Docker 的不同机器上一致地运行。

优点：

环境一致性：确保应用程序在任何地方都以相同的方式运行。
隔离性：使应用程序依赖项与主机系统分离。
可伸缩性：使用容器编排工具（如 Kubernetes）易于管理和扩展。
可重现性：在代码中定义整个应用程序环境（Dockerfile）。

一个简单的 Node.js 应用程序的 Dockerfile 可能看起来像这样：

# 使用官方 Node.js 运行时作为基础镜像
FROM node:18-alpine

# 设置容器中的工作目录
WORKDIR /usr/src/app

# 复制 package.json 和 package-lock.json
COPY package*.json ./

# 安装应用程序依赖项
RUN npm ci --only=production

# 捆绑应用程序源代码
COPY . .

# 暴露应用程序运行的端口
EXPOSE 3000

# 定义运行应用程序的命令
CMD [ "node", "server.js" ]

构建和运行这个 Dockerfile 需要 Docker 知识，但这是现代后端部署的标准实践。

选择方法

如果您需要一个单一的可执行文件以便于分发，特别是对于桌面工具或不希望安装 Node.js 的简单部署场景，请选择 pkg 或 Nexe。

如果您正在构建将在云环境（cloud environments）中部署的 Web 服务或应用程序，或者需要强大的环境管理和可伸缩性，请选择 Docker。

注意：像 JXcore 这样在早期教程中提到的工具，通常已不再维护或广泛使用。pkg、Nexe 和 Docker 是现代的解决方案。