Plugin API
简体中文
简体中文
  • 入門
    • 简介
    • 你的第一个插件
    • 文件结构概述
    • 插件类型
      • 窗口
      • 背景服務
      • 格式扩展
      • 检查器
    • 调试插件
    • 开发交流群
  • 部署
    • 准备插件
    • 打包插件
    • 发布插件
    • 更新插件
    • 开发者政策
    • 插件图标模板
  • 开发指南
    • manifest.json 完整配置
    • 取得数据
    • 修改数据
    • 存取本地文件
    • 发出网路请求
    • 使用 Node.js 原生 API
    • 使用第三方模快
    • 多国语言(i18n)
    • 无边框窗口
  • API 参考
    • event(事件)
    • item(项目)
    • folder(文件夾)
    • tag(标签)
    • tagGroup(标签群组)
    • library(资源库)
    • window(窗口)
    • app(应用)
    • os(操作系统)
    • screen(屏幕)
    • notification(通知)
    • contextMenu(右鍵菜單)
    • dialog(对话框)
    • clipboard(剪贴板)
    • drag(拖拽文件)
    • shell(壳)
    • log(日志)
  • 额外组件
    • FFmpeg
由 GitBook 提供支持
在本页
  • 使用 fs 模块存取本地文件
  • 使用原生对话框取得文件路径
  1. 开发指南

存取本地文件

我们可以很轻松地使用原生的 Node.js API 来实现存取本地文件的功能。这让我们在插件系统中实现这样的任务变得更加容易。


使用 fs 模块存取本地文件

利用 Node.js 的 fs的一系列方法来实现本地文件存取,对本地文件系统进行操作。例如,可以使用 fs.readFile() 方法来读取文件内容,使用 fs.writeFile() 方法来写入文件。这里是一个示例:

const fs = require('fs');

// 读取文件
fs.readFile('/path/to/file', (err, data) => {
  if (err) throw err;

  console.log(data);
});

// 写入文件
fs.writeFile('/path/to/file', 'hello world', (err) => {
  if (err) throw err;

  console.log('done');
});

这些方法都是异步的,所以它们不会阻塞 UI,从而可以保证应用的高性能。另外,fs 模块还提供了一些其他有用的方法,例如可以用 fs.stat() 方法来获取文件的大小、创建时间等信息,也可以用 fs.rename() 方法来重命名文件。通过使用 fs 模块,我们可以很方便地存取本地文件。

🦄 最佳实践: 尽可能不要使用 Node.js 里面的 sync 方法,这些方法会导致 UI 线程阻塞,从而导致用户界面卡顿,用户体验极差。此外,使用异步方法能够提高程序的执行效率,因为它不会阻塞程序的执行,可以同时处理多个任务。


使用原生对话框取得文件路径

Eagle Plugin API 提供了一个 dialog 模块,可以用来创建原生系统对话框,进行文件保存及选取。这里有耶些示例:

示例一:弹出文件选择对话框

let result = await eagle.dialog.showOpenDialog({
    properties: ['openFile', 'openDirectory']
});

示例二:弹出保存对话框

let result = await eagle.dialog.showSaveDialog({
    properties: ['openDirectory']
});
上一页修改数据下一页发出网路请求

最后更新于11个月前

如果你需要更详细的介绍,可以参考 。

dialog 模块