Electron 實戰桌面計算器應用

linshuai發表於2017-09-04

前言

Electron 是一個搭建跨平臺桌面應用的框架,僅僅使用 JavaScript、HTML 以及 CSS,即可快速而容易地搭建一個原生應用。這對於想要涉及其他領域的開發者來說是一個非常大的福利。

專案介紹

倉庫地址:lin-xin/calculator

我這裡通過 Electron 實現了仿 iPhone 的計算器,通過選單可以切換橫屏和豎屏,橫屏有更多的運算。而對於 JavaScript 進行浮點數計算來說,精度丟失是個很大問題,所以我這裡使用了第三方庫 math.js 來解決這個精度的問題。
儘可能的實現了跟 iPhone 一樣的運算:

  • 1 + 2 × 3 = 7
  • 3 += 6 (再按 = 等於 9)
  • 0.1 + 0.2 = 0.3 (浮點數精度處理)

Image text
Image text

Image text
Image text

不過我下面並不是要講計算器,而是用到的 Electron 的知識點。

生命週期

在主程式中通過 app 模組控制整個應用的生命週期。

當 Electron 完成初始化時觸發 ready 事件:

app.on('ready', () => {
    // 建立視窗、載入頁面等操作
})複製程式碼

當所有的視窗都被關閉時會觸發 window-all-closed 事件:

app.on('window-all-closed', () => {
    if(process.platform !== 'darwin'){
        app.quit();     // 退出應用
    }
})複製程式碼

在開發中發現,沒有監聽該事件,打包後的應用關閉後,程式還保留著,會佔用系統的記憶體。

視窗

本來我們的 html 只顯示在瀏覽器中,而 electron 提供了一個 BrowserWindow 模組用於建立和控制瀏覽器視窗,我們的頁面就是顯示在這樣的視窗中。

建立視窗

通過關鍵字 new 例項化返回 win 物件,該物件有豐富的方法對視窗進行控制。

win = new BrowserWindow({
    width: 390,         // 視窗寬度
    height: 670,        // 視窗高度
    fullscreen: false,  // 不允許全屏
    resizable: false    // 不允許改變視窗size,不然佈局就亂了啊
});複製程式碼

載入頁面

視窗建立完是一片空白的,可以通過 win.loadURL() 來載入要顯示的頁面。

const path = require('path');
const url = require('url');

win.loadURL(url.format({    // 載入本地的檔案
    pathname: path.join(__dirname, 'index.html'),
    protocol: 'file',
    slashes: true
}))複製程式碼

也可以直接載入遠端連結 win.loadURL('blog.gdfengshuo.com');

選單

桌面應用選單欄是最常見的功能。Electron 提供了 Menu 模組來建立原生的應用選單和 context 選單,

const template = [                              // 建立選單模板
    {
        label: '檢視',
        submenu: [
            {label: '豎屏', type: 'radio', checked: true},      // type 屬性讓選單為 radio 可選
            {label: '橫屏', type: 'radio', checked: false},
            {label: '過載',role:'reload'},
            {label: '退出',role:'quit'},
        ]
    }
]

const menu = Menu.buildFromTemplate(template);  // 通過模板返回選單的陣列
Menu.setApplicationMenu(menu);                  // 將該陣列設定為選單複製程式碼

在子選單中,通過點選豎屏或橫屏來進行一些操作,那就可以給 submenu 監聽 click 事件。

const template = [
    {
        label: '檢視',
        submenu: [
            {
                label: '橫屏'
                click: () => {              // 監聽橫屏的點選事件
                    win.setSize(670,460);   // 設定視窗的寬高
                }
            }
        ]
    }
]複製程式碼

主程式和渲染程式通訊

雖然點選橫屏的時候,可以設定視窗的寬高,但是要如何去觸發頁面裡的方法,這裡就需要主程式跟渲染程式之間進行通訊。

主程式,可以理解為 main.js 用來寫 electron api 的就是主程式,渲染程式就是渲染出來的頁面。

ipcMain

在主程式中可以使用 ipcMain 模組,它控制著由渲染程式(web page)傳送過來的非同步或同步訊息。

const {ipcMain} = require('electron')
ipcMain.on('send-message', (event, arg) => {
    event.sender.send('reply-message', 'hello world')
})複製程式碼

ipcMain 監聽 send-message 事件,當訊息到達時可以呼叫 event.sender.send 來回復非同步訊息,向渲染程式傳送 reply-message 事件,也可以帶著引數傳送過去。

ipcRenderer

在渲染程式可以呼叫 ipcRenderer 模組向主程式傳送同步或非同步訊息,也可以收到主程式的相應。

const {ipcRenderer} = require('electron')
ipcRenderer.on('reply-message', (event, arg) => {
    console.log(arg);       // hello world
})

ipcRenderer.send('anything', 'hello everyone');複製程式碼

ipcRenderer 可以監聽到來自主程式的 reply-message 事件並拿到引數進行操作,也可以使用 send() 方法向主程式傳送訊息。

webContents

webContents 是一個事件發出者,它負責渲染並控制網頁,也是 BrowserWindow 物件的屬性。在 ipcMain 中的 event.sender,返回傳送訊息的 webContents 物件,所以包含著 send() 方法用於傳送訊息。

const win = BrowserWindow.fromId(1);        // fromId() 方法找到ID為1的視窗
win.webContents.on('todo', () => {
    win.webContents.send('done', 'well done!')
})複製程式碼

remote

remote 模組提供了一種在渲染程式(網頁)和主程式之間進行程式間通訊(IPC)的簡便途徑。在 Electron 中,有許多模組只存在主程式中,想要呼叫這些模組的方法需要通過 ipc 模組向主程式傳送訊息,讓主程式呼叫這些方法。而使用 remote 模組,則可以在渲染程式中呼叫這些只存在於主程式物件的方法了。

const {remote} = require('electron')
const BrowserWindow = remote.BrowserWindow      // 訪問主程式中的BrowserWindow模組

let win = new BrowserWindow();                  // 其他的跟主程式的操作都一樣複製程式碼

remote 模組除了可以訪問主程式的內建模組,自身還有一些方法。

remote.require(module)          // 返回在主程式中執行 require(module) 所返回的物件
remote.getCurrentWindow()       // 返回該網頁所屬的 BrowserWindow 物件
remote.getCurrentWebContents()  // 返回該網頁的 WebContents 物件
remote.getGlobal(name)          // 返回在主程式中名為 name 的全域性變數(即 global[name])
remote.process                  // 返回主程式中的 process 物件,等同於 remote.getGlobal('process') 但是有快取複製程式碼

shell 模組

使用系統預設應用管理檔案和 URL,而且在主程式和渲染程式中都可以用到該模組。在選單中,我想點選子選單開啟一個網站,那麼就可以用到 shell.openExternal() 方法,則會在預設瀏覽器中開啟 URL

const {shell} = require('electron');
shell.openExternal('https://github.com/lin-xin/calculator');複製程式碼

打包應用

其實將程式打包成桌面應用才是比較麻煩的事。我這裡嘗試了 electron-packager 和 electron-builder。

electron-packager

electron-packager 可以將專案打包成各平臺可直接執行的程式,而不是安裝包。

先使用 npm 安裝: npm install electron-packager -S

執行打包命令:

electron-packager ./ 計算器 --platform=win32 --overwrite --icon=./icon.ico複製程式碼

打包會把專案檔案包括 node_modules 也一起打包進去,當然可以通過 --ignore=node_modules 來忽略檔案,但是如果專案中有用到第三方庫,忽略的話則找不到檔案報錯了。

正確的做法就是嚴格區分 dependencies 和 devDependencies,打包的時候只會把 dependencies 的庫打包,而使用 cnpm 安裝的會有一大堆 .0.xx@xxx 的檔案,也會被打包,所以最好不要用 cnpm

electron-builder

electron-builder 是基於 electron-packager 打包出來的程式再做安裝處理,將專案打包成安裝檔案。

安裝:npm install electron-builder -S

打包:electron-builder --win

打包過程中,第一次下載 electron 可能會出現連線超時,可以使用 yarn 試試。還有 winCodeSign 和 nsis-resources 也可能會失敗,可以參考 electron-builder/issues 解決。

總結

Electron 用起來還是相對容易的,可以建立個簡單的桌面應用,只是打包的過程比較容易遇到問題,網上好像也有一鍵打包的工具,沒嘗試過。以上也都是基於 windows 7 的實踐,畢竟沒有 Mac 搞不了。

更多文章:linxin/blog

相關文章