Electron ファイルシステムとデータストレージ
Electron では、Node.js ベースであるため、ファイルシステム、データベース、ローカルストレージに直接アクセスできます。
これにより、デスクトップアプリケーションは従来のソフトウェアのようにファイルの読み書き、設定の保存、さらには複雑なデータ管理を実現できます。
ファイルシステム操作
Electron では、レンダラープロセスまたはメインプロセスで Node.js の組み込みfsモジュールを使用してファイル操作を行うことができます。
Node.js fs モジュールの使用
fsこのモジュールは、読み取り、書き込み、名前変更、削除など、さまざまなファイルシステム操作を提供します。
例
const path = require('path');
// 現在のアプリパスを取得
const filePath = path.join(__dirname, 'data.txt');
// ファイルを非同期で読み込む
fs.readFile(filePath, 'utf8', (err, data) => {
if (err) throw err;
console.log('ファイル内容:', data);
});
// ファイルに書き込む(上書き)
fs.writeFile(filePath, 'Hello Electron!', (err) => {
if (err) throw err;
console.log('書き込み完了');
});
パラメータの説明:
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 データベース
構造化データの保存に適しており、オフラインアプリケーションに適しています:
例
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 = 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 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 db = level('./mydb');
// データを書き込む
await db.put('username', 'Bob');
// データを読み取る
const value = await db.get('username');
console.log(value);
その他のデータベース選択
| タイプ | 適用シナリオ | 推奨ライブラリ |
|---|---|---|
| MongoDB | クラウド同期、分散 | mongoose |
| MySQL | リレーショナル大規模データ | mysql2 |
| Realm | モバイル同期 | realm-js |
| LokiJS | インメモリデータベース | lokijs |
総合まとめ
Electron では、データストレージの選択肢は柔軟で多様です:
- 小データ →
electron-store; - 大データ →
SQLite; - 構造化 →
IndexedDB; - 高速キーと値 →
LevelDB; - ファイル型 →
fs + JSON。
これにより、Electron アプリケーションは軽量に動作しつつ、複雑なビジネスロジックとデータストレージタスクを担うことができます。
その他の拡張