利用Node.js模块在Electron中进行文件系统操作实战（上）

Electron 作为一个强大的桌面应用开发框架，其核心优势之一就是能够无缝融合 Web 技术与 Node.js 的原生 API ，特别是在文件系统操作方面。本文将详细介绍如何在 Electron 应用中利用 Node.js 的 fs 模块进行文件系统的读写、创建、删除等操作，并通过实例代码进行解析。

引入fs模块

在 Electron 中，由于主进程与渲染进程中均可以访问 Node.js API ，所以我们可以直接在主进程或 preload 脚本中引入 fs 模块：

// 主进程中引入fs模块
const { fs } = require('fs');

// 或在渲染进程中通过preload脚本引入fs模块
// preload.js
const { contextBridge, fs } = require('electron');
contextBridge.exposeInMainWorld('electronFs', fs);

文件读取操作

// 主进程中读取文件内容
fs.readFile('/path/to/your/file.txt', 'utf-8', (err, data) => {
  if (err) {
    console.error('读取文件失败:', err);
  } else {
    console.log('读取到的文件内容：', data);
  }
});

// 渲染进程中读取文件内容（需通过preload暴露fs模块）
window.electronFs.readFile('/path/to/your/file.txt', 'utf-8', (err, data) => {
  if (err) {
    console.error('读取文件失败:', err);
  } else {
    console.log('读取到的文件内容：', data);
  }
});

文件写入操作

// 准备要写入的内容
const content = '这是要写入文件的内容';

// 主进程中写入文件
fs.writeFile('/path/to/your/outputfile.txt', content, 'utf-8', (err) => {
  if (err) {
    console.error('写入文件失败:', err);
  } else {
    console.log('文件写入成功！');
  }
});

// 渲染进程中写入文件
window.electronFs.writeFile('/path/to/your/outputfile.txt', content, 'utf-8', (err) => {
  if (err) {
    console.error('写入文件失败:', err);
  } else {
    console.log('文件写入成功！');
  }
});

目录操作

1. 创建目录

   // 主进程中创建目录
   fs.mkdir('/path/to/new/directory', { recursive: true }, (err) => {
     if (err) {
       console.error('创建目录失败:', err);
     } else {
       console.log('目录创建成功！');
     }
   });
   
   // 渲染进程中创建目录
   window.electronFs.mkdir('/path/to/new/directory', { recursive: true }, (err) => {
     // 同样的错误处理逻辑
   });
   

2. 删除文件或目录

   // 主进程中删除文件
   fs.unlink('/path/to/remove/file.txt', (err) => {
     if (err) {
       console.error('删除文件失败:', err);
     } else {
       console.log('文件删除成功！');
     }
   });
   
   // 主进程中删除空目录
   fs.rmdir('/path/to/remove/directory', (err) => {
     if (err) {
       console.error('删除目录失败:', err);
     } else {
       console.log('目录删除成功！');
     }
   });
   
   // 若要删除非空目录，可以使用rimraf模块或递归删除子目录和文件
   

文件或目录是否存在检测

// 检查文件是否存在
fs.access('/path/to/check/file.txt', fs.constants.F_OK, (err) => {
  if (err) {
    if (err.code === 'ENOENT') {
      console.log('文件不存在');
    } else {
      console.error('无法访问文件:', err);
    }
  } else {
    console.log('文件存在');
  }
});

// 检查目录是否存在
fs.access('/path/to/check/directory', fs.constants.F_OK | fs.constants.R_OK | fs.constants.W_OK, (err) => {
  // 类似的错误处理逻辑
});

读取目录内容

// 读取目录中的所有文件和子目录
fs.readdir('/path/to/directory', (err, files) => {
  if (err) {
    console.error('读取目录失败:', err);
  } else {
    console.log('目录内容：', files);
  }
});

文件重命名或移动

// 文件重命名
fs.rename('/path/to/original.txt', '/path/to/newname.txt', (err) => {
  if (err) {
    console.error('文件重命名失败:', err);
  } else {
    console.log('文件重命名成功');
  }
});

// 移动文件（本质上也是重命名）
fs.rename('/path/to/move.txt', '/new/path/to/move.txt', (err) => {
  // 同样的错误处理逻辑
});

文件统计信息获取

// 获取文件的元数据信息
fs.stat('/path/to/file.txt', (err, stats) => {
  if (err) {
    console.error('获取文件信息失败:', err);
  } else {
    console.log('文件大小（字节）：', stats.size);
    console.log('文件最后修改时间:', stats.mtime);
    // 更多详细信息请查阅fs.Stats对象文档
  }
});

文件流操作

在处理大文件时，使用流（Stream）可以有效节省内存，提高文件读写的效率。例如，创建一个读取文件流：

const fs = require('fs');
const readStream = fs.createReadStream('/path/to/largefile.bin');

readStream.on('data', (chunk) => {
  // 处理每个数据块
  console.log(`处理了 ${chunk.length} 字节的数据`);
});

readStream.on('end', () => {
  console.log('读取文件结束');
});

readStream.on('error', (err) => {
  console.error('读取文件时发生错误:', err);
});

同样，也可以创建一个写入文件流：

const writeStream = fs.createWriteStream('/path/to/outputfile.bin');

writeStream.write('这是要写入的内容');
writeStream.end();

writeStream.on('finish', () => {
  console.log('写入文件完成');
});

writeStream.on('error', (err) => {
  console.error('写入文件时发生错误:', err);
});

同步与异步API

fs 模块提供了两种操作模式：异步（回调或 Promise 形式）和同步。异步操作不会阻塞 Node.js 事件循环，更适合 I/O 密集型操作；同步操作虽然简单直观，但在执行期间会阻塞整个应用，仅适用于简单、快速完成的任务。

例如，异步读取文件：

// 回调形式
fs.readFile('/path/to/file.txt', 'utf-8', (err, data) => {
  // ...
});

// Promise形式（推荐在较新版本的Node.js中使用）
(async () => {
  try {
    const data = await fs.promises.readFile('/path/to/file.txt', 'utf-8');
    console.log(data);
  } catch (err) {
    console.error(err);
  }
})();

同步读取文件：

try {
  const data = fs.readFileSync('/path/to/file.txt', 'utf-8');
  console.log(data);
} catch (err) {
  console.error(err);
}

结语

通过深入探讨 Electron 中 Node.js fs 模块的使用，我们详细介绍了从基本的文件读写、目录操作，到高级的文件流处理、文件权限控制等核心功能。同时强调了在实际应用中，如何利用 Promise 和 async/await 进行异步编程，以及如何遵循跨平台兼容性原则处理文件路径。此外，我们也着重指出在开发过程中应当重视用户文件访问权限、错误处理以及资源释放等最佳实践。这些关键知识和技巧无疑将助力广大开发者更好地利用 Electron 和 Node.js 构建功能完善、性能优良的跨平台桌面应用。