vue-cli3 + electron 打包报错:Error: Application entry file "background.ts" in the "**\dist_electron\w...

vue-cli3 + electron 打包报错:Error: Application entry file "background.ts" in the "**\dist_electron\win-unpacked\resources\app.asar" does not exist. Seems like a wrong configuration.

首先,项目使用vue-cli3 + electron + typescript 。运行没问题,打包报错如上。这是我们对package.json里面的main理解有误造成的,安装好electron后,默认的main入口是background.js。本人踩坑的时候,吧main改成了background.ts,导致该错误。

刚开始也百度查了一下,踩过坑的同志说要把main改成background.js,还有去掉vue.config.js里面的include文件什么的。可是我误解了别人的意思,我把main改成background.js的同时,也把项目的backgound.ts文件改成了background.js,而且我的vue.config.js并没有任何和electron相关的配置。结果不想而知,并没有用,继续报错。

然后就自己继续踩坑。

1.查看插件源码

根据报错文件路径dist_electron\win-unpacked\resources\app.asar,找到报错文件里面有background.ts的地方,发现仅一处


b502c8cf755f33fd448ae1eb0e16a67.png

经之前的查阅,也意识到这是配置不对造成的,本想从vue.config.js的打包配置着手,但却没能找到相关配置文档(有好心大神有可以提供下嘛)。根据报错,就是找不到background.ts,于是想查看打包过程中哪个打包文件找不到。翻看package.json,找到和electron打包的包vue-cli-plugin-electron-builder,点开包


ba15524baf624e0d12f8c914f30edb5.png

挨个从下往上搜索background.js,在index.js里面找到和background.js相关的代码


58844bfda403859cd5f1e0af9711bd1.png

e47e4cc2ba0caac321f6d3b80e0f08f.png

d340f646b2134b3c623b8b90106c38d.png

查看这几段代码

  const usesTypescript = pluginOptions.disableMainProcessTypescript
    ? false
    : api.hasPlugin('typescript')
  const mainProcessFile =
    pluginOptions.mainProcessFile ||
    (usesTypescript ? 'src/background.ts' : 'src/background.js')

是判断有没有ts,代码的逻辑是,如果 pluginOptions.disableMainProcessTypescript是true,那就不用ts,否则判断项目是否有ts插件(api.hasPlugin(‘typescript’)),因此推想vue-cli-plugin-electron-builder在打包时,是自动判断是否使用了ts的,这段代码运行结果usesTypescript 必定为true,为验证想法,在const usesTypescript = pluginOptions.disableMainProcessTypescript ? false : api.hasPlugin('typescript') 下面添加打印console.log("usesTypescript ",usesTypescript ),重新执行打包,不出所料,是true.
然后根据这段代码

const mainProcessFile =
    pluginOptions.mainProcessFile ||
    (usesTypescript ? 'src/background.ts' : 'src/background.js')

也就是使用ts的时候,如果没有配置自定义的mainProcessFile ,代码会去src下寻找background.ts文件
到这里,也就确定了,我的项目里面并没有配置自定义文件,因此必然回去寻找background.ts,所以项目里面的只能是background.ts,不可以改成background.js
其他几段代码,都有outputDir,bundled,读取的是打包后的文件路径。
找到输入文件夹里面的bundled文件夹,发现里面果然有background.js。从这里确定了,打包时,除了第一次取项目里面需要用background.ts外,其他都使用background.js,因为代码里面是写死的,除了自定义的名字 以外,并没有去选择ts文件的代码。而且,打包后,肯定不能存在ts代码。


c2a8da77554faed78fa5a6a5d85ac65.png

2.确定环境

为了确定当下环境打包是否有问题,新创建项目electron-test,并执行打包,发现没问题。然后将main改为background2.js,打包
报错:src\background.js in multi ./src/background.js,但是app.asar文件的files变成了background2.js


6d2199a566406d44d049958e26b5ae9.png

这段报错就是在打包的代码里面,找不到background.js,因为项目里面被改成了backgroun2.js,于是更改打包源码,将background.js全都改错background2.js,再执行打包,成功。查看打包后bundle里面的文件,之前的backgroun.js变成了backgroun2.js,从这里推想app.asar里面的files包含的肯定是bundle里面的background.js文件,也是package.json里面的main指定的文件。于是将项目中main入口改成background.js,但是项目的文件还是backgrond.ts。
重新执行打包。。。。。
不出所料,报错了 :(
但是报错已经不一样了,说明这个已经解决了。新报错如下:

node_modules\app-builder-lib\templates\nsis\include\StdUtils.nsh

3.中文路径node_modules\app-builder-lib\templates\nsis\include\StdUtils.nsh

继续百度,查到是因为项目路径有中文。本人项目确实有中文,但是在外面两层,项目本身是英文的。为了验证外面中文路径的影响,直接在项目同级目录新建项目electron-test2,安装好,执行打包,发现报错一样。那就确实是中文路径的原因了。于是将项目的两层中文路径都改成拼音,再重新执行打包,成功 :)

吐槽:可恶老外,对咱博大精深的中文还是有歧视哈!!!

4.应用白屏

打包终于成功了,可是打开应用程序一看,咳咳,白屏,什么都没有(ps:开发环境是正常的)。然后打开之前测试的打包程序,没问题,能正常显示。
联想刚才的打包文件,有html文件,和vue路由模式一起思考,vue history模式打包后,本地是点不开的,如果打包后的程序引用了本地文件,会不会有这个一样的问题?于是将路由模式改错Hash,再重新打包。果然,这次没有白屏了。

但是这个似乎不是一个好的解决方案。因为刚创建的测试的程序,也是history模式,他可以,为啥我的不行?我发誓没有更改过入口html的配置。

经测试,发现如果使用history模式,测试程序和我自己的项目效果其实是一样的。这里出现不同是因为我的项目在app.vue没有内容,只有有个router-view,如果在app.vue写点内容,也可以显示,并且通过点击是可以跳转的。就是初始时直接定位到其他页面不行。

然后查看 electron-vue 的官方文档,看到下面说明:


6dd67bb38f5a6e154eef4f6e826acc9.png

既然官方都这样说了,也不想再去折腾。

改为hash即可。

你可能感兴趣的:(vue-cli3 + electron 打包报错:Error: Application entry file "background.ts" in the "**\dist_electron\w...)