【electron-playground系列】打包優化之路


作者:梁棒棒

簡介

electron打包工具有兩個:electron-builderelectron-packager,官方還提到electron-forge,其實它不是一個打包工具,而是一個類似於cli的工具集,目的是簡化開發到打包的一整套流程,內部打包工具依然是electron-packager

electron-builderelectron-packager相比各有優劣,electron-builder配置項較多,更加靈活,打包體積相對較小,同時上手難度大;而electron-packger配置簡單易上手,但是打出來的應用程序包體積相對較大。

我們選擇electron-builder作為electron-playground項目的打包工具,配合webpack實現更靈活的打包配置。打包配置在electron-playground中已有說明,這里不再贅述,主要講述一下打包一個electron項目的優化點,打包優化分為打包時間優化和體積優化,本篇講述體積優化。

node_modules優化

electron空項目打包后的dmg體積在75M左右,32位exe文件體積在52M左右,64位的exe體積則為105M左右。

注:空項目依賴版本為:electron: ^10.1.5 electron-builder: ^22.9.1 系統版本為:macOS Catalina 10.15.6。

而我們的項目打包后dmg體積為165M,ia32exe也在128M左右,比預期大很多,分析一下包,在release -> 【版本號命名的文件夾】 -> win-ia32-unpacked -> resources 下有個app.asar文件,這其實是個壓縮包,目的是保護代碼隱私,在build中可配置是否需要壓縮為asar包。
在electron-builder.yml中加入:

asar: true

用asar工具包解壓。

# 安裝
npm install asar -g

# 解壓
asar extract app.asar <解壓后的目錄>

解壓然后看下包中有哪些內容:
image.png
dist和resources是配置項中指定的需要復制打包的內容,這沒有問題,可是node_modules中的依賴項已經在webpack打包構建時一同打包進了dist下,它不應該在這里,而且electron-builder配置項files中也沒有指定復制此文件夾。帶着這個疑問,查看一下文檔,終於找到了原因,原來files有默認值:

[
  "**/*",
  "!**/node_modules/*/{CHANGELOG.md,README.md,README,readme.md,readme}",
  "!**/node_modules/*/{test,__tests__,tests,powered-test,example,examples}",
  "!**/node_modules/*.d.ts",
  "!**/node_modules/.bin",
  "!**/*.{iml,o,hprof,orig,pyc,pyo,rbc,swp,csproj,sln,xproj}",
  "!.editorconfig",
  "!**/._*",
  "!**/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,.gitignore,.gitattributes}",
  "!**/{__pycache__,thumbs.db,.flowconfig,.idea,.vs,.nyc_output}",
  "!**/{appveyor.yml,.travis.yml,circle.yml}",
  "!**/{npm-debug.log,yarn.lock,.yarn-integrity,.yarn-metadata.json}"
]
package.json and **/node_modules/**/* (only production dependencies will be copied) is added to your custom in any case. 

意思是:package.json和node_modules(僅僅生產依賴項會被復制)在任何情況下都會被添加至自定義(應該是files配置項下吧)中。

那這就很清楚了,我只需要在files中添加"!node_modules"即可,打包后體積是128M,足足小了37M,安裝執行,沒有問題。
依賴項的問題解決了,但是體積還是沒達預期,查看包內容,果然,圖片!這個永遠也避不開的優化難題。

圖片優化

圖片優化在整個項目的優化中是優先級較高的,所謂的圖片優化,其實是體積與質量之間的博弈,因此要想減小包中圖片的體積,是要犧牲一部分圖片質量的,也就是清晰度。做出如下優化:

  • 首先對gif圖在不影響用戶觀看的前提下做了一定壓縮;
  • 將一些png(流程圖,logo,線條簡單的)轉為svg;
  • 將一些截圖png轉為jpg;

最終將整體包體積dmg減小至102M,ia32exe為80M左右(后續功能更新會有一定出入);

依賴項,按需加載

然后檢查一下依賴項的位置和引用,首先對於package.json中依賴項進行排查,查看dependencies和devDependencies中的依賴項有沒有錯位的(開發依賴項寫在了生產依賴項中),由於打包時只打包dependencies中的依賴項,所以在生產環境中用不到的依賴項一律塞至devDependencies。
然后再檢查引用庫的按需加載,首先想到項目中使用了antd框架。

官方文檔寫到:antd 默認支持基於 ES modules 的 tree shaking,對於 js 部分,直接引入 import { Button } from 'antd' 就會有按需加載的效果。

以防萬一,檢查一下,使用webpack-bundle-analyzer可視化插件看一下依賴體積圖示,結果如下。
image.png
並沒有找到antd,左側抽屜中搜了一下,確定是按需加載。
image.png

雙package.json

官方重構了生產依賴項,提出雙package.json結構(two package.json)。顧名思義,通過兩個package.json管理依賴項。一個用來管理開發依賴項,一個管理應用程序依賴項,最終打包時只打包應用程序依賴項。

  • 開發依賴

    此package.json在項目根目錄下,文件中聲明開發依賴和打包腳本;

  • 應用程序依賴;

    在app文件夾下,聲明應用程序依賴,打包時僅打包此文件中聲明的依賴。所有的元字段應當在此文件聲明(version,name等)。

版本

electron版本也會對打包體積有影響,這里用electron^8和10.1.5小試一下,下圖左為8版本,右為10版本。或許系統版本對打包體積也有影響,這里不做嘗試了,有條件同學的可以試一下。
image.png   image.png


對 Electron 感興趣?請關注我們的開源項目 Electron Playground,帶你極速上手 Electron。

我們每周五會精選一些有意思的文章和消息和大家分享,來掘金關注我們的 曉前端周刊


我們是好未來 · 曉黑板前端技術團隊。
我們會經常與大家分享最新最酷的行業技術知識。
歡迎來 知乎掘金SegmentfaultCSDN簡書開源中國博客園 關注我們。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM