【typora序列号】 深入解析Typora插件json_rpc的使用与实现

概述

Typora插件json_rpc是一个基于JSON-RPC 2.0协议的远程过程调用插件，它允许开发者通过HTTP请求从外部程序调用Typora内部的功能。这个插件为Typora提供了强大的扩展能力，使得批量操作和自动化处理Markdown文件成为可能。

核心功能

json_rpc插件主要提供两个核心方法：

1. callPluginFunction：调用Typora插件的特定功能

   • 参数格式：(fixedName, functionName, ...args)
   • fixedName：插件名称
   • functionName：插件中的方法名
   • args：方法参数

2. eval：直接执行JavaScript代码

实现原理

json_rpc插件本质上是一个通信层，它接收外部发送的请求，然后将这些请求转发给Typora的eval函数执行。这种设计使得开发者可以：

• 调用现有插件的功能
• 执行自定义JavaScript代码
• 实现复杂的批量操作

使用示例

Python调用示例

虽然文档中提到的JSONRPCClient类可能不存在，但我们可以使用requests库实现相同的功能：

import requests

def call_plugin_function(fixed_name, func_name, *args):
    payload = {
        "jsonrpc": "2.0",
        "method": "callPluginFunction",
        "params": [fixed_name, func_name, *args],
        "id": 1
    }
    response = requests.post('http://localhost:5080', json=payload)
    return response.json()

# 调用go_top插件的goBottom方法
call_plugin_function("go_top", "goBottom")

Node.js调用示例

值得注意的是，使用Node.js调用RPC的速度明显快于Python：

const fetch = require('node-fetch');

async function evalTypora(code) {
    const response = await fetch('http://localhost:5080', {
        method: 'POST',
        headers: {'Content-Type': 'application/json'},
        body: JSON.stringify({
            jsonrpc: "2.0",
            method: "eval",
            params: [code],
            id: 1
        })
    });
    return response.json();
}

// 执行JavaScript代码
evalTypora("File.editor.selection.jumpBottom()");

高级应用

通过json_rpc插件，开发者可以实现以下高级功能：

1. 批量搜索替换：结合search_multi插件，实现跨文件搜索替换
2. 文件操作：通过JavaScript API操作Typora当前打开的文件
3. 自定义快捷键：动态绑定自定义快捷键组合
4. 自动化处理：实现Markdown文档的批量格式化

性能优化建议

1. 优先使用Node.js而非Python进行调用
2. 合并多个操作为一个请求，减少网络开销
3. 对于复杂操作，考虑编写专门的插件而非完全依赖RPC

总结

Typora的json_rpc插件为开发者提供了强大的扩展能力，使得Typora不再仅仅是一个Markdown编辑器，而成为了一个可编程的文档处理平台。通过合理利用这个插件，开发者可以实现各种复杂的文档处理自动化流程，大大提高工作效率。