应用pkg打包node项目

如今公司有以私有部署增加营收的打算,于是便着手开始对所负责项目进行一键打包。

pkg简述

既然是私有部署,自然需要做到易于部署,保护代码,易于维护。

https://github.com/zeit/pkg

pkg便能满足这些需求

This command line interface enables you to package your Node.js project into an executable that can be run even on devices without Node.js installed

首先看一下官方的简介,pkg能将node.js项目打包成一个不需要node环境就可以运行的可执行文件

pkg使用

这里直接使用package.json 进行打包(当然也可以针对js文件直接进行打包,此处不做赘述),

"bin": "index.js",//项目启动文件

"pkg": {"scripts": "build/**/*.js","assets": "views/**/*" } //需要额外打包进去的目录

在package.json中增加这段,scripts,assets配置未打包进可执行文件的js/json 文件及其他资源文件,文件路径可以使用glob通配符

这是由于pkg只会自动打包require或__dirname的文件(如下),其余文件需手动配置

require('./build/'+cmd+'.js')

path.join(__dirname,'views/'+viewName)


之后使用以下命令即可打包,

pkg .  --target node8-linux --out-path package

(使用node8版本打包一个linux可运行文件,放入package文件夹中,详细参数参见https://github.com/zeit/pkg/blob/master/README.md)

同时需要的是,打包进可执行文件中的文件,以下的系统文件路径发生了变化。因此如有必要,需要对文件地址进行调整。

注意事项

以下是实际打包中遇到的一些问题及解决方法,

1.pkg无法识别引用的变量地址

require('./test/'+ test +'.js')

由于路径不是常量,pkg无法识别要打包的文件是什么,因此尽量将引用地址写为常量地址

如果node_modules里的文件引用存在该现象怎么办呢?

笔者这次便遇到了这个问题,于是采用改写node_modules相关类库相关文件,通过patch-package进行补丁打包,请参考 https://github.com/ds300/patch-package#readme

2.pkg无法打包Native addons (.node files) 

Native addons (.node files) use is supported, but packaging .node files inside the executable is not resolved yet. You have to deploy native addons used by your project to the same directory as the executable.

看一下官方的处理方法,把这类文件拿出来放在可执行文件相同的目录里。

3.配置文件外部挂载,方便运维维护

对config的引用进行处理

var fs =require('fs');

try {

var configJson =JSON.parse(fs.readFileSync(

process.cwd() +'/config.json',

  'utf-8'));

}catch (e) {

  configJson =null;

}

var config =configJson ?configJson :require('./config.json');

exports.config =config;

优先读取挂载在外部的配置文件,如果不存在再读取pkg内部的快照文件,如此便实现了外部挂载,

方便运维对配置文件进行修改。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,496评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,407评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,632评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,180评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,198评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,165评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,052评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,910评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,324评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,542评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,711评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,424评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,017评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,668评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,823评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,722评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,611评论 2 353

推荐阅读更多精彩内容