Electron 打包优化

electron-builder 打包分析

打包后的项目结构

查看一下electron-builder 打包后的目录结构:

主要项目文件

  • app.asar

项目的代码进行打包后的文件。默认情况下会对我们的整个项目进行的打包

  • electron.exe

应用的主程序,编译好的程序,运行 resource/app.asar 这个文件内所包含的项目代码

打包优化

直接打包的问题

  • 体积大
  • 暴露源码

优化方向

从项目目录结构中可以看出,electron.exe、app.asar 等文件是每个 Electron 应用都一样且必需的,因此我们可以优化的空间只是 app.asar 文件。

目前 app.asar 是将我们的项目整个打包,整个应用之所以大,原因在于 node_modules 文件夹特别大。因此我们要做的是我们的应用能否不打包 node_modules 文件夹,或者让需要打包的东西尽可能的少。

优化减少dependencies依赖项

需要打包 dependencies 中的依赖,是因为 electron 是直接运行我们的源码的,依赖引用的路径是从 node_modules 文件夹中查找。因此,优化应用程序的体积就需要减少打包的依赖数量,即减少 dependencies 中的依赖。

如何减少 dependencies 中依赖?

如果我们将代码进行打包,将需要使用到的依赖直接打包进最终的文件,那就可以不需要再将 node_modules 打包进应用程序了。并且通过打包一方面可以减少应用的体积,另一方面也可以对我们的代码进行混淆,避免暴露源码。

视图层代码打包

使用 webpack 进行一个简单的打包,新建 webpack.config.js

const path = require("path")

module.exports = {
  entry: './main.js',
  output: {
    path: path.resolve(__dirname, './build'),
    filename: 'main.js'
  }
}

需要注意的是,我们在使用 webpack 的时候,__dirname 会默认为根目录 /,但这并不是我们想要的结果,我们需要它的绝对路径,需要在导出项中再添加一项配置:

  node: {
    __dirname: false,
  }

script 中添加命令如下:

"buildMain": "webpack"

执行 npm run buildMain,此时 build 文件下就会有一个 main.js 文件。

在对视图层的代码打包之后,只有视图层需要用的代码就不再需要打包进 node_modules 文件夹中了,最简单的方法就是在 package.json 文件中将这部分依赖从 dependencies 移动到 devDependencieselectron-builder 不会将 dependencies 中的依赖打包应用程序

主进程(electron 层)代码打包

使用 webpack 对主进程的代码打包与普通页面的打包基本一致。需要注意的是 target 需要设置为 electron-main,在 webpack.config.js 文件的导出项中添加:

  target: 'electron-main',
必须保留的 dependencies 依赖

执行完上面的步骤之后,删除 node_modules 文件重新打包,会发现 node_modules 文件还是会被打包进最终的应用中。这是因为 electron-builder 打包时也是在打包某个平台的版本时重新安装相应平台的依赖包,以此来实现 electron 跨平台。

package.json 项目结构

electron-builder 提供的另外一种方式帮助我们管理依赖,也就是双 package.json 项目结构。

  • 在原本的项目下新建一个需要打包的文件夹 app
    如果项目下有 app 文件夹,electron-builder 在打包时会以该文件夹为打包的根文件夹,就是只会打包该文件夹下的文件。配置中设置的需要打包的文件也是基于 app 文件来设置。
"build": {
    "files": [
      "build/**/*",
      "node_modules/**/*",
      "package.json"
    ]
  },

则 webpack 进行打包时只会打包 buildnode_modulespackage.json 文件夹下的文件。

这个时候由于我们的入口文件已经变为了 build/main.js,如果 package.json还是执行 main.js 就会报错,那么就需要我们在 package.jsonbuild 中添加一个选项,这个选项在 electron 中叫做 extraMetadata

"extraMetadata": {
  "main": "./build/main.js"
},

修改 script 中的命令

"script": {
    ...
    "pack": "electron-builder --dir",
    "prepack": "npm run build && npm run buildMain",
    "dist": "electron-builder",
    "predist": "npm run build && npm run buildMain",
  },
}

执行 npm run dist 对我们的项目进行重新的打包,就可以看到项目的体积会有一个极大的优化。

打包优化
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容