文档背景
最近需要自制一款客户端应用程序,学习一下electron开发客户端程序是非常有必要的。
1、入门Demo
1.1、创建项目
使用脚手架创建项目
- 使用npm创建
//创建目录
mkdir my-electron-app && cd my-electron-app
//在该目录下 初始化项目
npm init
- 使用yarn创建
mkdir my-electron-app && cd my-electron-app
yarn init
1.2、下载依赖
cnpm install --save-dev electron
1.3、目录结构
1.4、完整代码
index.html
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<!-- https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP -->
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
<title>Hello World!</title>
</head>
<body>
<h1>Hello World!</h1>
We are using Node.js <span id="node-version"></span>,
Chromium <span id="chrome-version"></span>,
and Electron <span id="electron-version"></span>.
<!-- 您也可以此进程中运行其他文件 -->
<script src="./renderer.js"></script>
</body>
</html>
main.js
// main.js
// Modules to control application life and create native browser window
const {
app,
BrowserWindow
} = require('electron')
const path = require('path')
const createWindow = () => {
// Create the browser window.
const mainWindow = new BrowserWindow({
width: 800,
height: 600,
webPreferences: {
preload: path.join(__dirname, 'preload.js')
}
})
// 加载 index.html
mainWindow.loadFile('index.html')
// 打开开发工具
// mainWindow.webContents.openDevTools()
}
// 这段程序将会在 Electron 结束初始化
// 和创建浏览器窗口的时候调用
// 部分 API 在 ready 事件触发后才能使用。
app.whenReady().then(() => {
createWindow()
app.on('activate', () => {
// 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 (BrowserWindow.getAllWindows().length === 0) createWindow()
})
})
// 除了 macOS 外,当所有窗口都被关闭的时候退出程序。 There, it's common
// for applications and their menu bar to stay active until the user quits
// explicitly with Cmd + Q.
app.on('window-all-closed', () => {
if (process.platform !== 'darwin') app.quit()
})
// In this file you can include the rest of your app's specific main process
// code. 也可以拆分成几个文件,然后用 require 导入。
package.json
{
"name": "vdclent-app",
"version": "1.0.0",
"description": "demo",
"main": "main.js",
"scripts": {
"start": "electron-forge start",
"package": "electron-forge package",
"make": "electron-forge make"
},
"author": "thelongi",
"license": "MIT",
"devDependencies": {
"@electron-forge/cli": "^6.0.0-beta.64",
"electron": "^19.0.6"
},
"dependencies": {}
}
proload.js
// preload.js
// 所有Node.js API都可以在预加载过程中使用。
// 它拥有与Chrome扩展一样的沙盒。
window.addEventListener('DOMContentLoaded', () => {
const replaceText = (selector, text) => {
const element = document.getElementById(selector)
if (element) element.innerText = text
}
for (const dependency of ['chrome', 'node', 'electron']) {
replaceText(`${dependency}-version`, process.versions[dependency])
}
})
1.5、启动项目
npm start
2、快速开发
克隆到本地
git clone https://github.com/electron/electron-quick-start
下载依赖 运行项目
cd electron-quick-start
npm install
npm start
Tip:如果下载过慢则在目录根路径下添加.npmrc文件。
编辑内容:加上electron_mirror=https://npm.taobao.org/mirrors/electron/ 即可
3、打包出现的问题
打包可能会出现下载对应的插件下载不到就无法打包了。怎么做呢?
我们来番一下茄。就可以下载了。如果不行就直接去对应官网上下载,然后放在文档说明的文件夹里。