AntDesignPro使用electron構建桌面應用示例詳解

Posted on by

註意事項聲明

  • 所有 node 包必須使用 npm 安裝不可使用 cnpm, 使用 cnpm 安裝的 node 包會導致打包時間無限可能
  • 具體區別查看使用 npm 和 cnpm 安裝的包結構
  • 所有包的均可以安裝在全局, 避免重復安裝

主要分為兩個部分

開發環境使用

安裝 electron 包

npm install electron --save-dev

package.js 添加入口文件

  "main": "main.js",

創建 main.js 入口文件 內容如下

const {app, BrowserWindow, dialog} = require('electron'); 
const path = require('path');
const url = require('url');
​
// 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: 1300,
    height: 800,
    frame: true,
    autoHideMenuBar: true,
    fullscreenable: true,
    transparent: false,
    webPreferences: {
      javascript: true,
      plugins: true,
      nodeIntegration: true, // Nodejs
      webSecurity: false,
      preload: path.join(__dirname, './preload.js')
    }
  });
  // mainWindow.webContents.openDevTools();//打開調試工具
​
    //測試時使用mainWindow.loadURL(http://localhost:80000);
    //打包時加載本地文件
  mainWindow.loadURL(url.format({
    pathname: path.join(__dirname, 'dist/index.html'),
    protocol: 'file:',
    slashes: true
  }));
​
  // 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()
});

preload.js 文件內添加, 將 electron 做全局導入 未做此操作無法在其他地方使用 electron 模塊

global.electron = require('electron')

在 package.json 文件中加入啟動命令

  "scripts": {
    "electron-start": "electron .",
  },

試啟動 electron 窗口內容加載成功則成功

npm run electron-start

渲染進程如需和主進程通信查看官方文檔

https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes

打包應用配置

config/config.js 文件添加

history: 'hash', //更改路由方式
publicPath: './', //使打包後的文件使用相對路徑

src/utils/request.js 此目錄並非標準 不同版本下文件可能有所區別 重點在於給請求配置前綴

當項目打包成應用後使用的是 file:協議 ant pro 的請求無法發出 需要使用完整的請求地址 目前方法為配置前綴

/**
* 配置request請求時的默認參數
*/
const request = extend({
  errorHandler, // 默認錯誤處理
  prefix: 'http://hotel-system.yc384.com/api', // 請求前綴
  credentials: 'include', // 默認請求是否帶上cookie
});

package.json配置打包後的路徑方式

"homepage": ".",

使用 electron-builder 打包 exe 文件或者安裝包,壓縮包

  • 提示:
  • 提前安裝在全局可以省略不同環境重復安裝
  • 創建 app 目錄是為瞭不將 node 包打包進去,減少應用大小
  • 如果當前目錄下沒有 node 包或者內容較少可直接在當前操作, 省略 app 目錄相關操作

安裝

npm install electron-builder

package.json添加命令 (打包windows)

"electron-build": "electron-builder --win --x64"

添加打包配置

"build": {
"appId": "com.xxx.app",
"directories": {
  "output": "build"
}, // 打包後存放目錄
  "mac": {// mac安裝包dmg
  "target": ["dmg","zip"]
},
"win": {// win安裝包nsis
  "target": ["nsis","zip"]
}

創建app目錄(builder默認打包app下內容,否則會打包當前所有內容)

將ant pro打包後的dist文件和main.js放入app目錄

在app下創建package.json文件(外層package做打包使用,app下的package是打包後的應用依賴)

"name": "hotel",
"version": "2.3.1",
"main": "main.js",

執行打包命令

打包後文件會在 build 目錄下

npm run electron-build

使用 electron-packager 打包成 exe 文件

安裝electron-package

npm install electron-packager --save-dev

package.json下script添加命令(具體含義百度)

"electron-package": "electron-packager . hotelSystem --win32 --out app --arch=x64 --overwrite --ignore=node_modulesls --electron-version=6.0.5",

執行命令

npm run electron-package

提示

  • 打包環境可以和開發環境分開 這樣可以減少不必要依賴 縮短打包時間
  • 將打包後的 dist 和 main.js 文件放入一個新目錄
  • 配置 package.json 文件打包參數 其他刪除即可
"name": "hotel",
"version": "2.3.1",
"main": "main.js",
"homepage": ".",
"scripts": {
  "electron-start": "electron .",
}

以上就是AntDesignPro使用electron構建桌面應用示例詳解的詳細內容，更多關於AntDesignPro electron構建桌面的資料請關註WalkonNet其它相關文章！

推薦閱讀：