上一节
我们介绍了
生产环境
的打包流程,这一节我们来看
开发环境
的启动流程。
该框架主要修改是对开发环境的优化,包括了于开发环境的配置文件隔离,主进程和渲染进程配置文件隔离,编译过程提示等功能,因此这一节内容才是整个框架的核心。
我们从开发人员用到的启动命令说起。
从package中我们看到启动命令就是:
"dev": "node .electron-vue/dev-runner.js",
也就是在终端使用
npm run dev
就可以了,而这个命令对应的脚本就是dev-runner.js。
function init() {
greeting();
Promise.all([startRenderer(), startMain()])
.then(() => {
startElectron();
.catch(err => {
console.error(err);
这是脚本运行时执行的唯一方法,其中的greeting()就是在终端输出一个Log,如图所示:
然后做了三个操作分别启动了渲染进程、主进程和Electron:
- startRenderer()
- startMain()
- startElectron()
下面我们逐个来看具体的启动流程。
1.渲染进程启动过程分析
function startRenderer() {
return new Promise((resolve, reject) => {
rendererConfig.entry.renderer = [path.join(__dirname, 'dev-client')].concat(rendererConfig.entry.renderer);
const compiler = webpack(rendererConfig);
hotMiddleware = webpackHotMiddleware(compiler, {
log: false,
heartbeat: 2500
compiler.plugin('compilation', compilation => {
compilation.plugin('html-webpack-plugin-after-emit', (data, cb) => {
hotMiddleware.publish({action: 'reload'});
cb();
compiler.plugin('done', stats => {
logStats('Renderer', stats);
const server = new WebpackDevServer(
compiler,
contentBase: path.join(__dirname, '../'),
quiet: true,
before(app, ctx) {
app.use(hotMiddleware);
ctx.middleware.waitUntilValid(() => {
resolve();
server.listen(9080);
在这个方法里,共完成了三个操作:
- 创建webpack对象
- 利用webpack对象来创建W**ebpackDevServer对象
- 监听webpack编译过程
我们分别来看这三个操作的具体情况。
1.1.渲染进程创建webpack对象
webpack对象创建时使用的配置文件是我们分析的重点。我们来看webpack的配置文件,也就是rendererConfig变量:
rendererConfig.entry.renderer = [path.join(__dirname, 'dev-client')].concat(rendererConfig.entry.renderer);
这说明webpack的配置文件来自于两个文件:dev-client模块和rendererConfig.entry.renderer变量。
这里看一下源码就知道,concat方法连接而成的数组中包含了两个元素,一个是”dev-client”,另一个是根目录的”../src/renderer/main.js”文件,也就是说,webpack的entry参数实际上是这种形式:
entry: {
renderer: ['dev-client', path.join(__dirname, '../src/renderer/main.js')]
再来看一下output参数内容(在webpack.renderer.config.js):
output: {
filename: '[name].js',
libraryTarget: 'commonjs2',
path: path.join(__dirname, '../dist/electron')
这种用法包含了三个信息:
- webpack将会把dev-client 模块 和main.js 文件同时打包进output指定的文件中
- dev-client是一个模块,根据源码查找,这个模块就是dev-client.js文件
- entry内容以key–value形式定义,那么output中的name变量就是entry中的key
综合来说,这种用法的作用就是:同时把dev-client.js和main.js文件打包,输出到根目录下的/dist/electron/render.js文件中。
这个信息非常重要,后面要用到。
接下来我们先来解决这两个文件的作用。
渲染进程的dev-client配置文件
这个文件内容很简单,直接贴出源码:
const hotClient = require('webpack-hot-middleware/client?noInfo=true&reload=true');
hotClient.subscribe(event => {
if (event.action === 'compiling') {
<div id="dev-client">
Compiling Main Process...
我们直接来说作用,他负责在编译过程中,在界面上显示“Compiling Main Process…”的提示语。
效果如下:
至于他如何检测编译过程,我们稍后来说。
渲染进程的webpack.renderer.config配置文件
接下来我们来看渲染进程的主配置文件的主要内容:
let whiteListedModules = ['vue'];
let rendererConfig = {
devtool: '#cheap-module-eval-source-map',
entry: {
renderer: path.join(__dirname, '../src/renderer/main.js')
externals: [
...Object.keys(dependencies || {}).filter(d => !whiteListedModules.includes(d))
module: {
rules: [
test: /\.css$/,
use: ExtractTextPlugin.extract({
fallback: 'style-loader',
use: 'css-loader'
test: /\.html$/,
use: 'vue-html-loader'
test: /\.js$/,
use: 'babel-loader',
exclude: /node_modules/
test: /\.node$/,
use: 'node-loader'
test: /\.vue$/,
use: {
loader: 'vue-loader',
options: {
extractCSS: process.env.NODE_ENV === 'production',
loaders: {
sass: 'vue-style-loader!css-loader!sass-loader?indentedSyntax=1',
scss: 'vue-style-loader!css-loader!sass-loader'
test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
use: {
loader: 'url-loader',
query: {
limit: 10000,
name: 'imgs/[name]--[folder].[ext]'
test: /\.(mp4|webm|ogg|mp3|wav|flac|aac)(\?.*)?$/,
loader: 'url-loader',
options: {
limit: 10000,
name: 'media/[name]--[folder].[ext]'
test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
use: {
loader: 'url-loader',
query: {
limit: 10000,
name: 'fonts/[name]--[folder].[ext]'
node: {
__dirname: process.env.NODE_ENV !== 'production',
__filename: process.env.NODE_ENV !== 'production'
plugins: [
new ExtractTextPlugin('styles.css'),
new HtmlWebpackPlugin({
filename: 'index.html',
template: path.resolve(__dirname, '../src/index.ejs'),
minify: {
collapseWhitespace: true,
removeAttributeQuotes: true,
removeComments: true
nodeModules: process.env.NODE_ENV !== 'production'
? path.resolve(__dirname, '../node_modules')
: false
new webpack.HotModuleReplacementPlugin(),
new webpack.NoEmitOnErrorsPlugin()
output: {
filename: '[name].js',
libraryTarget: 'commonjs2',
path: path.join(__dirname, '../dist/electron')
resolve: {
alias: {
'@': path.join(__dirname, '../src/renderer'),
'vue$': 'vue/dist/vue.esm.js'
extensions: ['.js', '.vue', '.json', '.css', '.node']
target: 'electron-renderer'
这个配置文件的主要配置项都给出了注释,作用很容易理解,这里不再详细介绍,webpack更多配置可以查看这里。
1.2.渲染进程利用webpack对象来创建WebpackDevServer对象
我们先来区分一下三个概念:
webpack
webpack本身只是打包工具,不具备热更新功能
webpack-hot-middleware
An express-style development middleware for use with webpack bundles and allows for serving of the files emitted from webpack. This should be used for development only.
The middleware installs itself as a webpack plugin, and listens for compiler events.
他是一个运行于内存中的(非常重要的概念,作用稍后会提到)一个文件系统,可以检测文件改动自动编译(到内存中)。
webpack-dev-server
Use webpack with a development server that provides live reloading. This should be used for development only. It uses webpack-dev-middleware under the hood, which provides fast in-memory access to the webpack assets.
他是利用webpack-hot-middleware搭建了Express的服务器,从而实现实时刷新的功能。
了解了这三个概念之后,我们来看具体如何创建WebpackDevServer对象,其实很简单,把我们刚才创建的webpack作为参数来初始化WebpackDevServer即可:
hotMiddleware = webpackHotMiddleware(compiler, {
log: false,
heartbeat: 2500
const server = new WebpackDevServer(
compiler,
contentBase: path.join(__dirname, '../'),
quiet: true,
before(app, ctx) {
app.use(hotMiddleware);
ctx.middleware.waitUntilValid(() => {
resolve();
server.listen(9080);
这个创建过程很清晰,需要注意的是,webpackHotMiddleware的heartbeat的参数作用并不是检测文件的频率,而是保持服务器链接存活的心跳频率:
heartbeat - How often to send heartbeat updates to the client to keep the connection alive. Should be less than the client’s timeout setting - usually set to half its value.
1.3.渲染进程监听webpack编译过程
经过以上的步骤,渲染进程的初始化就基本上结束了,但是我们看到在创建过程中有两个“小插曲”:
compiler.plugin('compilation', compilation => {
compilation.plugin('html-webpack-plugin-after-emit', (data, cb) => {
hotMiddleware.publish({action: 'reload'});
cb();
compiler.plugin('done', stats => {
logStats('Renderer', stats);
其中第二个logStats作用就是在终端屏幕上输出编译过程(后面我们在看main进程编译过程也会输出到终端中),如图所示:
而第一个hotMiddleware.publish()作用是什么呢?
这其实是一个钩子函数,检测webpack的编译状态,把其中的html-webpack-plugin-after-emit
状态,发布到webpackHotMiddleware中。
我们可以检测多种状态,比如
- html-webpack-plugin-before-html-processing
- html-webpack-plugin-after-html-processing
- html-webpack-plugin-after-emit
- …
然后我们就可以在渲染进程中检测到这一状态。
然后还记得之前的dev-client模块吗?我们再来看一下源码:
const hotClient = require('webpack-hot-middleware/client?noInfo=true&reload=true');
hotClient.subscribe(event => {
if (event.action === 'compiling') {
<div id="dev-client">
Compiling Main Process...
也就是说,在整个webpack-hot-middleware编译过程中发送的编译消息,将会在界面展示一个提示框提示开发者,编译器正在进行的工作。
从这一点来看也发现,该框架的作者对细节的把握多么的重视。
2.主进程过程分析
前面分析了渲染进程的启动过程,现在来看主进程的启动过程。
function startMain() {
return new Promise((resolve, reject) => {
mainConfig.entry.main = [path.join(__dirname, '../src/main/index.dev.js')].concat(mainConfig.entry.main);
const compiler = webpack(mainConfig);
compiler.plugin('watch-run', (compilation, done) => {
hotMiddleware.publish({action: 'compiling'});
done();
compiler.watch({}, (err, stats) => {
if (err) {
return;
if (electronProcess && electronProcess.kill) {
manualRestart = true;
process.kill(electronProcess.pid);
electronProcess = null;
startElectron();
setTimeout(() => {
manualRestart = false;
}, 5000);
resolve();
主进程的启动和渲染进程非常相似,共经历了三个步骤:
- 创建webpack
- 实时发布hotMiddleware状态(用于页面展示编译过程)
- 主进程的代码”热更新”
下面我们也来分别介绍这三个过程。
2.1.主进程的webpack创建过程
webpack创建的关键在于配置文件,和渲染进程一样,主进程也有两个配置文件:
- /src/main/index.dev.js
- /.electron-vue/webpack.main.config.js
下面分别介绍他们内容。
主进程的index.dev.js配置文件
我们直接来看这个文件内容。
process.env.NODE_ENV = 'development'
require('electron-debug')({ showDevTools: true })
require('electron').app.on('ready', () => {
let installExtension = require('electron-devtools-installer')
installExtension.default(installExtension.VUEJS_DEVTOOLS)
.then(() => {})
.catch(err => {
console.log('Unable to install `vue-devtools`: \n', err)
这个配置文件的作用就是安装了electron-debug
和vue-devtools
两个工具,其中vue-devtools
工具因为网络原因无法安装,可以自己手动安装。
主进程的webpack.main.config.js配置文件
这个文件主要配置项如下:
let mainConfig = {
entry: {
main: path.join(__dirname, '../src/main/index.js')
externals: [
...Object.keys(dependencies || {})
module: {
rules: [
test: /\.js$/,
use: 'babel-loader',
exclude: /node_modules/
test: /\.node$/,
use: 'node-loader'
node: {
__dirname: process.env.NODE_ENV !== 'production',
__filename: process.env.NODE_ENV !== 'production'
output: {
filename: '[name].js',
libraryTarget: 'commonjs2',
path: path.join(__dirname, '../dist/electron')
plugins: [
new webpack.NoEmitOnErrorsPlugin()
resolve: {
extensions: ['.js', '.json', '.node']
target: 'electron-main'
他和渲染进程最大不同就是主进程处理的文件很有限,他不会(不需要)处理vue、图片、css、html等文件类型。
2.2.主进程的编译过程跟踪
这里和渲染进程的跟踪稍有不同,我们对比一下:
渲染进程
compiler.plugin('compilation', compilation => {
compilation.plugin('html-webpack-plugin-after-emit', (data, cb) => {
hotMiddleware.publish({action: 'reload'});
cb();
compiler.plugin('watch-run', (compilation, done) => {
logStats('Main', chalk.white.bold('compiling...'));
hotMiddleware.publish({action: 'compiling'});
done();
从这里发现,他们分别监听了编译的不同事件。渲染进程监听的是compilation
,而主进程监听的是watch-run
。
这里的”watch-run”只会出现在webpack3.X版本中,在webpack4.x版本上,”watch-run”事件被修改为了”watchRun”事件。
webpack还支持的一些事件包括:
- afterPlugins
- afterResolvers
- environment
- afterEnvironment
- beforeRun
- run
- beforeCompile
- afterCompile
- …
从webpack说明文档看出,”compilation”会在编译器创建时触发:
Runs a plugin after a compilation has been created
“watchRun”也是会在编译器创建之后被触发,不同的是,这个这个事件只有在”watch mode”模式下才会生效:
Executes a plugin during watch mode after a new compilation is triggered but before the compilation is actually started.
由于渲染进程使用了WebpackDevServer
的热更新,因此可以检测compilation
事件来跟踪事件。
主进程在初始化过程中,由于没有使用WebpackDevServer
,而是开启了watch
模式,所以可以检测到这个事件。
2.3.主进程的代码”热更新”
主进程没有使用WebpackDevServer的方式自动更新界面,而是通过webpack的watch模式,不断重启Electron实现的:
compiler.watch({}, (err, stats) => {
if (err) {
return;
if (electronProcess && electronProcess.kill) {
manualRestart = true;
process.kill(electronProcess.pid);
electronProcess = null;
startElectron();
setTimeout(() => {
manualRestart = false;
}, 5000);
resolve();
3.Electron过程分析
前面两节分析了主进程和渲染进程的创建流程,在调试模式命令的最后一步就是开启Electron:
function init() {
Promise.all([startRenderer(), startMain()])
.then(() => {
startElectron();
.catch(err => {
下面我们来看如何开启Electron:
function startElectron() {
electronProcess = spawn(electron, ['--inspect=5858', '.']);
原来是通过node的spawn方法运行了electron,并传递了两个参数。
两个参数分别代表打开5858的调试端口和electron的运行目录(也就是当前目录)。
至此,调试环境运行时的流程就介绍完了,我们用一张流程图来归纳一下这个过程:
下一节我们介绍原始界面的渲染过程。
这一节我们来看开发环境的启动流程。该框架主要修改是对开发环境的优化,包括了于开发环境的配置文件隔离,主进程和渲染进程配置文件隔离,编译过程提示等功能,因此这一节内容才是整个框架的核心。 我们从开发人员用到的启动命令说起。 从package中我们看到启动命令就是:&amp;quot;dev&amp;quot;: &amp;quot;node .electron-vue/dev-runner.js&amp;quot;,也就是在终端使用npm run dev...
创建后使用为工程添加插件
然后项目基础搭建完成进程: electron 程序运行由两个进程来控制主进程(main)和渲染进程(render)Preload 脚本
官方解释:预加载(preload)脚本包含了那些执行于渲染器进程中,且先于网页内容开始加载的代码 。 这些脚本虽运行于渲染器的环境中,却因能访问 Node.js API 而拥有了更多的权限。预加载脚本可以在 BrowserWindow 构造方法中的 webPreferences 选项里被附加到主进程。
我的理解:由于 electron 的主进程可以
│ └─ build.js
打包时调用,在package.json中的script里的build命令
“build”: “node .electron-vue/build.js && electron-builder”,
│ └─ dev-client.js
│ └─ dev-runne...
本系列文章将介绍electron-vue前端框架的作用、结构、使用方法。
electron-vue是SimulatedGREG基于vue-cli搭建的Vue+Webpack+Electron脚手架,可以用来开发跨PC平台的应用,源码地址在这里。
其主要功能/特色包括:
主进程和渲染进程配置文件分离
代码热更新
详细的Log输出
除了必备的Electron、Vue、We...
通过上面几篇文章我们已经基本了解了如何利用Electron-Vue来构建Vue项目,但是项目是这么运行的,初始项目代码之间有什么关系,我们还不太清楚,所以这篇我们将主要解决如下三个问题
1: npm run dev背后做了什么,上图的界面是如何产生的
2: npm install到底根据什么策略去下载对应的依赖
3: 如何打包成跨平台的文件,比如打包成windows平台的exe文件...
nodejs-devrunner
开发工具。 沿途提供静态文件并执行 .JS 文件,可以配置为在本地上下文或沙箱中运行它们,或多或少有限制。 由于执行文件的方式不安全,因此不适用于任何类型的生产用途,而是用于加速脚本开发的工具。
git clone git@github.com:quentar/nodejs-devrunner.git
cd cd nodejs-devrunner && npm install
运行应用程序
运行该应用程序非常简单:
node app
请务必更改端口号,默认为 8888 。
访问提供的文件
- 提供原始文件
- 评估文件
cnpm install electron --save-dev
cnpm install electron-packager --save-dev //这个是打成exe文件的插件,之后要用,提前下载好
2. vue项目中package.ison文件中“scripts”添加
"electron_dev": "np...
electron-vue 是一个使用 Vue.js 开发跨平台桌面应用的框架,可以使用 electron-builder 工具将其打包成 exe 文件。
以下是将 electron-vue 项目打包成 exe 的基本步骤:
1. 安装 electron-builder
在 electron-vue 项目的根目录下执行以下命令:
npm install electron-builder --save-dev
2. 配置打包参数
在项目根目录下创建一个 electron-builder.json 文件,用于配置打包参数。可以参考 electron-builder 的文档进行配置,主要包括应用程序名称、版本号、图标等。
3. 执行打包命令
在项目根目录下执行以下命令进行打包:
npm run build:win
该命令会生成一个 dist 目录,其中包含打包后的应用程序和安装程序,可以在 Windows 上运行。
以上就是将 electron-vue 项目打包成 exe 的基本步骤,希望对你有帮助。
### 回答2:
electron-vue 是基于 Vue.js 和 Electron 的开发框架,可以快速构建桌面应用程序。在开发完成后,开发者需要将其打包成 .exe 格式(Windows 可执行文件),以便部署和发布。
以下是将 electron-vue 项目打包成 .exe 文件的步骤:
1. 准备工作
首先要安装 electron-packager 包,这个包可以让我们快速打包 electron 应用程序。可以在终端中输入以下命令进行安装:
npm install electron-packager --save-dev
2. 修改 package.json 文件
在 package.json 文件中,需要添加以下代码:
"scripts": {
"package": "electron-packager ./ --platform=win32 --arch=x64 --icon=./build/icons/icon.ico --out=./dist --ignore=dist --overwrite"
这个代码段是一个命令,运行它可以将项目打包成指定平台(这里是 win32,也就是 Windows)的可执行文件,以 .exe 格式输出到指定目录(这里是 dist 文件夹)。其中,--icon 表示程序图标,--ignore 是忽略打包的文件夹,--overwrite 表示覆盖已有的输出文件夹。
3. 执行打包命令
在终端中输入以下命令,即可开始打包:
npm run package
然后等待一段时间,打包成功之后会在 dist 目录下生成 .exe 文件。
4. 发布
最后将 .exe 文件上传到合适的平台(例如 GitHub Release),这样用户就可以下载并使用了。
注意事项:
- 在打包时需要注意修改 .ico 图标文件的路径,确保能正确找到。
- 若需要打包成其他平台的可执行文件,可以修改 --platform 和 --arch 参数。
- 打包时,如果报错了,可以在命令行加上 --verbose 参数,查看具体错误信息。
### 回答3:
electron-vue是一个基于vue.js构建的 electron框架的项目,可以让开发者快速地构建跨操作系统的桌面应用程序,并且electron-vue项目也非常容易打包成exe可执行文件,便于在Windows平台上使用。
打包electron-vue项目成exe的方法:
首先要在命令行中进入项目根目录,
然后运行:
npm run build
yarn run build
这两个命令将会编译和打包electron-vue项目,生成一个dist目录。
在默认情况下,打包出的exe应用程序是没有图标的,如果需要添加图标,需要在build目录下找到win下的icon.ico文件,并替换成你自己的图标文件。
接下来,需要使用第三方的打包工具,如electron-builder,打包成exe文件,命令如下:
npm run dist 或 yarn run dist
执行完这个命令后,就会在dist目录下生成一个installer目录,里面包含着生成的exe文件和其他必要的文件。
理论上,exe应用程序已经可以在Windows平台上使用了。
electron-vue项目打包成exe并不是一件复杂的事情。只需进入项目根目录运行 npm run build 命令,然后使用第三方打包工具electron-builder打包,就可以生成一个可执行的exe文件了,这样就极大地方便了开发者在Windows平台上部署应用程序。