electron-builder解决打包后找不到代码文件、打包指定资源到安装目录的问题

1. 配置files解决打包后找不到代码文件的问题

在开发electron项目时,可能会遇到这种情况:
使用命令 electron . 启动应用,应用正常运行;
使用electron-builder打包,运行打包后的应用程序,出现资源404的情况,应用无法正常运行,如下图:

无法找到资源资源.png

首先介绍一下我的项目结构:

项目根目录
|  main:electron主进程相关的代码
|   └─── main.js
|   └─── preload.js
|  build:打包后的页面代码
|   └─── index.html
|   └─── js文件、css文件、……略
|   package.json
|   ……略

打包后的应用程序找不到对应文件是因为electron-builder打包时没有包含必要的“项目代码文件”,没有对应的文件自然就404了。
在electron-builder的配置中添加files配置项,包含必要的项目代码文件即可解决:

{
    productName: 'xxx',
    appId: 'xxx',
    files: ['./main', './build'], // 包含的文件
}

electron-build打包后的Windows应用程序文件结构如下:

应用程序根目录
|  locales
|   └─── ……略
|  resources
|   └─── app.asar
|  swiftshader
|   └─── ……略
|  应用名.exe
|  ……省略一堆文件

重点看resource文件夹下的app.asar文件,这个文件就是electron-builder打包后的应用入口文件,打开应用时查看console可以看到:

index请求.png

上图请求路径app.asar/build/index.html中的build文件夹就是files中配置的build文件夹;同理,files中配置的main文件夹路径就是app.asar/main
因此,可以把app.asar这个文件看成打包后项目的“根目录”,electron-builder配置项files中包含的文件都在应用程序根目录/resources/app.asar/目录下

但是app.asar是一个文件,为什么可以被electron当作一个目录来使用呢?本人使用文本编辑器打开app.asar粗略的看了一下,发现所有files配置项指定的代码文件,都被打包进了app.asar这个文件中。个人猜测当浏览器访问app.asar/xxx时,electron会去app.asar中解析出对应的xxx文件返回给浏览器。

2. 除了files之外,electron-builder还有其它文件相关的配置,可以打包指定文件:

{
    extraFiles: ['filePath'],
    extraResources: ['filePath'],
}

顾名思义,extraFiles为额外文件,extraResources为额外资源,它们的作用就是打包额外的文件;
比如有这么一个需求:在用户没有网络时,为用户提供某个静态文件的下载;那就必须将这个静态文件打包进应用程序,用户下载时使用electron主进程的node程序读取这个文件返回给用户。
或者有和我一样的需求,为支持puppeteer需要将整个chromium浏览器打包进应用程序中。

配置extraFiles后,electron-builder会在打包时将extraFiles中指定的文件复制到打包后应用程序的根目录下(Windows/Linux),或者Content目录下(MacOS)

配置extraResources后,electron-builder会在打包时将extraResources中指定的文件复制到打包后应用程序的根目录/resources文件夹下(Windows),或者Content/resources文件夹下(MacOS)

另外,filesextraFilesextraResources还都支持from-to指定路径的配置方式,具体参见官方文档的相关章节

3. 打包后的额外文件,在electron主进程中如何获取呢?如何保证开发中和打包后的“额外文件路径”一致呢?

如果你使用的是extraFiles配置项,可以这样做:

  • 将“存放额外文件的文件夹”放在项目根目录下;
  • 配置extraFiles将“存放额外文件的文件夹”打包到应用程序的根目录,确保“存放额外文件的文件夹”不管是在开发时还是打包后都在根目录下;
  • 使用process.cwd()获取Node.js进程当前的工作目录,开发时获取到的是项目根目录,使用electron-builder打包后获取到的是应用程序根目录
  • 有了根目录的路径,直接访问根目录/存放额外文件的文件夹/xxx文件就可以获取对应的文件:
electron-builder配置:
{
    extraFiles: ['./extra-files'],
}
electron主进程:
function getExtraFilesPath(filename: string): string {
    return path.join(process.cwd(), `/extra-files/${filename}`);
}
let filePath = getExtraFilesPath('xxx文件名');

这样无论是在开发中还是打包后都可以获取到正确的文件路径。
如果你使用的是extraResources配置项,也可以使用类似的办法来获取文件。

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

推荐阅读更多精彩内容