electron
入門基礎筆記,這裏記錄一下。- 文章發表於Poetry's Blog
- 項目源碼,供入門Electron學習參考
本文面向新人、沒有接觸過
Electron
的同窗,作了一些基礎的知識梳理,助你快速入門。javascript
NW.js
和 Electron
均可以用前端的知識來開發桌面應用。NW.js
和 Electron
起初是同一 個做者開發。後來種種緣由分爲兩個產品。一個命名爲 NW.js
(英特爾公司提供技術支持)、 另外一命名爲 Electron
(Github 公司提供技術支持)。NW.js
和 Electron
能夠用 Nodejs
中幾乎全部的模塊。NW.js
和 Electron
不只能夠把 html
寫的 web
頁面打包成跨平臺能夠安裝到電腦上面的軟件,也能夠經過 javascript
訪問操做 系統原生的 UI
和 Api
(控制窗口、添加菜單項目、托盤應用菜單、讀寫文件、訪問剪貼板)。
github
的atom
編輯器、微軟的vscode
編輯器,包括阿里內部的一些 軟件也是用electron
開發的css
1. Electron 是由誰開發的?html
Electron
是由Github
開發前端
2. Electron 是什麼?vue
Electron
是一個用HTML
,CSS
和JavaScript
來構建跨平臺桌面應用程序的一個開源庫java
3. Electron 把 HTML,CSS 和 JavaScript 組合的程序構建爲跨平臺桌面應用程序的原理 是什麼?node
原理爲
Electron
經過將Chromium
和Node.js
合併到同一個運行時環境中,並將其打包爲Mac
,Windows
和Linux
系統下的應用來實現這一目的。webpack
4. Electron 什麼時候出現的,爲何會出現?ios
Electron
於2013
年做爲構建Atom
的框架而被開發出來。這兩個項目在2014
春季開源。 (Atom:爲 Github 上可編程的文本編輯器)git
一些歷史:
2013
年 4
月 Atom Shell
項目啓動 。2014
年 5
月 Atom Shell
被開源 。2015
年 4
月 Atom Shell
被重命名爲 Electron
2016
年 5
月 Electron
發佈了 v1.0.0
版本5. Electron 當前流行程度?
目前
Electron
已成爲開源開發者、初創企業和老牌公司經常使用的開發工具。
6. Electron 當前由那些人在維護支持?
Electron
當前由Github
上的一支團隊和一羣活躍的貢獻者維護。有些貢獻者是獨立開發者,有些則在用Electron
構建應用的大型公司裏工做。
7. Electron 新版本多久發佈一次?
Electron
的版本發佈至關頻繁。每當Chromium
、Node.js
有重要的bug
修復,新API
或是版本更新時Electron
會發布新版本。
Chromium
發行新的穩定版後的一到兩週以內,Electron
中 Chromium
的版本會對其進行更新,具體時間根據升級所需的工做量而定。 通常 Node.js
發行新的穩定版一個月後,Electron
中 Node.js
的版本會對其進行更新,具 體時間根據升級所需的工做量而定。8. Electron 的核心理念是什麼?
Electron
的核心理念是:保持Electron
的體積小和可持續性開發。 如:爲了保持Electron
的小巧 (文件體積) 和可持續性開發 (以防依賴庫和API
的泛濫) ,Electron
限制了所使用的核心項目的數量。 好比Electron
只用了Chromium
的渲染庫而不是其所有組件。這使得升級Chromium
更加容易,但也意味着Electron
缺乏了Google Chrome
裏的一些瀏覽器相關的特性。 添加到Electron
的新功能應該主要是原生API
。 若是能夠的話,一個功能應該儘量的成 爲一個Node.js
模塊。
9. Electron 當前的最新版本爲多少?
Electron
當前的最新版本爲4.0.1
(當前時間爲2019
年1
月6
號)
1. 安裝 electron
npm install -g electron
複製代碼
2. 克隆一個倉庫、快速啓動一個項目
# 克隆示例項目的倉庫
git clone https://github.com/electron/electron-quick-start
# 進入這個倉庫
cd electron-quick-start
# 安裝依賴並運行
npm install && npm start
複製代碼
3. 手動搭建一個 electron 項目
electrondemo01
electrondemo01
目錄下面新建三個文件: index.html
、main.js
、package.json
index.html
裏面用 css
進行佈局(之前怎麼寫如今仍是怎麼寫)main.js
中寫以下代碼var electron =require('electron'); //electron 對象的引用
const app=electron.app; //BrowserWindow 類的引用
const BrowserWindow=electron.BrowserWindow;
let mainWindow=null; //監聽應用準備完成的事件 app.on('ready',function(){
//監聽應用準備完成的事件
app.on('ready',function(){
//建立窗口
mainWindow=new BrowserWindow({width: 800, height: 600}); mainWindow.loadFile('index.html');
mainWindow.on('closed', function () {
mainWindow = null; })
})
})
//監聽全部窗口關閉的事件
app.on('window-all-closed', function () {
// On OS X 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();
}
})
複製代碼
electron . #注意:命令後面有個點
複製代碼
4. electron-forge 搭建一個 electron 項目
electron-forge
至關於electron
的一個腳手架,可讓咱們更方便的建立、運行、打包electron
項目
npm install -g electron-forge
electron-forge init my-new-app
cd my-new-app
npm start
複製代碼
Electron
運行 package.json
的 main
腳本的進程被稱爲主進程。web
頁面來展現用戶界面。 一個 Electron
應用老是有且只有一個主進程。Electron
使用了 Chromium
(谷歌瀏覽器)來展現 web
頁面,因此 Chromium
的 多進程架構也被使用到。 每一個 Electron
中的 web
頁面運行在它本身的渲染進程中。BrowserWindow
實例建立頁面。每一個 BrowserWindow
實例都在本身的渲 染進程裏運行頁面。 當一個 BrowserWindow
實例被銷燬後,相應的渲染進程也會被終止thread
)。更準確的定義是: 線程是「一個進程內部的控制序列」。在普通的瀏覽器中,
web
頁面一般在一個沙盒環境中運行,不被容許去接觸原生的資源。 然而Electron
的用戶在Node.js
的API
支持下能夠在頁面中和操做系統進行一些底層交 互。Nodejs
在主進程和渲染進程中均可以使用。渲染進程由於安全限制,不能直接操做生GUI
。雖然如此,由於集成了 Nodejs,渲染進程也有了操做系統底層API
的能力,Nodejs
中經常使用的Path
、fs
、Crypto
等模塊在Electron
能夠直接使用,方便咱們處理連接、路徑、 文件MD5
等,同時npm
還有成千上萬的模塊供咱們選擇。
var fs = require('fs');
var content = document.getElementById('content');
var button = document.getElementById('button');
button.addEventListener('click',function(e){
fs.readFile('package.json','utf8',function(err,data){
content.textContent = data;
console.log(data);
});
});
複製代碼
mainWindow.webContents.openDevTools();
複製代碼
Electron
模塊介紹、remote
模塊、通 過BrowserWindow
打開新窗口
remote
模塊提供了一種在渲染進程(網頁)和主進程之間進行進程間通信(IPC
)的簡便途徑
Electron
中, 與GUI
相關的模塊(如dialog
,menu
等)只存在於主進程,而不在渲染進程中 。爲了能從渲染進程中使用它們,須要用ipc
模塊來給主進程發送進程間消息。使用remote
模塊,能夠調用主進程對象的方法,而無需顯式地發送進程間消息,這相似於Java
的RMI
Electron
渲染進程中經過remote
模塊調用主進程中的BrowserWindow
打開新窗口
// 主進程代碼
const electron = require('electron');
// 控制應用生命週期的模塊
const {app} = electron;
// 建立本地瀏覽器窗口的模塊
const {BrowserWindow} = electron;
// 指向窗口對象的一個全局引用,若是沒有這個引用,那麼當該 javascript 對象被垃圾回收 的
// 時候該窗口將會自動關閉
let win;
function createWindow() {
// 建立一個新的瀏覽器窗口
win = new BrowserWindow({width: 1104, height: 620});//570+50
// 而且裝載應用的 index.html 頁面
win.loadURL(`file://${__dirname}/html/index.html`);
// 打開開發工具頁面
win.webContents.openDevTools();
//當窗口關閉時調用的方法
win.on('closed', () => {
// 解除窗口對象的引用,一般而言若是應用支持多個窗口的話,你會在一個數組裏 // 存放窗口對象,在窗口關閉的時候應當刪除相應的元素。
win = null;
});
}
// 當 Electron 完成初始化而且已經建立了瀏覽器窗口,則該方法將會被調用。
// 有些 API 只能在該事件發生後才能被使用
app.on('ready', createWindow);
// 當全部的窗口被關閉後退出應用
app.on('window-all-closed', () => {
// 對於 OS X 系統,應用和相應的菜單欄會一直激活直到用戶經過 Cmd + Q 顯式退出
if (process.platform !== 'darwin') {
app.quit();
}
});
app.on('activate', () => {
// 對於 OS X 系統,當 dock 圖標被點擊後會從新建立一個 app 窗口,而且不會有其餘
// 窗口打開
if (win === null) {
createWindow();
}
});
// 在這個文件後面你能夠直接包含你應用特定的由主進程運行的代碼。
// 也能夠把這些代碼放在另外一個文件中而後在這裏導入
複製代碼
// 渲染進程代碼 /src/render/index.js
// 打開新窗口屬性用法有點相似vscode打開新的窗口
const btn = document.querySelector('#btn');
const path = require('path');
const BrowerWindow = require('electron').remote.BrowserWindow;
btn.onclick = () => {
win = new BrowerWindow({
width: 300,
height: 200,
frame: false, // false隱藏關閉按鈕、菜單選項 true顯示
fullscreen:true, // 全屏展現
transparent: true
})
win.loadURL(path.join('file:',__dirname,'news.html'));
win.on('close',()=>{win = null});
}
複製代碼
Electron
中Menu
模塊能夠用來建立原生菜單,它可用做應用菜單和context
菜單
這個模塊是一個主進程的模塊,而且能夠經過
remote
模塊給渲染進程調用
// main/menu.js
const { Menu } = require('electron')
// 文檔 https://electronjs.org/docs/api/menu-item
// 菜單項目
let menus = [
{
label: '文件',
submenu: [
{
label: '新建文件',
accelerator: 'ctrl+n', // 綁定快捷鍵
click: function () { // 綁定事件
console.log('新建文件')
}
},
{
label: '新建窗口',
click: function () {
console.log('新建窗口')
}
}
]
},
{
label: '編輯',
submenu: [
{
label: '複製',
role: 'copy' // 調用內置角色實現對應功能
},
{
label: '剪切',
role: 'cut' // 調用內置角色實現對應功能
}
]
},
{
label: '視圖',
submenu: [
{
label: '瀏覽'
},
{
label: '搜索'
}
]
}
]
let m = Menu.buildFromTemplate(menus)
Menu.setApplicationMenu(m)
複製代碼
// 在主進程src/index.js中引入
const createWindow = () => {
// 建立菜單
// 引入菜單模塊
require('./main/menu.js')
};
複製代碼
咱們給菜單綁定事件,在命令行控制檯能夠看到
不推薦使用這種方式,建議在主進程中使用
1. remote
經過
remote
調用主進程的方法
// 菜單引入的方式發生變化
const { Menu } = require('electron').remote
// 其餘代碼和上面菜單同樣
// ...
複製代碼
2. 加入index.html
<script src="render/menu.js"></script>
複製代碼
1. 定義菜單
// render/menu.js
// 在渲染進程中經過remote模塊調用主進程中的模塊
const { Menu } = require('electron').remote
const { remote } = require('electron')
// 文檔 https://electronjs.org/docs/api/menu-item
// 菜單項目
let menus = [
{
label: '文件',
submenu: [
{
label: '新建文件',
accelerator: 'ctrl+n', // 綁定快捷鍵
click: function () { // 綁定事件
console.log('新建文件')
}
},
{
label: '新建窗口',
click: function () {
console.log('新建窗口')
}
}
]
},
{
label: '編輯',
submenu: [
{
label: '複製',
role: 'copy' // 調用內置角色實現對應功能
},
{
label: '剪切',
role: 'cut' // 調用內置角色實現對應功能
}
]
},
{
label: '視圖',
submenu: [
{
label: '瀏覽'
},
{
label: '搜索'
}
]
}
]
let m = Menu.buildFromTemplate(menus)
// Menu.setApplicationMenu(m)
// 綁定右鍵菜單
window.addEventListener('contextmenu', (e)=>{
e.preventDefault()
m.popup({
window: remote.getCurrentWindow()
})
}, false)
複製代碼
2. 引入
<!--index.html-->
<script src="render/menu.js"></script>
複製代碼
有時候咱們想在渲染進程中經過一個事件去執行主進程裏面的方法。或者在渲染進程中通知 主進程處理事件,主進程處理完成後廣播一個事件讓渲染進程去處理一些事情。這個時候就 用到了主進程和渲染進程之間的相互通訊
Electron
主進程,和渲染進程的通訊主要用到兩個模塊:ipcMain
和ipcRenderer
ipcMain
:當在主進程中使用時,它處理從渲染器進程(網頁)發送出來的異步和同步信息,固然也有可能從主進程向渲染進程發送消息。ipcRenderer
: 使用它提供的一些方法從渲染進程 (web
頁面) 發送同步或異步的消息到主進程。 也能夠接收主進程回覆的消息間接實現渲染進程執行主進程裏面的方法
1. 引入ipcRender
<!--src/index.html-->
<button id="send">在 渲染進程中執行主進程裏的方法(異步)</button>
<script src="render/ipcRender.js"></script>
複製代碼
2. 引入ipcMain
// 在主進程src/index.js中引入
const createWindow = () => {
// 建立菜單
// 引入菜單模塊
require('./main/ipcMain.js')
};
複製代碼
3. 渲染進程發送消息
// src/render/ipcRender.js
//渲染進程
let send = document.querySelector('#send');
const { ipcRenderer } = require('electron');
send.onclick = function () {
// 傳遞消息給主進程
// 異步
ipcRenderer.send('sendMsg', {name:'poetries', age: 23})
}
複製代碼
2. 主進程接收消息
// src/main/ipcMain.js
//主進程
const { ipcMain } = require('electron')
// 主進程處理渲染進程廣播數據
ipcMain.on('sendMsg', (event, data)=> {
console.log('data\n ', data)
console.log('event\n ', event)
})
複製代碼
渲染進程給主進程發送異步消息,主進程接收到異步消息之後通知渲染進程
1. 引入ipcRender
<!--src/index.html-->
<button id="sendFeedback">在 渲染進程中執行主進程裏的方法,並反饋給主進程(異步)</button>
<script src="render/ipcRender.js"></script>
複製代碼
2. 引入ipcMain
// 在主進程src/index.js中引入
const createWindow = () => {
// 建立菜單
// 引入菜單模塊
require('./main/ipcMain.js')
};
複製代碼
3. 渲染進程發送消息
// src/render/ipcRender.js
//渲染進程
let sendFeedback = document.querySelector('#sendFeedback');
const { ipcRenderer } = require('electron');
// 向主進程發送消息
sendFeedback.onclick = function () {
// 觸發主進程裏面的方法
ipcRenderer.send('sendFeedback', {name:'poetries', age: 23})
}
複製代碼
4. 主進程收到消息處理並廣播反饋通知渲染進程
// src/main/ipcMain.js
//主進程
const { ipcMain } = require('electron')
// 主進程處理渲染進程廣播數據,並反饋給渲染進程
ipcMain.on('sendFeedback', (event, data)=> {
// console.log('data\n ', data)
// console.log('event\n ', event)
// 主進程給渲染進程廣播數據
event.sender.send('sendFeedbackToRender', '來自主進程的反饋')
})
複製代碼
5. 渲染進程處理主進程廣播的數據
// src/render/ipcRender.js
// 向主進程發送消息後,接收主進程廣播的事件
ipcRenderer.on('sendFeedbackToRender', (e, data)=>{
console.log('event\n ', e)
console.log('data\n ', data)
})
複製代碼
1. 引入ipcRender
<!--src/index.html-->
<button id="sendSync">渲染進程和主進程同步通訊</button>
<script src="render/ipcRender.js"></script>
複製代碼
2. 引入ipcMain
// 在主進程src/index.js中引入
const createWindow = () => {
// 建立菜單
// 引入菜單模塊
require('./main/ipcMain.js')
};
複製代碼
3. 渲染進程給主進程同步通訊
// src/render/ipcMain.js
let sendSync = document.querySelector('#sendSync');
// 渲染進程和主進程同步通訊
sendSync.onclick = function () {
// 同步廣播數據
let msg = ipcRenderer.sendSync('sendsync', {name:'poetries', age: 23})
// 同步返回主進程反饋的數據
console.log('msg\n ', msg)
}
複製代碼
4. 主進程接收數據處理
// src/main/ipcMain.js
// 渲染進程和主進程同步通訊 接收同步廣播
ipcMain.on('sendsync', (event, data)=> {
// console.log('data\n ', data)
// console.log('event\n ', event)
// 主進程給渲染進程廣播數據
event.returnValue ='渲染進程和主進程同步通訊 接收同步廣播,來自主進程的反饋.';
})
複製代碼
通常都是在渲染進程中執行廣播操做,去通知主進程完成任務
1. 引入openWindow
<!--src/index.html-->
<button id="sendSync">渲染進程和主進程同步通訊</button>
<script src="render/openWindow.js"></script>
複製代碼
2. 引入ipcMain2
// 在主進程src/index.js中引入
const createWindow = () => {
// 建立菜單
// 引入菜單模塊
require('./main/ipcMain2.js')
};
複製代碼
3. 渲染進程通知主進程打開窗口
// src/render/openWindow.js
/* eslint-disable */
let openWindow = document.querySelector('#openWindow');
var { ipcRenderer } = require('electron');
// 渲染進程和渲染進程直接的通訊========
openWindow.onclick = function () {
// 經過廣播的形式 通知主進程執行操做
ipcRenderer.send('openwindow', {name:'poetries', age: 23})
}
複製代碼
4. 主進程收到通知執行操做
// src/main/ipcMain2.js
/* eslint-disable */
let { ipcMain,BrowserWindow } = require('electron')
const path = require('path')
let win;
// 接收到廣播
ipcMain.on('openwindow', (e, data)=> {
// 調用window打開新窗口
win = new BrowserWindow({
width: 400,
height: 300,
});
win.loadURL(path.join('file:',__dirname, '../news.html'));
win.webContents.openDevTools()
win.on('closed', () => {
win = null;
});
})
複製代碼
也就是兩個窗口直接的通訊
Electron
渲染進程經過localstorage
給另外一個渲染進程傳值
1. 引入openWindow
<!--src/index.html-->
<button id="sendSync">渲染進程和主進程同步通訊</button>
<script src="render/openWindow.js"></script>
複製代碼
2. 引入ipcMain2
// 在主進程src/index.js中引入
const createWindow = () => {
// 建立菜單
// 引入菜單模塊
require('./main/ipcMain2.js')
};
複製代碼
3. 渲染進程通知主進程打開窗口
// src/render/openWindow.js
/* eslint-disable */
let openWindow = document.querySelector('#openWindow');
var { ipcRenderer } = require('electron');
// 渲染進程和渲染進程直接的通訊========
openWindow.onclick = function () {
// 經過廣播的形式 通知主進程執行操做
ipcRenderer.send('openwindow', {name:'poetries', age: 23})
// ======= localstorage傳值 =====
localStorage.setItem('username', 'poetries')
}
複製代碼
4. 新建news頁面
<!--src/news.html-->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title></title>
</head>
<body>
news page
</body>
<script src="render/news.js"></script>
</html>
複製代碼
// src/render/news.js
let username = localStorage.getItem('username')
console.log(username)
複製代碼
5. 主進程收到通知執行操做
// src/main/ipcMain2.js
/* eslint-disable */
let { ipcMain,BrowserWindow } = require('electron')
const path = require('path')
let win;
// 接收到廣播
ipcMain.on('openwindow', (e, data)=> {
// 調用window打開新窗口
win = new BrowserWindow({
width: 400,
height: 300,
});
win.loadURL(path.join('file:',__dirname, '../news.html'));
win.webContents.openDevTools()
win.on('closed', () => {
win = null;
});
})
複製代碼
經過
BrowserWindow
和webContents
模塊實現渲染進程和渲染進程的通訊
webContents
是一個事件發出者.它負責渲染並控制網頁,也是BrowserWindow
對象的屬性
須要瞭解的幾個知識點
id
const winId = BrowserWindow.getFocusedWindow().id;
複製代碼
win.webContents.on('did-finish-load',(event) => {
})
複製代碼
win.webContents.on('did-finish-load',(event) => {
win.webContents.send('msg',winId,'我是 index.html 的數據');
})
複製代碼
id
查找窗口let win = BrowserWindow.fromId(winId);
複製代碼
下面是具體演示
1. 引入openWindow
<!--src/index.html-->
<button id="sendSync">渲染進程和主進程同步通訊</button>
<script src="render/openWindow.js"></script>
複製代碼
2. 引入ipcMain2
// 在主進程src/index.js中引入
const createWindow = () => {
// 建立菜單
// 引入菜單模塊
require('./main/ipcMain2.js')
};
複製代碼
3. 渲染進程通知主進程打開窗口
// src/render/openWindow.js
/* eslint-disable */
let openWindow = document.querySelector('#openWindow');
var { ipcRenderer } = require('electron');
// 渲染進程和渲染進程直接的通訊========
openWindow.onclick = function () {
// 經過廣播的形式 通知主進程執行操做
ipcRenderer.send('openwindow', {name:'poetries', age: 23})
}
複製代碼
4. 主進程收到通知執行操做
// src/main/ipcMain2.js
let { ipcMain,BrowserWindow } = require('electron')
const path = require('path')
let win;
// 接收到廣播
ipcMain.on('openwindow', (e, userInfo)=> {
// 調用window打開新窗口
win = new BrowserWindow({
width: 400,
height: 300,
});
win.loadURL(path.join('file:',__dirname, '../news.html'));
// 新開窗口調試模式
win.webContents.openDevTools()
// 把渲染進程傳遞過來的數據再次傳遞給渲染進程news
// 等待窗口加載完
win.webContents.on('did-finish-load', ()=>[
win.webContents.send('toNews', userInfo)
])
win.on('closed', () => {
win = null;
});
})
複製代碼
5. news接收主進程傳遞的數據
數據通過渲染進程->主進程->
news
渲染進程
<!--news頁面-->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title></title>
</head>
<body>
news page
</body>
<script src="render/news.js"></script>
</html>
複製代碼
// src/render/news.js
var { ipcRenderer } = require('electron');
// let username = localStorage.getItem('username')
// console.log(username)
// 監聽主進程傳遞過來的數據
ipcRenderer.on('toNews',(e, userInfo)=>{
console.log(userInfo)
})
複製代碼
那麼,這裏有一個問題,
news
進程接收到了廣播後如何給出反饋呢?
1. 在主進程中獲取窗口ID傳遞
// src/main/ipcMain2.js
let { ipcMain,BrowserWindow } = require('electron')
const path = require('path')
let win;
// 接收到廣播
ipcMain.on('openwindow', (e, userInfo)=> {
// 獲取當前窗口ID 放在第一行保險 由於後面也打開了新窗口使得獲取的ID有問題
let winId = BrowserWindow.getFocusedWindow().id
// 調用window打開新窗口
win = new BrowserWindow({
width: 400,
height: 300,
});
win.loadURL(path.join('file:',__dirname, '../news.html'));
// 新開窗口調試模式
win.webContents.openDevTools()
// 把渲染進程傳遞過來的數據再次傳遞給渲染進程news
// 等待窗口加載完
win.webContents.on('did-finish-load', ()=>[
win.webContents.send('toNews', userInfo, winId)
])
win.on('closed', () => {
win = null;
});
})
複製代碼
2. 在news進程中廣播數據
// src/render/news.js
var { ipcRenderer } = require('electron');
// 注意這裏 在渲染進程中須要從remote中獲取BrowserWindow
const BrowerWindow = require('electron').remote.BrowserWindow;
// let username = localStorage.getItem('username')
// console.log(username)
// 監聽主進程傳遞過來的數據
ipcRenderer.on('toNews',(e, userInfo, winId)=>{
// windID 第一個窗口ID
// 獲取對應ID的窗口
let firstWin = BrowerWindow.fromId(winId)
firstWin.webContents.send('toIndex', '來自news進程反饋的信息')
console.log(userInfo)
})
複製代碼
3. 在另外一個渲染進程中處理廣播
/* eslint-disable */
let openWindow = document.querySelector('#openWindow');
var { ipcRenderer } = require('electron');
// 渲染進程和渲染進程直接的通訊========
openWindow.onclick = function () {
// 傳遞消息給主進程
ipcRenderer.send('openwindow', {name:'poetries', age: 23})
// 傳遞給打開的窗口 渲染進程和渲染進程直接的通訊
localStorage.setItem('username', 'poetries')
}
// 接收news渲染進程傳遞回來的消息
ipcRenderer.on('toIndex', (e, data)=>{
console.log('===', data)
})
複製代碼
Electron Shell
模塊在用戶默認瀏覽器 中打開URL
以及Electron DOM webview
標籤。Shell
既屬於主進程模塊又是渲染進程模塊
shell
模塊提供了集成其餘桌面客戶端的關聯功能
1. 引入
<!--index.html-->
<button id="shellDom">經過shell打開外部連接</button>
<script src="render/shell.js"></script>
複製代碼
2. shell.js
// src/render/shell.js
const { shell } = require('electron')
let shellDom = document.querySelector('#shellDom');
shellDom.onclick = function (e) {
shell.openExternal('https://github.com/poetries')
}
複製代碼
Electron DOM
<webview>
標籤
Webview
與iframe
有點類似,可是與iframe
不一樣,webview
和你的應用運行的是不一樣的進程。它不擁有渲染進程的權限,而且應用和嵌入內容之間的交互所有都是異步的。由於這能 保證應用的安全性不受嵌入內容的影響。
<!--src/index.html中引入-->
<webview id="webview" src="http://blog.poetries.top" style="position:fixed; width:100%; height:100%">
</webview>
複製代碼
shell
模塊<webview>
結合Menu
模塊使用案例1. 新建src/render/webview.js
/* eslint-disable */
var { ipcRenderer } = require('electron');
let myWebview = document.querySelector('#myWebview')
ipcRenderer.on('openwebview', (e, url)=>{
myWebview.src = url
})
複製代碼
2. 引入src/index.html
<webview id="myWebview" src="http://blog.poetries.top" style="position:fixed; width:100%; height:100%">
</webview>
<script src="render/webview.js"></script>
複製代碼
3. 新建src/main/menu.js
/* eslint-disable */
const { shell, Menu, BrowserWindow } = require('electron');
// 當前窗口渲染網頁
function openWebView(url) {
// 獲取當前窗口Id
let win = BrowserWindow.getFocusedWindow()
// 廣播通知渲染進程打開webview
win.webContents.send('openwebview', url)
}
// 在窗口外打開網頁
function openWeb(url) {
shell.openExternal(url)
}
let template = [
{
label: '幫助',
submenu: [
{
label: '關於咱們',
click: function () {
openWeb('http://blog.poetries.top')
}
},
{
type: 'separator'
},
{
label: '聯繫咱們',
click: function () {
openWeb('https://github.com/poetries')
}
}
]
},
{
label: '加載網頁',
submenu: [
{
label: '博客',
click: function () {
openWebView('http://blog.poetries.top')
}
},
{
type: 'separator' // 分隔符
},
{
label: 'GitHub',
click: function () {
openWebView('https://github.com/poetries')
}
},
{
type: 'separator' // 分隔符
},
{
label: '簡書',
click: function () {
openWebView('https://www.jianshu.com/users/94077fcddfc0/timeline')
}
}
]
},
{
label: '視頻網站',
submenu: [
{
label: '優酷',
click: function () {
openWebView('https://www.youku.com')
}
},
{
type: 'separator' // 分隔符
},
{
label: '愛奇藝',
click: function () {
openWebView('https://www.iqiyi.com/')
}
},
{
type: 'separator' // 分隔符
},
{
label: '騰訊視頻',
click: function () {
openWebView('https://v.qq.com/')
}
}
]
}
]
let m = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(m)
複製代碼
4. 引入menu
// 在主進程src/index.js中引入
const createWindow = () => {
// 建立菜單
// 引入菜單模塊
require('./main/menu.js')
};
複製代碼
dialog
屬於主進程中的模塊
dialog
模塊提供了api
來展現原生的系統對話框,例如打開文件框,alert
框, 因此web
應用能夠給用戶帶來跟系統應用相同的體驗
1. 在src/index.html中引入
<button id="showError">showError</button><br />
<button id="showMsg">showMsg</button><br />
<button id="showOpenDialog">showOpenDialog</button><br />
<button id="saveDialog">saveDialog</button><br />
<script src="render/dialog.js"></script>
複製代碼
2. 新建render/dialog.js
// render/dialog.js
let showError = document.querySelector('#showError');
let showMsg = document.querySelector('#showMsg');
let showOpenDialog = document.querySelector('#showOpenDialog');
let saveDialog = document.querySelector('#saveDialog');
var {remote} = require('electron')
showError.onclick = function () {
remote.dialog.showErrorBox('警告', '操做有誤')
}
showMsg.onclick = function () {
remote.dialog.showMessageBox({
type: 'info',
title: '提示信息',
message: '內容',
buttons: ['肯定', '取消']
},function(index){
console.log(index)
})
}
showOpenDialog.onclick = function () {
remote.dialog.showOpenDialog({
// 打開文件夾
properties: ['openDirectory', 'openFile']
// 打開文件
// properties: ['openFile']
}, function (data) {
console.log(data)
})
}
saveDialog.onclick = function () {
remote.dialog.showSaveDialog({
title: 'Save File',
defaultPath: '/Users/poetry/Downloads/',
// filters 指定一個文件類型數組,用於規定用戶可見或可選的特定類型範圍
filters: [
{ name: 'Images', extensions: ['jpg', 'png', 'gif'] },
{ name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
{ name: 'Custom File Type', extensions: ['as'] },
{ name: 'All Files', extensions: ['*'] }
]
}, function (path) {
// 不是真的保存 ,具體還需nodejs處理
console.log(path)
})
}
複製代碼
showError
remote.dialog.showErrorBox('警告', '操做有誤')
複製代碼
showMessageBox
remote.dialog.showMessageBox({
type: 'info',
title: '提示信息',
message: '內容',
buttons: ['肯定', '取消']
},function(index){
console.log(index)
})
複製代碼
showOpenDialog
remote.dialog.showOpenDialog({
// 打開文件夾
properties: ['openDirectory', 'openFile']
// 打開文件
// properties: ['openFile']
}, function (data) {
console.log(data)
})
複製代碼
showSaveDialog
remote.dialog.showSaveDialog({
title: 'Save File',
defaultPath: '/Users/poetry/Downloads/',
// filters 指定一個文件類型數組,用於規定用戶可見或可選的特定類型範圍
filters: [
{ name: 'Images', extensions: ['jpg', 'png', 'gif'] },
{ name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
{ name: 'Custom File Type', extensions: ['as'] },
{ name: 'All Files', extensions: ['*'] }
]
}, function (path) {
// 不是真的保存 ,具體還需nodejs處理
console.log(path)
})
複製代碼
系統托盤,托盤右鍵菜單、托盤圖標閃爍 點擊右上角關閉按鈕隱藏到托盤(仿殺毒軟件)
1. 引入文件
// src/index.js
const createWindow = () => {
require('./main/tray.js')
};
複製代碼
2. Electron 建立任務欄圖標以及任務欄圖標右鍵菜單
// src/main/tray.js
var {
Menu, Tray, app, BrowserWindow
} = require('electron');
const path = require('path');
var appIcon = new Tray(path.join(__dirname, '../static/lover.png'));
const menu = Menu.buildFromTemplate([
{
label: '設置',
click: function() {} //打開相應頁面
},
{
label: '幫助',
click: function() {}
},
{
label: '關於',
click: function() {}
},
{
label: '退出',
click: function() {
// BrowserWindow.getFocusedWindow().webContents().send('close-main-window');
app.quit();
}
}])
// 鼠標放上去提示信息
appIcon.setToolTip('hello poetries');
appIcon.setContextMenu(menu);
複製代碼
3. 監放任務欄圖標的單擊、雙擊事件
// 實現點擊關閉按鈕,讓應用保存在托盤裏面,雙擊托盤打開
let win = BrowserWindow.getFocusedWindow()
win.on('close', (e)=>{
e.preventDefault()
win.hide()
})
iconTray.on('double-click', (e)=>{
win.show()
})
複製代碼
4. Electron 點擊右上角關閉按鈕隱藏任務欄圖標
const win = BrowserWindow.getFocusedWindow();
win.on('close', (e) =>{
console.log(win.isFocused());
if (!win.isFocused()) {
win = null;
} else {
e.preventDefault();/*阻止應用退出*/
win.hide();/*隱藏當前窗口*/
}
})
複製代碼
5. Electron 實現任務欄閃爍圖標
var appIcon = new Tray(path.join(__dirname, '../static/lover.png'));
timer = setInterval(function() {
count++;
if (count % 2 == 0) {
appIcon.setImage(path.join(__dirname, '../static/empty.ico'))
} else {
appIcon.setImage(path.join(__dirname, '../static/lover.png'))
}
},
500);
複製代碼
1. Electron 實現消息通知
Electron
裏面的消息通知是基於h5
的通知api
實現的
1. 新建notification.js
// h5api實現通知
const path = require('path')
let options = {
title: 'electron 通知API',
body: 'hello poetries',
icon: path.join('../static/img/favicon2.ico') // 通知圖標
}
document.querySelector('#showNotification').onclick = function () {
let myNotification = new window.Notification(options.title, options)
// 消息可點擊
myNotification.onclick = function () {
console.log('click notification')
}
}
複製代碼
2. 引入
<!--src/index.html-->
<button id="showNotification">彈出消息通知</button>
<script src="render/notification.js"></script>
複製代碼
mac
上的消息通知
1. 基本使用
// 監聽網絡變化
// 端開網絡 再次鏈接測試
window.addEventListener('online', function(){
console.log('online')
});
window.addEventListener('offline', function(){
console.log('offline')
});
複製代碼
2. 監聽網絡變化實現消息通知
// 端開網絡 再次鏈接測試
// 監聽網絡變化實現消息通知
window.addEventListener('online', function(){
console.log('online')
});
window.addEventListener('offline', function(){
// 斷開網絡觸發事件
var options = {
title: 'QQ郵箱',
body: '網絡異常,請檢查你的網絡',
icon: path.join('../static/img/favicon2.ico') // 通知圖標
}
var myNotification = new window.Notification(options.title, options)
myNotification.onclick = function () {
console.log('click notification')
}
});
複製代碼
Electron
註冊全局快捷鍵 (globalShortcut
) 以及clipboard
剪 切板事件以及nativeImage
模塊(實現相似播放器點擊機器碼自動複製功 能)
1. 新建src/main/shortCut.js
const {globalShortcut, app} = require('electron')
app.on('ready', ()=>{
// 註冊全局快捷鍵
globalShortcut.register('command+e', ()=>{
console.log(1)
})
// 檢測快捷鍵是否註冊成功 true是註冊成功
let isRegister = globalShortcut.isRegistered('command+e')
console.log(isRegister)
})
// 退出的時候取消全局快捷鍵
app.on('will-quit', ()=>{
globalShortcut.unregister('command+e')
})
複製代碼
2. 引入src/index.js
// 注意在外部引入便可 不用放到app中
require('./main/shortCut.js')
複製代碼
1. html
<!--src/index.html-->
<div>
<h2>雙擊下面信息複製</h2>
<p id='msg'>123456789</p>
<button id="plat">粘貼</button><br />
<input id="text" type="text"/>
</div>.
<div>
<h2>複製圖片到界面</h2>
<button id="copyImg">複製圖片</button><br />
</div>
<script src="render/clipboard.js"></script>
複製代碼
2. 新建src/render/clipboard.js
// clipboard能夠在主進程或渲染進程使用
const { clipboard, nativeImage } = require('electron')
//複製
// 運行ctrl+v可看到複製的內容
// clipboard.writeText('poetries')
// clipboard.readText() //獲取複製的內容 粘貼
// 雙擊複製消息
let msg = document.querySelector('#msg')
let plat = document.querySelector('#plat')
let text = document.querySelector('#text')
msg.ondblclick = function () {
clipboard.writeText(msg.innerHTML)
alert(msg.innerHTML)
}
plat.onclick = function () {
text.value = clipboard.readText()
}
// 複製圖片顯示到界面
let copyImg = document.querySelector('#copyImg')
copyImg.onclick = function () {
// 結合nativeImage模塊
let image = nativeImage.createFromPath('../static/img/lover.png')
// 複製圖片
clipboard.writeImage(image)
// 粘貼圖片
let imgSrc = clipboard.readImage().toDataURL() // base64圖片
// 顯示到頁面上
let imgDom = new Image()
imgDom.src = imgSrc
document.body.appendChild(imgDom)
}
複製代碼
1. electron-vue 的一些資源
Electron-vue
文檔 simulatedgreg.gitbooks.io/electron-vu…
2. electron-vue 環境搭建、建立項目
npm install -g vue-cli
vue init simulatedgreg/electron-vue my-project
cd my-project
yarn # or npm install
yarn run dev # or npm run dev
複製代碼
3. electron-vue 目錄結構分析
1. electron-vue UI 框架 ElementUi 的使用
2. electron-vue 中使用 sass
# 安裝 sass-loader:
npm install --save-dev sass-loader node-sass
複製代碼
<!--vue 文件中修改 style 爲以下代碼:-->
<style lang="scss"> body { /* SCSS */ } </style>
複製代碼
electron-vue 中隱藏頂部菜單隱藏頂部最大化、最小化、關閉按鈕 自定最大化、最小化 、關閉按鈕
1. electron-vue 中隱藏頂部菜單
// src/main/index.js
mainWindow.setMenu(null)
複製代碼
2. electron-vue 中隱藏關閉 最大化 最小化按鈕
// src/main/index.js
mainWindow = new BrowserWindow({
height: 620,
useContentSize: true,
width: 1280,
frame: false /*去掉頂部導航 去掉關閉按鈕 最大化最小化按鈕*/
})
複製代碼
3 .electron-vue 自定義關閉/最大化最小化按鈕
// 注意在mac下不須要監聽窗口最大最小化、覺得系統默認支持,這個只是針對windows平臺
ipc.on('window-min',function() {
mainWindow.minimize();
})
//登陸窗口最大化
ipc.on('window-max',function(){
if (mainWindow.isMaximized()) {
mainWindow.restore();
} else {
mainWindow.maximize();
}
})
ipc.on('window-close',function() {
mainWindow.close();
})
複製代碼
4. electron-vue 自定義導航可拖拽
css
: -webkit-app-region: drag;
css
: -webkit-app-region: no-drag;
項目源碼,僅作入門學習參考 github.com/poetries/yu…
1. 項目搭建
npm install -g vue-cli
vue init simulatedgreg/electron-vue my-project
cd my-project
yarn # or npm install
yarn run dev # or npm run dev
複製代碼
2. 安裝一些依賴
# 安裝 sass-loader:
npm install --save-dev sass-loader node-sass
# 安裝elementUI、js-md5
npm i element-ui js-md5 -S
複製代碼
.electron-vue/webpack.renderer.config.js
中配置sass-loader
就能夠編寫``sass`了<!--vue 文件中修改 style 爲以下代碼:-->
<style lang="scss"> body { /* SCSS */ } </style>
複製代碼
1. src/main/index.js
function createWindow () {
// 去掉頂部菜單
mainWindow.setMenu(null)
// 菜單項
require('./model/menu.js');
// 系統托盤相關
require('./model/tray.js');
複製代碼
2. src/main/menu.js
菜單配置
const { Menu,ipcMain,BrowserWindow} = require('electron');
//右鍵菜單
const contextMenuTemplate=[
{
label: '複製', role: 'copy' },
{
label: '黏貼', role: 'paste' },
{ type: 'separator' }, //分隔線
{
label: '其餘功能',
click: () => {
console.log('click')
}
}
];
const contextMenu=Menu.buildFromTemplate(contextMenuTemplate);
ipcMain.on('contextmenu',function(){
contextMenu.popup(BrowserWindow.getFocusedWindow());
})
複製代碼
3. src/main/tray.js
系統托盤配置
托盤點擊監聽事件只有在
windows
下才生效,mac
系統默認支持
(function () {
const path=require('path');
const {app,Menu,BrowserWindow,Tray, shell} = require('electron');
//建立系統托盤
const tray = new Tray(path.resolve(__static, 'favicon.png'))
//給托盤增長右鍵菜單
const template= [
{
label: '設置',
click: function () {
shell.openExternal('http://blog.poetries.top')
}
},
{
label: '幫助',
click: function () {
shell.openExternal('http://blog.poetries.top/2019/01/06/electron-summary')
}
},
{
label: '關於',
click: function () {
shell.openExternal('https://github.com/poetries/yuqing-monitor-electron')
}
},
{
label: '退出',
click: function () {
// BrowserWindow.getFocusedWindow().webContents().send('close-main-window');
app.quit();
}
}
];
const menu = Menu.buildFromTemplate(template);
tray.setContextMenu(menu);
tray.setToolTip('輿情監控系統');
//監聽關閉事件隱藏到系統托盤
// 這裏須要注意:在window中才生效,mac下系統默認支持
// var win = BrowserWindow.getFocusedWindow();
// win.on('close',(e)=>{
// if(!win.isFocused()){
// win=null;
// }else{
// e.preventDefault(); /*阻止應用退出*/
// win.hide(); /*隱藏當前窗口*/
// }
// })
// //監聽托盤的雙擊事件
// tray.on('double-click',()=>{
// win.show();
// })
})()
複製代碼
4. src/main/shortCut.js
快捷鍵配置
在src/main/index.js
中引入(require('src/main/shortCut.js')
)便可,不須要放到app
監控中
var {globalShortcut, app} = require('electron')
app.on('ready', ()=>{
// 註冊全局快捷鍵
globalShortcut.register('command+e', ()=>{
console.log(1)
})
// 檢測快捷鍵是否註冊成功 true是註冊成功
let isRegister = globalShortcut.isRegistered('command+e')
console.log(isRegister)
})
// 退出的時候取消全局快捷鍵
app.on('will-quit', ()=>{
globalShortcut.unregister('command+e')
})
複製代碼
1. src/render/main.js配置
import Vue from 'vue'
import axios from 'axios'
import App from './App'
import router from './router'
import store from './store'
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
import VueHighcharts from 'vue-highcharts';
import VueSocketIO from 'vue-socket.io'
Vue.use(ElementUI);
Vue.use(VueHighcharts);
//引入socket.io配置鏈接
Vue.use(new VueSocketIO({
debug: true,
connection: 'http://118.123.14.36:3000',
vuex: {
store,
actionPrefix: 'SOCKET_',
mutationPrefix: 'SOCKET_'
}
}))
if (!process.env.IS_WEB) Vue.use(require('vue-electron'))
Vue.http = Vue.prototype.$http = axios
Vue.config.productionTip = false
/* eslint-disable no-new */
new Vue({
components: { App },
router,
store,
template: '<App/>'
}).$mount('#app')
複製代碼
2. 路由配置src/renderer/router/index.js
import Vue from 'vue'
import Router from 'vue-router'
Vue.use(Router)
export default new Router({
routes: [
{
path: '/home',
name: 'home',
component: require('@/components/Home').default
},
{
path: '/report',
name: 'report',
component: require('@/components/Report').default
},
{
path: '/negativereport',
name: 'negativereport',
component: require('@/components/NegativeReport').default
},
{
path: '/positivereport',
name: 'positivereport',
component: require('@/components/PositiveReport').default
},
{
path: '/keyword',
name: 'keyword',
component: require('@/components/KeyWord').default
},
{
path: '/alarm',
name: 'alarm',
component: require('@/components/Alarm').default
},
{
path: '/msg',
name: 'msg',
component: require('@/components/Msg').default
},
{
path: '*',
redirect: '/home'
}
]
})
複製代碼
3. 在渲染進程中使用主進程方式
// electron掛載到了vue實例上 $electron
this.$electron.shell
複製代碼
須要注意的是打包
mac
版本在mac
系統上打包,打包window
則在windows
上打包,能夠避免不少問題
# 在不一樣平臺上執行便可打包應用
npm run build
複製代碼
1. electron 中構建應用最經常使用的模塊
electron-packager
electron-builder
electron-packager
和electron-builder
在本身單首創建的應用用也能夠完成打包功 能。可是因爲配置太複雜因此咱們不建議單獨配置
2. electron-forge
electron-forge package
electron-forge make
複製代碼
3. electron-vue中的打包方式
# https://simulatedgreg.gitbooks.io/electron-vue/content/cn/using-electron-packager. html
# 之須要執行一條命令
npm run build
複製代碼
1. 修改package.json
2. 修改src/index.ejs標題信息
3. 修改build/icons圖標
1. 建立應用托盤的時候可能會遇到錯誤
static
裏面,而後注意下面寫法。var tray = new Tray(path.join(__static,'favicon.ico'))
複製代碼
.png
格式重試2. 模塊問題可能會遇到的錯誤
解決辦法
node_modules
而後從新用 npm install
安裝依賴yarn
來安裝模塊最後執行
yarn run build
便可
項目截圖
輿情監控系統頁面
系統系統托盤、
electron
消息通知 (相似騰訊新聞)