用react和Electron构建自己的第一个桌面应用

用Electron开发桌面应用,比你想象的还简单。下面手把手来搭建一个基于React和Electron的桌面应用架子或者称之为DEMO, 完整代码

开发环境

基本环境node和npm

步骤 1. 安装Electron

npm i -D electron@latest
版本信息.png

步骤 2. 克隆示例项目的仓库,快速启动自己的第一个桌面应用

# 克隆示例项目的仓库
$ git clone https://github.com/electron/electron-quick-start

# 进入这个仓库
$ cd electron-quick-start

# 安装依赖并运行
$ npm install && npm start

到这一步,已经成功跑起一个Electron项目了

步骤 3. 安装webpack用来打包前端文件

npm i --save-dev webpack webpack-cli webpack-dev-server html-webpack-plugin

在开发模式下,我们需要使用webpack-dev-server,使用html-webpack-plugin进行build文件自动注入index.html中

步骤 4. 配置webpack,在根目录下创建webpack.config.js

const webpack = require('webpack');
const htmlWebpackPlugin = require('html-webpack-plugin');
const path = require('path');

module.exports = {
  entry: [
    './app/index.jsx'
  ],
  output: {
    path: path.resolve(__dirname, 'uiDist'),
    filename: 'bundle.js'
  },
  module: {
    rules: [
      {
        test: /\.jsx?$/,
        loaders: ['babel-loader'],
        exclude: /(node_modules)/
      }
    ]
  },
  plugins: [
    new htmlWebpackPlugin({
      title: 'Electron DEMO',
      template: './index.html'
    })
  ]
}

上面使用了babel将es6转换为es5支持,所以下面我们要按照babel和react相关的依赖,我们把所有前端文件放在app文件下(自己创建的一个文件夹),把最终打包的代码放在uiDist文件夹中

步骤 5. 安装react 和 react-dom 和babel依赖

npm i --save react-dom react
npm i --save-dev @babel/core @babel/preset-env @babel/preset-react babel-loader

这里还需要在webpack.config.js所在文件夹下,创建.babelrc

{
  "presets": ["@babel/env", "@babel/react"]
}

在app文件下添加index.jsx

import React from 'react';
import ReactDOM from 'react-dom';

class App extends React.Component {
  render() {
    return (
      <div>
        Hello world
      </div>
    )
  }
}

ReactDOM.render(<App/>, document.getElementById('root'));

修改根目录下的index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <title><%= htmlWebpackPlugin.options.title %></title>
  </head>
  <body>
    <div id="root"></div>
  </body>
</html>

现在执行webpack -p --config ./webpack.config.js就可以对前端文件进行打包,运行webpack-dev-server --devtool eval --progress --colors --content-base build 就可以启动一个可以访问的server。下面我们把运行webpack的命令写入package.json的scripts来调用:

  "scripts": {
    "start": "electron .", 
    "build": "webpack -p --config ./webpack.config.js",
    "devWeb": "webpack-dev-server --devtool eval --progress --colors --content-base build"
  },

现在我们就可以直接运行npm run devWeb来跑起一个web server用来开发调试,运行npm run build来打包前端文件。

在这一步,我们发现运行npm run start 打开electron, 并没有得到我们预想的结果。那是因为我们需要对electron的main.js 的mainWindow.loadFile加载的文件做一个修改。

步骤 6. 修改根目录下的main.js文件下的mainWindow.loadFile路径

// Modules to control application life and create native browser window
const {app, BrowserWindow} = require('electron')
const path = require('path')
// 根据NODE_ENV来判断是否为开发模式
const isDev = process.env.NODE_ENV === 'dev';
// Keep a global reference of the window object, if you don't, the window will
// be closed automatically when the JavaScript object is garbage collected.
let mainWindow

function createWindow () {
  // Create the browser window.
  mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      javascript: true,
      plugins: true,
      nodeIntegration: false,
      webSecurity: false,
      preload: path.join(__dirname, 'renderer.js')   // 自动注入render.js Electron的API使用文件
    }
  })

  // and load the index.html of the app.
  if (isDev) {
    // 开发模式访问开发地址
    mainWindow.loadURL('http://localhost:8080')
  } else {
    // 生产模式访问打包后的文件
    mainWindow.loadFile('./uiDist/index.html')
  }

  // Open the DevTools.
  // 开发模式才开启调试工具
  isDev && mainWindow.webContents.openDevTools()

  // Emitted when the window is closed.
  mainWindow.on('closed', function () {
    // Dereference the window object, usually you would store windows
    // in an array if your app supports multi windows, this is the time
    // when you should delete the corresponding element.
    mainWindow = null
  })
}

// This method will be called when Electron has finished
// initialization and is ready to create browser windows.
// Some APIs can only be used after this event occurs.
app.on('ready', createWindow)

// Quit when all windows are closed.
app.on('window-all-closed', function () {
  // On macOS it is common for applications and their menu bar
  // to stay active until the user quits explicitly with Cmd + Q
  if (process.platform !== 'darwin') app.quit()
})

app.on('activate', function () {
  // On macOS it's common to re-create a window in the app when the
  // dock icon is clicked and there are no other windows open.
  if (mainWindow === null) createWindow()
})

// In this file you can include the rest of your app's specific main process
// code. You can also put them in separate files and require them here.

现在我们再给package.json的sciprts中,添加一个启动开发模式的electron命令:

"devElectron": "NODE_ENV=dev electron .",

现在开发模式我们只要npm run devElectronnpm run devWeb进行愉快的开发了。

最后一步,打包成桌面运用

这里以打包mac的app为例子

electron打包我们使用electron-builder, 首先安装

npm i --save-dev electron-builder

然后再package.json添加build字段配置, 同时再scripts中添加打包命令

  "scripts": {
    "start": "electron .",
    "devElectron": "NODE_ENV=dev electron .",
    "build": "webpack -p --config ./webpack.config.js",
    "devWeb": "webpack-dev-server --devtool eval --progress --colors --content-base build",
    "build_app": "electron-builder --mac --x64"
  },
  "build": {
    "productName": "我的桌面应用",
    "appId": "com.xxx.app",
    "mac": {
      "target": [
        "dmg",
        "zip"
      ]
    }
  }

现在我们执行npm run build_app命令,就生成了我们的第一个桌面应用。

image.png

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

推荐阅读更多精彩内容