使用pkg打包nodejs项目并解决本地文件读取的问题

 更新时间:2023年10月31日 11:02:23   作者:走在大前端的路上  
这篇文章主要介绍了使用pkg打包nodejs项目并解决本地文件读取的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

使用pkg打包nodejs项目

使用pkg对nodejs程序进行打包,能对项目源码和重要文件进行一定的保护,也能提升程序运行的便捷性,使用npm install -g pkg全局安装pkg。

这里我的所有代码写在一个js文件(anyAPIcheck.js)中,并包含一些依赖文件:

实际上这是一个非常小的项目,项目主体也只有一个js文件,使用pkg可将该项目主体文件及其引用文件打包为一个可执行文件。

进入项目根目录,执行命令pkg anyAPIcheck.js 可同时打包windows、Linux及macos下的可执行文件,默认打包为64位可执行文件,首次打包需要将nodejs以二进制编译到pkg缓存路径中,这一步耗时较长,需要耐心等待。

打包完成后会在项目根目录生成一个可执行文件,该文件自带nodejs,所以不需要用户额外安装nodejs环境。

当然,你也可以个性化打包,如:

  • pkg -t node12-win-x86 anyAPIcheck.js (使用node12版本单独打包windows下的32位可执行文件)
  • pkg -t node14-win-x64 anyAPIcheck.js (使用node14版本单独打包windows下的64位可执行文件)
  • pkg -t node12-win-x86 anyAPIcheck.js -o myAPP(使用node12版本单独打包windows下的32位可执行文件并将可执行文件命名为myAPP)
  • pkg -t node12-linux-x64 anyAPIcheck.js (使用node12版本单独打包linux下的64位可执行文件)
  • pkg -t node12-macos-x64 anyAPIcheck.js (使用node12版本单独打包macos下的64位可执行文件)

注意:

nodejs新版本中没有32位linux与macos版本,只有64位版本的,只有windows同时包含32位与64位版本。

本人使用多个以前的node版本打包32位linux与macos可执行文件均报错,目前看来暂时无法将项目打包为linux与macos下的32位可执行文件。

pkg打包的可执行程序读取本地文件

pkg打包前与打包后的路径有一些变化,比如打包的时候用 pkg /path/app.js ,那么打包后,__filename 就是 /snapshot/path/app.js, __dirname 就是 /snapshot/path,

详细如下表所示:

process.cwd() 就是打包后的可执行程序(比如windows下的exe文件,这个exe文件你可以随意移动)所在路径,__dirname则是exe内部项目根目录,有如下文件引用场景:

1.项目需要引用配置文件config.json,该配置文件内容固定不变。

  • 引用方法: path.join( __dirname, ‘config.json’)
  • 注意: path.join()函数中,如果引用文件在项目根目录直接写 'config.json’即可,如果不在需要填入详细路径。

2.项目需要引用配置文件config.json,该配置文件内容动态变化。

  • 引用方法:可将config.json文件复制到exe文件所在目录,使用 path.join( process.cwd(), ‘config.json’)
  • 注意: path.join()函数中,如果引用文件与exe同级,直接写 'config.json’即可,如果在exe文件同级目录下的子目录中,需要填入详细路径。 

文件引用问题解决后需要使用 fs.readFileSync(configPath, “utf-8”)读取文件内容,configPath参数为文件引用路径,注意了,一定要使用同步读取readFileSync,因为很可能你程序后面的操作需要在读取文件的基础上进行,如果使用异步读取readFile,则文件还没读取后面的操作就继续进行了,会直接报错。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • node puppeteer(headless chrome)实现网站登录

    node puppeteer(headless chrome)实现网站登录

    这篇文章主要介绍了node puppeteer(headless chrome)实现网站登录,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • nodeJS实现简单网页爬虫功能的实例(分享)

    nodeJS实现简单网页爬虫功能的实例(分享)

    下面小编就为大家带来一篇nodeJS实现简单网页爬虫功能的实例(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • Nodejs Stream 数据流使用手册

    Nodejs Stream 数据流使用手册

    这篇文章主要介绍了Nodejs Stream 数据流使用手册的相关资料,感兴趣的小伙伴一起学习吧
    2016-04-04
  • package.json配置文件构成详解

    package.json配置文件构成详解

    这篇文章主要介绍了package.json配置文件构成以及相关知识点内容,有兴趣的朋友们可以学习下。
    2019-08-08
  • NodeJS、NPM安装配置步骤(windows版本) 以及环境变量详解

    NodeJS、NPM安装配置步骤(windows版本) 以及环境变量详解

    本篇文章主要介绍了NodeJS、NPM安装配置步骤(windows版本) 以及环境变量详解,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-05-05
  • 手把手带你搭建一个node cli的方法示例

    手把手带你搭建一个node cli的方法示例

    这篇文章主要介绍了手把手带你搭建一个node cli的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • 一文详解如何降低node包版本

    一文详解如何降低node包版本

    这篇文章主要给大家介绍了关于如何降低node包版本的相关资料,在开发的工程中我们可能需要经常切换node版本来应对不同的开发环境,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2023-11-11
  • node使用async_hooks模块进行请求追踪

    node使用async_hooks模块进行请求追踪

    这篇文章主要介绍了node使用async_hooks模块进行请求追踪,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • node.js通过axios实现网络请求的方法

    node.js通过axios实现网络请求的方法

    下面小编就为大家分享一篇node.js通过axios实现网络请求的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-03-03
  • Node.js、Socket.IO和GPT-4构建AI聊天机器人的项目实践

    Node.js、Socket.IO和GPT-4构建AI聊天机器人的项目实践

    本文主要介绍了Node.js、Socket.IO和GPT-4构建AI聊天机器人的项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-05-05

最新评论