emacs-lsp-booster

emacs-lsp-booster

Emacs LSP模式性能优化工具 提升代码编辑体验

emacs-lsp-booster是一款为Emacs LSP模式开发的性能优化工具。它通过封装LSP服务器程序,将JSON消息转换为Elisp字节码,并采用多线程处理读写操作,大幅提升了lsp-mode和eglot的运行速度。这个项目不需要修改Emacs源代码,安装配置简单,为开发者提供了便捷的LSP性能优化解决方案。

LSPEmacs性能优化JSON解析插件Github开源项目

Emacs LSP 性能加速器

构建和测试状态 发布状态

使用包装器可执行文件提高 lsp-modeeglot 的性能。

背景和前期工作

(非常感谢 @yyoncho 维护 lsp-mode 并给予我这个项目的灵感)

根据 yyoncho 的说法,lsp-mode(eglot 也基本相同)存在几个性能问题:

  1. Emacs 中的 Json 解析速度慢
  2. 当缓冲区已满时,服务器可能会在向 Emacs 发送数据时阻塞,因为 Emacs 消耗数据的速度太慢
  3. 同样,Emacs 在尝试向服务器发送数据时可能会阻塞(从而阻塞 Emacs 用户界面),因为服务器可能正忙

@yyoncho 尝试通过实现 Emacs 的 原生异步非阻塞 jsonrpc 分支来解决这些问题。性能方面的结果非常好。然而,这需要修改 Emacs 源代码,而且这些更改似乎不太可能被合并到上游。此外,这可能难以维护,因为它还需要 lsp-mode 中的单独代码路径(我自己遇到了一些 问题)。

本项目的工作原理

本项目提供了一个 LSP 服务器程序的包装器可执行文件,以解决上述问题:

  • 它以高速将服务器的 json 消息直接转换为 elisp 字节码(以文本表示形式),供 Emacs 读取。
    • 例如,{"objs":[{"a":1},{"a":2}]} 会被转换为 #[0 "\301\302\300\303D\300\304D\"D\207" [:a :objs vector 1 2] 13]
    • 这将大型 json 对象的消息解析性能提高了约 4 倍;请参阅 此处 的基准测试结果
    • 尽管 Emacs 仍需要解析文本表示并将其解释为 elisp 对象,性能提升主要来自以下几点:
      • 在 Emacs 中解析(read)elisp 对象显然经过了更好的优化,且更简单
      • 通过使用字节码构造对象,我们可以消除重复的对象(例如上例中的 "a" json 键)
  • 它将读写分离到不同的线程中,并在每个线程的内部缓冲区中保留待处理的消息,以避免 IO 阻塞。这解决了上述第 (2) 和第 (3) 个问题。

总的来说,这种 LSP 服务器包装器 策略实现了与原生异步非阻塞 jsonrpc 方法类似的结果,而无需修改 Emacs 源代码。

[!重要]
目前只能包装通过标准输入/输出通信的本地 LSP 服务器程序,不支持通过网络端口(本地或远程)通信的服务器。

如何使用

通常,您需要做的是:

  1. emacs-lsp-booster 可执行文件包装您的 LSP 服务器命令。 例如,如果原始 LSP 服务器命令是 pyright-langserver --stdio,则将 lsp-mode 或 eglot 配置为运行 emacs-lsp-booster [flags --] pyright-langserver --stdio
  2. 修改或更新 lsp-modeeglot 中的 json 解析函数,以在解析为 json 之前解析任何看到的字节码输入。

请参阅下面更详细的配置步骤。

获取或构建 emacs-lsp-booster

Linux 或 Windows 用户可以从 release 页面下载预构建的二进制文件。 (release 页面中的 macOS 二进制文件目前缺乏适当的代码签名。) nix 用户可以使用 这里 提供的 flake。

或者,您也可以在本地构建目标:

  1. 设置 Rust 工具链
  2. 运行 cargo build --release
  3. target/release/emacs-lsp-booster 找到构建好的二进制文件

然后,将 emacs-lsp-booster 二进制文件放入您的 $PATH 中(例如 ~/.local/bin)。

配置 lsp-mode

[!注意]
确保不要使用 Emacs 的 native-jsonrpc 自定义版本

  1. 对 lsp-mode 使用 plist 进行反序列化
  2. 将以下代码添加到您的 init.el 中:
(defun lsp-booster--advice-json-parse (old-fn &rest args) "尝试解析字节码而不是 json。" (or (when (equal (following-char) ?#) (let ((bytecode (read (current-buffer)))) (when (byte-code-function-p bytecode) (funcall bytecode)))) (apply old-fn args))) (advice-add (if (progn (require 'json) (fboundp 'json-parse-buffer)) 'json-parse-buffer 'json-read) :around #'lsp-booster--advice-json-parse) (defun lsp-booster--advice-final-command (old-fn cmd &optional test?) "在 lsp CMD 前添加 emacs-lsp-booster 命令。" (let ((orig-result (funcall old-fn cmd test?))) (if (and (not test?) ;; 用于检查 lsp-server-present? (not (file-remote-p default-directory)) ;; 参见 lsp-resolve-final-command,它会添加额外的 shell 包装器 lsp-use-plists (not (functionp 'json-rpc-connection)) ;; 原生 json-rpc (executable-find "emacs-lsp-booster")) (progn (when-let ((command-from-exec-path (executable-find (car orig-result)))) ;; 从 exec-path 解析命令(以防在 $PATH 中未找到) (setcar orig-result command-from-exec-path)) (message "为 %s 使用 emacs-lsp-booster!" orig-result) (cons "emacs-lsp-booster" orig-result)) orig-result))) (advice-add 'lsp-resolve-final-command :around #'lsp-booster--advice-final-command)

完成!现在像往常一样使用 lsp-mode。

配置 eglot

有关配置 eglot 的信息,请参阅 https://github.com/jdtsmith/eglot-booster。 非常感谢 @jdtsmith

如何验证它正在工作

  1. 检查 emacs-lsp-booster 进程是否正在运行
  2. 检查 stderr 缓冲区(例如,对于 lsp-mode,是 *pyright::stderr* 缓冲区;对于 eglot,是 EGLOT (...) stderr* 缓冲区,注意前导空格);它应该包含 emacs_lsp_booster 相关的日志。

高级用法

运行 emacs-lsp-booster --help 以获取更多选项。

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI助手AI工具AI写作工具AI辅助写作蛙蛙写作学术助手办公助手营销助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

热门AI工具生产力协作转型TraeAI IDE
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

聊天机器人AI助手热门AI工具AI对话
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

热门AI工具AI办公办公工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

模型训练热门AI工具内容创作智能问答AI开发讯飞星火大模型多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

AI助手热门AI工具AI创作AI辅助写作讯飞绘文内容运营个性化文章多平台分发
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多