Electron-Flask 项目教程

1. 项目的目录结构及介绍

electron-flask/
├── github/
│   └── workflows/
├── web_app/
├── .gitignore
├── LICENSE
├── icon.png
├── ipc.png
├── package-lock.json
├── package.json
├── package_python.js
├── README.md
├── renderer.js
├── requirements.txt
└── screenshot.png

• github/workflows/: 包含GitHub Actions的工作流配置文件。
• web_app/: 包含Flask应用程序的文件。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• icon.png: 应用程序的图标文件。
• ipc.png: 可能是进程间通信的图标文件。
• package-lock.json: 锁定NPM依赖版本的文件。
• package.json: 项目的NPM配置文件，包含依赖和脚本。
• package_python.js: 可能是用于Python打包的JavaScript文件。
• README.md: 项目的说明文档。
• renderer.js: Electron渲染进程的JavaScript文件。
• requirements.txt: Python项目的依赖列表。
• screenshot.png: 应用程序的截图。

2. 项目的启动文件介绍

主进程启动文件

• package.json:

  {
    "main": "main.js"
  }
  

  这是Electron应用程序的入口点，main.js文件负责启动主进程。

• main.js:

  const { app, BrowserWindow } = require('electron');
  const path = require('path');
  const { execFile } = require('child_process');
  
  let pyProc = null;
  
  function createWindow() {
    const win = new BrowserWindow({
      width: 800,
      height: 600,
      webPreferences: {
        preload: path.join(__dirname, 'renderer.js')
      }
    });
  
    win.loadFile('index.html');
  }
  
  function startServer_EXE() {
    let script = path.join(__dirname, 'pydist', 'app', 'app.exe');
    pyProc = execFile(script);
    if (pyProc !== null) {
      console.log('Flask server start success');
    }
  }
  
  function stopServer() {
    if (pyProc) {
      pyProc.kill();
      console.log('Kill Flask server success');
      pyProc = null;
    }
  }
  
  function initApp() {
    startServer_EXE();
    createWindow();
  }
  
  app.on('ready', initApp);
  
  app.on('window-all-closed', () => {
    if (process.platform !== 'darwin') {
      stopServer();
      app.quit();
    }
  });
  

渲染进程启动文件

• renderer.js:

  document.getElementById('start-server').addEventListener('click', () => {
    fetch('http://localhost:5000/start')
      .then(response => response.json())
      .then(data => {
        console.log('response:', data);
      });
  });
  

3. 项目的配置文件介绍

package.json

{
  "name": "electron-flask",
  "version": "1.0.0",
  "description": "Electron-Flask Bootstrap Template",
  "main": "main.js",
  "scripts": {
    "start": "electron .",
    "pack-app": "electron-packager . --overwrite --ignore=py$ --arch=x64 --download.mirrorOptions.mirror=https://npm.taobao.org/mirrors/electron/"
  },
  "dependencies": {
    "electron": "^16.0.0"
  },
  "devDependencies": {
    "electron-packager": "^15.4.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述