React + Electron Praxisprojekt

In diesem Kapitel erstellen wir mit React + Electron eine Notizen-Anwendung. Dieses Praxisprojekt heißt ReactElectronNotes und seine Funktionen umfassen Unterstützung mehrerer Fenster, Tray, Dateioperationen und IPC-Kommunikation. Es ist ein sehr geeignetes Projekt für Anfänger zum Üben.

Wenn Sie mit React noch nicht vertraut sind, lesen Sie:React-Tutorial。

ReactElectronNotesDas Projekt zeigt Ihnen, wie Sie von Grund auf eineplattformübergreifende Desktop-Notizanwendungerstellen, einschließlich der folgenden Funktionen:

  • React-Frontend-Rendering
  • Electron-Hauptprozessverwaltung
  • IPC-Kommunikation (Hauptprozess ↔ Renderer-Prozess)
  • Lokale Persistenz von Notizdaten (electron-store)
  • System-Tray- und Menüintegration

Beschreibung der Projektstruktur

ReactElectronNotes/
│
├── src/                  # React 源码目录
├── build/                # 打包后的 React 静态文件
├── electron-main.js      # Electron 主进程
├── preload.js            # 渲染与主进程通信桥
├── note.html             # 子窗口页面
├── note.js               # 子窗口脚本
├── package.json
└── assets/
    └── icon.png          # 托盘图标

I. Projektfunktionsübersicht

Funktionsmodul Beschreibung
Hauptfenster Liste aller Notizen anzeigen
Unterfenster Neue Notiz eingeben
Local Storage Nutzungelectron-storeDaten speichern
Tray In den System-Tray minimieren, klicken, um die Hauptoberfläche aufzurufen
IPC-Kommunikation Der Renderer-Prozess interagiert mit dem Hauptprozess, um Daten zu lesen und zu schreiben.

2. Projektinitialisierung

1. Ein React-Projekt erstellen

npx create-react-app ReactElectronNotes
cd ReactElectronNotes

2. Electron und seine Abhängigkeiten installieren

npm install --save-dev electron electron-builder concurrently wait-on
npm install electron-store

3. Ändernpackage.json

Stellen Sie sicher, dassscriptsFügen Sie den Electron-Startbefehl in:

"main": "electron-main.js",
"scripts": {
  "react-start": "react-scripts start",
  "react-build": "react-scripts build",
  "electron-start": "concurrently \"npm run react-start\" \"wait-on http://localhost:3000 && electron .\"",
  "electron-build": "react-scripts build && electron-builder"
}

3. Electron-Hauptprozess erstellen

Neue Dateielectron-main.js:

Beispiel

const { app, BrowserWindow, Tray, Menu, ipcMain } = require('electron')
const path = require('path')
const Store = require('electron-store')

let mainWindow, noteWindow, tray
const store = new Store()

function createMainWindow() {
  mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      contextIsolation: true,
      nodeIntegration: false
    }
  })

  if (process.env.NODE_ENV === 'development') {
    mainWindow.loadURL('http://localhost:3000')
  } else {
    mainWindow.loadFile(path.join(__dirname, 'build/index.html'))
  }

  mainWindow.on('minimize', (e) => {
    e.preventDefault()
    mainWindow.hide()
  })

  createTray()
}

function createNoteWindow() {
  noteWindow = new BrowserWindow({
    width: 400,
    height: 300,
    parent: mainWindow,
    modal: true,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      contextIsolation: true,
      nodeIntegration: false
    }
  })

  noteWindow.loadFile(path.join(__dirname, 'note.html'))
}

function createTray() {
  tray = new Tray(path.join(__dirname, 'assets/icon.png'))
  const menu = Menu.buildFromTemplate([
    { label: Fenster anzeigen, click: () => mainWindow.show() },
    { label: 'Beenden', click: () => app.Beenden() }
  ])
  tray.setToolTip('ReactElectronNotes')
  tray.setContextMenu(menu)
}

app.whenReady().then(createMainWindow)

ipcMain.handle('get-notes', () => {
  return store.get('notes', [])
})

ipcMain.on('save-note', (event, note) => {
  const notes = store.get('notes', [])
  notes.push(note)
  store.set('notes', notes)
  mainWindow.webContents.send('update-notes', notes)
})

app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') app.quit()
})

4. Preload-Skript erstellen

Neupreload.js:

Beispiel

const { contextBridge, ipcRenderer } = require('electron')

contextBridge.exposeInMainWorld('electronAPI', {
  getNotes: () => ipcRenderer.invoke('get-notes'),
  saveNote: (note) => ipcRenderer.send('save-note', note),
  onUpdateNotes: (callback) => ipcRenderer.on('update-notes', callback)
})

Beschreibung:
DurchcontextBridgeAPIs sicher für den Renderer-Prozess bereitstellen.


V. React-Frontend-Schnittstelle

src/App.js

Beispiel

import React, { useState, useEffect } from 'react'

function App() {
  const [notes, setNotes] = useState([])

  useEffect(() => {
    window.electronAPI.getNotes().then(setNotes)
    window.electronAPI.onUpdateNotes((_event, newNotes) => setNotes(newNotes))
  }, [])

  const openNoteWindow = () => {
    window.open('note.html', Neue Notiz, 'width=400,height=300')
  }

  return (
    <div style={{ padding: 20 }}>
      <h1>Meine Notizen</h1>
      <button onClick={openNoteWindow}>Neue Notiz</button>
      <ul>
        {notes.map((n, i) => (
          <li key={i}>{n}</li>
        ))}
      </ul>
    </div>
  )
}

export default App

Neunote.htmlundnote.js

note.html

Beispiel

<!DOCTYPE html>
<html lang="zh">
<head>
  <meta charset="UTF-8">
  <title>Neue Notiz</title>
</head>
<body>
  <h2>Neue Notiz</h2>
  <textarea id="note"></textarea><br>
  <button id="saveBtn">Speichern</button>
  <script src="note.js"></script>
</body>
</html>

note.js

Beispiel

const saveBtn = document.getElementById('saveBtn')
saveBtn.addEventListener('click', () => {
  const note = document.getElementById('note').value
  if (note.trim()) {
    window.electronAPI.saveNote(note)
    window.close()
  }
})

6. Ausführen und Verpacken

Entwicklungsumgebung starten

npm run electron-start

Nach dem Öffnen erscheint das React-Hauptfenster. Sie können auf "Neue Notiz" klicken, um ein Eingabefenster zu öffnen.

Paketieren und Veröffentlichen

npm run electron-build

Erzeugt plattformübergreifende ausführbare Dateien (.exe、.app、.AppImageusw.).


7. Erweiterungsrichtungen

Funktionen Ansatz
Markdown-Unterstützung Nutzungreact-markdownInhalt rendern
Datensuche React-Seite überfilter()Lokale Suche implementieren
Automatisches Speichern Auf Eingabefeld hörenonChangeAutomatisches Speichern
Cloud-Synchronisierung Firebase oder eine selbstgebaute REST-API integrieren
Tastenkürzel NutzungglobalShortcutCtrl+N zum Erstellen einer neuen Notiz registrieren
Weitere Erweiterungen