Joplin插件API如何导入XML格式的笔记数据

Joplin插件无法直接导入XML笔记数据,因其沙箱环境禁用fs/XMLHttpRequest等模块且无文件读取权限;必须先将XML转为ENEX/JEX等支持格式,再通过joplin.commands.execute('import', path)调用主进程导入。

Joplin插件无法直接导入 XML 笔记数据

Joplin 的官方插件 API(joplin.plugins.register 等)不提供任何内置函数用于解析或导入 XML 格式的笔记。插件运行在受限的沙箱环境里,没有文件系统读取权限(fs 模块不可用),也无法调用 Joplin 主进程的导入逻辑(如 joplin.commands.execute('import', ...) 不接受 XML 路径或内容)。

XML 导入必须走主进程命令 + 外部转换

真正可行的路径是:先将 XML 转为 Joplin 支持的格式(如 JEX、ENEX 或 Markdown + 资源目录),再通过 joplin.commands.execute('import', path) 触发主进程导入。插件本身只能负责「准备转换后的文件」和「调用命令」,不能做 XML 解析。

  • XML 结构需明确:是自定义格式?还是 Evernote ENEX 导出的 XML?后者可直接用 import 命令导入(Joplin 原生支持 ENEX)
  • 若为自定义 XML,必须在插件外用 Node.js/Python 脚本完成解析 → 生成标准 ENEX 或 JEX 文件 → 再由插件调用导入
  • joplin.commands.execute('import', '/path/to/file.enex') 是唯一可靠入口,路径必须是绝对路径且文件已存在
  • 插件中无法使用 require('fs')fetch() 读本地文件,所以 XML 文件不能从插件内“加载”

插件中调用 import 命令的最小可行示例

假设你已用外部脚本把 notes.xml 转成了 output.enex,并放在用户文档目录下:

const { app } = require('@joplin/lib/joplin');
const path = require('path');

// 获取用户文档目录(安全路径)
const docsDir = await app().userDataDir();
const enexPath = path.join(docsDir, 'output.enex');

// 触发导入(注意:此命令异步,无返回值,失败时仅在日志中报错)
await joplin.commands.execute('import', enexPath);

⚠️ 常见失败点:enexPath 路径不存在、权限不足、XML 转 ENEX 时未正确闭合 标签导致 ENEX 格式错误、Joplin 未启用 ENEX 导入支持(需确认设置中

“Import format” 包含 Evernote)。

为什么不能在插件里解析 XML?

因为 Joplin 插件 API 的 JavaScript 运行时(基于 Electron 渲染进程)默认禁用 XMLHttpRequestfschild_process 等关键模块,且 DOM 接口(如 DOMParser)虽可用,但无法读取本地文件内容——插件没有 file:// 访问权限,也无法弹出文件选择框获取真实路径(joplin.views.dialogs.showOpenDialog 返回的是安全封装后的对象,不暴露原始路径)。

真正需要解析 XML 的环节,必须脱离插件,在用户本地手动运行一次转换脚本,或者用 Joplin CLI(joplin --log-level 4)配合外部工具链完成。