使用pkg打包Node.js应用的方法步骤


Posted in Javascript onOctober 19, 2018

Node.js应用不需要经过编译过程,可以直接把源代码拷贝到部署机上执行,确实比C++、Java这类编译型应用部署方便。然而,Node.js应用执行需要有运行环境,意味着你需要先在部署机器上安装Node.js。虽说没有麻烦到哪里去,但毕竟多了一个步骤,特别是对于离线环境下的部署机,麻烦程度还要上升一级。假设你用Node.js写一些小的桌面级工具软件,部署到客户机上还要先安装Node.js,有点“大炮打蚊子”的感觉。更严重的是,如果部署机器上游多个Node.js应用,而且这些应用要依赖于不同的Node.js版本,那就更难部署了。

理想的情况是将Node.js打包为一个单独的可执行文件,部署的时候直接拷贝过去就行了。除了部署方便外,因为不需要再拷贝源代码了,还有利于保护知识产权。

将Node.js打包为可执行文件的工具有pkg、nexe、node-packer、enclose等,从打包速度、使用便捷程度、功能完整性来说,pkg是最优秀的。这篇文章就来讲一讲半年来我使用pkg打包Node.js应用的一些经验。

pkg的打包原理简单来说,就是将js代码以及相关的资源文件打包到可执行文件中,然后劫持fs里面的一些函数,使它能够读到可执行文件中的代码和资源文件。例如,原来的require('./a.js')会被劫持到一个虚拟目录require('/snapshot/a.js')。

安装

pkg既可以全局安装也可以局部安装,推荐采用局部安装:

npm install pkg --save-dev

用法

pkg使用比较简单,执行下pkg -h就可以基本了解用法,基本语法是:

pkg [options] <input>

<input>可以通过三种方式指定:

1.一个脚本文件,例如pkg index.js;
2.package.json,例如pkg package.json,这时会使用package.json中的bin字段作为入口文件;
3.一个目录,例如pkg .,这时会寻找指定目录下的package.json文件,然后在找bin字段作为入口文件。

[options]中可以指定打包的参数:

1.-t指定打包的目标平台和Node版本,如-t node6-win-x64,node6-linux-x64,node6-macos-x64可以同时打包3个平台的可执行程序;
2.-o指定输出可执行文件的名称,但如果用-t指定了多个目标,那么就要用--out-path指定输出的目录;
3.-c指定一个JSON配置文件,用来指定需要额外打包脚本和资源文件,通常使用package.json配置。

使用pkg的最佳实践是:在package.json中的pkg字段中指定打包参数,使用npm scripts来执行打包过程,例如:

{
 ...
 "bin": "./bin/www",
 "scripts": {
  "pkg": "pkg . --out-path=dist/"
 },
 "pkg": {
  "scripts": [...]
  "assets": [...],
  "targets": [...]
 },
 ...
}

scripts和assets用来配置未打包进可执行文件的脚本和资源文件,文件路径可以使用glob通配符。这里就浮现出一个问题:为什么有的脚本和资源文件打包不进去呢?

要回答这个问题,就涉及到pkg打包文件的机制。按照pkg文档的说法,pkg只会自动地打包相对于__dirname、__filename的文件,例如path.join(__dirname, '../path/to/asset')。至于require(),因为require本身就是相对于__dirname的,所以能够自动打包。假设文件中有以下代码:

require('./build/' + cmd + '.js')
path.join(__dirname, 'views/' + viewName)

这些路径都不是常量,pkg没办法帮你自动识别要打包哪个文件,所以文件就丢失了,所以这时候就使用scripts和assets来告诉pkg,这些文件要打包进去。那么我们怎么知道哪些文件没有被打包呢?难倒要一行行地去翻源代码吗?其实很简单,只需要把打包好的文件运行下,报错信息一般就会告诉你缺失哪些文件,并且pkg在打包过程中也会提示一些它不能自动打包的文件。

注意事项

如果说pkg还有哪儿还可以改进的地方,那就是无法自动打包二进制模块*.node文件。如果你的项目中引用了二进制模块,如sqlite3,那么你需要手动地将*.node文件复制到可执行文件同一目录,我通常使用命令cp node_modules/**/*.node .一键完成。但是,如果你要跨平台打包,例如在windows上打包linux版本,相应的二进制模块也要换成linux版本,通常需要你手动的下载或者编译。

那为什么pkg不能将二进制模块打包进去呢?我猜想是require载入一个js文件和node文件,它们的机制是不一样的。另外从设计来说,不自动打包二进制模块也是合理的,因为二进制模块都是平台相关的。如果我在windows上生成一个linux文件,那么就需要拉取linux版本的.node文件,这是比较困难的。并且有些二进制模块不提供预编译版本,需要安装的时候编译,pkg再牛也不可能模拟一个其他平台的编译环境吧。nexe可以自动打包二进制模块,但是只能打包当前平台和当前版本的可执行文件。这意味着如果Node.js应用引用了二进制包,那么这个应用就不能跨平台打包了,所以我认为这方面,nexe不能算是一个好的设计。

还有一点就是关于项目中的配置文件处理,比如数据库连接参数、环境变量等。因为这些配置文件会跟着不同的部署环境进行更改,所以为了方便更改,一般不希望把配置文件打包到exe。为了避免pkg自动地将配置文件打包到exe中,代码中不要采用以下方式读取配置文件:

fs.readFile(path.join(__dirname, './config.json')), callback)

而是采用相对于process.CWD()的方法读取:

fs.readFile(path.join(process.CWD(), './config.json'), callback)
// 或者
fs.readFile('./config.json', callback)

如果配置文件是js格式的,那么不要直接require('./config'),而是采用动态require:

const config = require(process.CWD() + './config')

另外要提及的是pkg打包之后动态载入js文件会有安全性问题,即用户可以在js文件写任何处理逻辑,注入到打包后的exe中。例如,可以读取exe里面的虚拟文件系统,把源代码导出来。所以,尽量不要采用JS作为配置文件,也不要动态载入js模块。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
用JavaScript修改CSS属性的代码
May 06 Javascript
javascript定义变量时有var和没有var的区别探讨
Jul 21 Javascript
编写简单的jQuery提示插件
Dec 21 Javascript
jQuery实现ichat在线客服插件
Dec 29 Javascript
JavaScript数组常用方法
Mar 02 Javascript
JavaScript子窗口调用父窗口变量和函数的方法
Oct 09 Javascript
微信QQ的二维码登录原理js代码解析
Jun 23 Javascript
js修改onclick动作的四种方法(推荐)
Aug 18 Javascript
JS按条件 serialize() 对应标签的使用方法
Jul 24 Javascript
jQuery实现购物车的总价计算和总价传值功能
Nov 28 jQuery
微信小程序使用二次贝塞尔曲线画波浪
Dec 25 Javascript
jQuery+vue.js实现的多选下拉列表功能示例
Jan 15 jQuery
简化版的vue-router实现思路详解
Oct 19 #Javascript
vue中el-upload上传图片到七牛的示例代码
Oct 19 #Javascript
浅析vue-router原理
Oct 19 #Javascript
vue-cli3.0 脚手架搭建项目的过程详解
Oct 19 #Javascript
vue-quill-editor+plupload富文本编辑器实例详解
Oct 19 #Javascript
vue+VeeValidate 校验范围实例详解(部分校验,全部校验)
Oct 19 #Javascript
浅析JS中什么是自定义react数据验证组件
Oct 19 #Javascript
You might like
一个很方便的 XML 类!!原创的噢
2006/10/09 PHP
php 删除数组元素
2009/01/16 PHP
jsp+javascript打造级连菜单的实例代码
2013/06/14 Javascript
script不刷新页面的联动前后代码
2013/09/18 Javascript
jquery ajax jsonp跨域调用实例代码
2013/12/11 Javascript
ListBox实现上移,下移,左移,右移的简单实例
2014/02/13 Javascript
javascript setinterval 的正确语法如何书写
2014/06/17 Javascript
nodejs 实现模拟form表单上传文件
2014/07/14 NodeJs
浅谈js构造函数的方法与原型prototype
2016/07/04 Javascript
Bootstrap源码解读下拉菜单(4)
2016/12/23 Javascript
JavaScript中的toString()和toLocaleString()方法的区别
2017/02/15 Javascript
简单谈谈require模块化jquery和angular的问题
2017/06/23 jQuery
vue-cli3.0配置及使用注意事项详解
2018/09/05 Javascript
小程序云开发初探(小结)
2018/10/24 Javascript
在Create React App中启用Sass和Less的方法示例
2019/01/16 Javascript
js实现鼠标拖拽缩放div实例代码
2019/03/25 Javascript
JavaScript如何实现防止重复的网络请求的示例
2021/01/28 Javascript
[04:15]DOTA2-DPC中国联赛1月19日Recap集锦
2021/03/11 DOTA
python如何在终端里面显示一张图片
2016/08/17 Python
python实现textrank关键词提取
2018/06/22 Python
python提取包含关键字的整行数据方法
2018/12/11 Python
深度辨析Python的eval()与exec()的方法
2019/03/26 Python
python隐藏终端执行cmd命令的方法
2019/06/24 Python
VPS CENTOS 上配置python,mysql,nginx,uwsgi,django的方法详解
2019/07/01 Python
python实现秒杀商品的微信自动提醒功能(代码详解)
2020/04/27 Python
Python利用Faiss库实现ANN近邻搜索的方法详解
2020/08/03 Python
python re的findall和finditer的区别详解
2020/11/15 Python
python 利用jieba.analyse进行 关键词提取
2020/12/17 Python
Manuka Doctor英国官网:真正的麦卢卡蜂蜜和护肤品
2018/10/26 全球购物
PHP引擎php.ini参数优化深入讲解
2021/03/24 PHP
体育课课后反思
2014/04/24 职场文书
北京离婚协议书范文2014
2014/09/29 职场文书
大学感恩节活动策划方案
2014/10/11 职场文书
2014年妇幼卫生工作总结
2014/12/09 职场文书
2014年体检中心工作总结
2014/12/23 职场文书
杨善洲电影观后感
2015/06/04 职场文书