Vue + Electron Praxisprojekt

In diesem Kapitel verwenden wirVue + Electron, um eine Notiz-App zu erstellen. Dieses praktische Projekt heißtVueElectronNotesund bietet Funktionen wie Multi-Window, Tray, Dateioperationen und IPC-Kommunikation. Es ist ein sehr geeignetes Projekt für Anfänger zum Üben.

Wenn Sie Vue noch nicht kennen, können Sie zunächst Folgendes konsultieren:Vue-Tutorial。


I. Projektfunktionen

  • Desktop-Notiz-App (Notes)
  • Das Hauptfenster zeigt die Liste der Notizen an
  • Ein untergeordnetes Fenster wird zum Erstellen neuer Notizen eingeblendet
  • System-Tray-Symbol, Minimieren in den Tray
  • Lokales Speichern/Lesen von Dateien
  • Sichere Kommunikation zwischen dem Renderer-Prozess und dem Hauptprozess

II. Projektinitialisierung

1. Ein Vue-Projekt erstellen

vue create VueElectronNotes
cd VueElectronNotes

Standard-Preset auswählen (Babel + ESLint).

2. Electron und Abhängigkeiten installieren

npm install --save-dev electron electron-builder concurrently wait-on
npm install electron-store
  • electron-storeFür lokale Datenpersistenz

III. Konfiguration des Hauptprozesses

electron-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:8080')
  } else {
    mainWindow.loadFile('dist/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('note.html')
}

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

app.whenReady().then(createMainWindow)

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

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)
})

Beschreibung:

  • mainWindow: Hauptfenster, zeigt die Liste der Notizen an
  • noteWindow: Untergeordnetes Fenster, wird zum Erstellen neuer Notizen verwendet
  • Tray: System-Tray-Symbol und Menü
  • ipcMain: Der Hauptprozess empfängt Nachrichten vom Renderer-Prozess

4. Renderer-Prozess und Vue

preload.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)
})

src/App.vue:

Beispiel

<template>
  <div>
    <h1>Notizliste</h1>
    <button @click="openNoteWindow">Neue Notiz</button>
    <ul>
      <li v-for="(note, index) in notes" :key="index">{{ note }}</li>
    </ul>
  </div>
</template>

<script>
export default {
  data() {
    return { notes: [] }
  },
  methods: {
    openNoteWindow() {
window.open('note.html', 'New Note', 'width=400,height=300')
    }
  },
  mounted() {
    window.electronAPI.getNotes().then((notes) => {
      this.notes = notes
    })

    window.electronAPI.onUpdateNotes((event, notes) => {
      this.notes = notes
    })
  }
}
</script>

note.html + note.js:

note.html:

Beispiel

<!DOCTYPE html>
<html>
  <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) {
    window.electronAPI.saveNote(note)
    window.close()
  }
})

Beschreibung:

  • note.htmlist ein Pop-up-Fenster zur Eingabe von Notizen
  • note.jsAufrufelectronAPI.saveNoteAn den Hauptprozess senden
  • Das Hauptfenster wird es empfangenupdate-notesDie Meldung aktualisiert die Liste

V. Das Projekt ausführen

Entwicklungsmodus:

npm run electron:serve
  • Vue Dev Server + Electron gleichzeitig starten
  • UI kann in Echtzeit debuggt werden

Paketierung der Anwendung:

npm run electron:build
  • Ausführbare Datei ausgeben nachdist_electron
  • Unterstützt Windows/macOS/Linux
Weitere Erweiterungen