Файловая система и хранение данных в Electron

В Electron, поскольку он основан на Node.js, можно напрямую обращаться к файловой системе, базам данных и локальному хранилищу.

Это позволяет настольным приложениям читать и записывать файлы, сохранять конфигурации и даже реализовывать сложное управление данными, так же как традиционное программное обеспечение.


Операции с файловой системой

Electron позволяет использовать встроенные модули Node.js в процессе рендеринга или в главном процессе.fsМодуль выполняет операции с файлами.

Использование модуля fs Node.js

fsЭти модули предоставляют различные операции с файловой системой, такие как чтение, запись, переименование, удаление и т. д.

Пример

const fs = require('fs');
const path = require('path');

// Получить текущий путь приложения
const filePath = path.join(__dirname, 'data.txt');

// Читать файл асинхронно
fs.readFile(filePath, 'utf8', (err, data) => {
  if (err) throw err;
  console.log('File content:', data);
});

// Записать файл (перезаписать)
fs.writeFile(filePath, 'Hello Electron!', (err) => {
  if (err) throw err;
  console.log(Write Complete);
});

Описание параметра:

  • fs.readFile(path, encoding, callback)Асинхронно читает содержимое файла.
  • fs.writeFile(path, data, callback): Записывает в файл (автоматически создает его, если он не существует).
  • path.join()Объединяет пути, совместим с разными платформами.

Отслеживание файлов

Вы можете использоватьfs.watchМониторинг изменений файлов в режиме реального времени, например, для обнаружения обновлений конфигурационных файлов или файлов данных:

fs.watch(filePath, (eventType, filename) => {
  console.log(`文件变化类型: ${eventType}`);
  console.log(`变化的文件: ${filename}`);
});

Путь к каталогу приложения

Electron предоставляетapp.getPath(name)Метод для получения стандартных системных путей:

const { app } = require('electron');

console.log(app.getPath('home'));       // 用户主目录
console.log(app.getPath('desktop'));    // 桌面路径
console.log(app.getPath('userData'));   // 应用数据目录

Эти пути можно использовать для хранения журналов, кэшей или файлов конфигурации пользователя.


Локальное хранилище данных

Приложения Electron обычно должны сохранять пользовательские конфигурации, кэши или информацию о состоянии. Распространённые методы хранения включают:

localStorage и sessionStorage

Подходит для простых данных типа ключ-значение, таких как настройки темы, состояние окна и т. д.:

localStorage.setItem('theme', 'dark');
const theme = localStorage.getItem('theme');
console.log(theme);

Разница:

  • localStorage: Постоянное хранилище, сохраняется после закрытия приложения.
  • sessionStorage: Хранилище уровня сеанса, очищается при закрытии окна.

База данных IndexedDB

Подходит для хранения структурированных данных, применимо к офлайн-приложениям:

Пример

const request = indexedDB.open('myDatabase', 1);

request.onupgradeneeded = function () {
  const db = request.result;
  db.createObjectStore('users', { keyPath: 'id' });
};

request.onsuccess = function () {
  const db = request.result;
  const tx = db.transaction('users', 'readwrite');
  const store = tx.objectStore('users');
  store.put({ id: 1, name: 'Alice', age: 25 });
};

Использование electron-store

electron-store— это самое удобное хранилище конфигурации, автоматически сохраняемое на основе JSON.

Установка:

npm install electron-store

Пример использования:

Пример

const Store = require('electron-store');
const store = new Store();

// Сохранить конфигурацию
store.set('user.name', 'Tom');
store.set('theme', 'dark');

// Прочитать конфигурацию
console.log(store.get('user.name')); // Tom

// Удалить конфигурацию
store.delete('theme');

Преимущества:

  • Автоматически сохраняется в каталог пользовательских данных;
  • Формат JSON, интуитивно понятный и простой для редактирования;
  • Подходит для небольшого постоянного хранилища (настройки, кэши и т. д.).

Рекомендации по хранению данных

Сценарии Рекомендуемое решение
Простые пары ключ-значение electron-store
Структурированные данные IndexedDB
Большие файлы данных fs + JSON-файлы
База данных офлайн-приложения SQLite или LevelDB

Интеграция базы данных

Когда приложению нужно хранить большие объёмы данных или реляционные данные, можно интегрировать базу данных.

Интеграция SQLite

SQLite — наиболее часто используемая встраиваемая база данных для приложений Electron.
Установите зависимости:

 npm install sqlite3

Пример кода:

Пример

const sqlite3 = require('sqlite3').verbose();
const db = new sqlite3.Database('mydata.db');

// Создание таблицы
db.run("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT, age INTEGER)");

// Вставка данных
db.run("INSERT INTO users (name, age) VALUES (?, ?)", ['Alice', 25]);

// Запрос данных
db.all("SELECT * FROM users", [], (err, rows) => {
  if (err) throw err;
  console.log(rows);
});

Использование LevelDB

LevelDB — это база данных ключ-значение, подходящая для кэширования и высокопроизводительных операций чтения и записи.

Установка:

npm install level

Пример использования:

Пример

const level = require('level');
const db = level('./mydb');

// Запись данных
await db.put('username', 'Bob');

// Чтение данных
const value = await db.get('username');
console.log(value);

Другие параметры базы данных

Type Применимые сценарии рекомендуемая библиотека
MongoDB Облачная синхронизация, распределённая mongoose
MySQL Реляционные большие данные mysql2
Realm Мобильная синхронизация realm-js
LokiJS База данных в памяти lokijs

Подробное резюме

В Electron решения для хранения данных гибкие и разнообразные:

  • Малые данные →electron-store;
  • Большие данные →SQLite;
  • Структурированные →IndexedDB;
  • Высокоскоростные ключ-значение →LevelDB;
  • Файловые →fs + JSON。

Это позволяет приложениям Electron оставаться легковесными и при этом решать сложные задачи бизнес-логики и хранения данных.

Другие расширения