首页
/ Shiki.js 内存泄漏问题解析与解决方案

Shiki.js 内存泄漏问题解析与解决方案

2025-05-20 23:19:07作者:裘晴惠Vivianne

问题现象

在使用 Shiki.js 进行代码高亮渲染时,特别是在 Next.js 14 应用中使用 React Server Components 的场景下,系统会出现间歇性崩溃。错误表现为 TypeError: onigBinding.UTF8ToString is not a function,通常发生在处理多个并行请求或长时间运行后。

根本原因分析

经过深入调查,发现这个问题由两个核心因素导致:

  1. WASM 内存管理异常:当内存分配失败时,错误处理代码尝试调用 UTF8ToString 方法,但此时该方法已不可用,导致程序崩溃。

  2. 高频调用 getHighlighter:许多开发者会在每次渲染时都创建新的高亮器实例,这会导致内存持续增长,最终触发 WASM 内存越界错误。

技术细节

Shiki.js 底层使用 WebAssembly(wasm)来实现高性能语法分析。WASM 的内存管理有其特殊性:

  • 内存分配是手动管理的
  • 内存一旦分配就不会自动回收
  • 频繁创建高亮器实例会导致内存碎片化

当内存不足时,系统会抛出异常,但错误处理机制本身又依赖已失效的内存,形成恶性循环。

解决方案

1. 单例模式使用高亮器

最佳实践是在应用初始化时创建高亮器实例,并重复使用:

// 全局或模块级缓存
let highlighter: Highlighter | null = null

async function getCachedHighlighter() {
  if (!highlighter) {
    highlighter = await getHighlighter({
      themes: ['dark-plus'],
      langs: ['javascript', 'typescript']
    })
  }
  return highlighter
}

2. 显式释放资源

从 v1.8 版本开始,Shiki 提供了 dispose 方法主动释放内存:

const highlighter = await getHighlighter({...})
// 使用完成后
highlighter.dispose()

3. 分批处理大量文件

当需要处理大量文件时,建议:

  • 将文件分成多个批次
  • 每批处理完成后调用 dispose
  • 或者为每批启动独立的进程

框架集成建议

Next.js 最佳实践

// lib/shiki.ts
import { getHighlighter } from 'shiki'

let highlighter: Awaited<ReturnType<typeof getHighlighter>>

export async function highlight(code: string, lang: string) {
  if (!highlighter) {
    highlighter = await getHighlighter({
      themes: ['github-dark'],
      langs: [lang]
    })
  }
  return highlighter.codeToHtml(code, { lang })
}

Nuxt/MDC 集成

通过创建插件来管理高亮器生命周期:

// plugins/shiki.ts
export default defineNuxtPlugin(async () => {
  const highlighter = await getHighlighter({...})
  
  return {
    provide: {
      shiki: highlighter
    }
  }
})

版本升级建议

建议所有用户升级到 Shiki v1.8 或更高版本,该版本包含:

  • 更健壮的错误处理机制
  • 内存泄漏修复
  • 显式的资源释放API

总结

Shiki.js 作为优秀的代码高亮解决方案,其性能表现卓越,但在 WASM 内存管理方面需要开发者特别注意。通过采用单例模式、合理控制生命周期和及时升级版本,可以有效避免内存泄漏问题,保证应用的稳定性。对于服务端渲染场景,尤其要注意高亮器实例的复用,这是保证性能的关键所在。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
24
7
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
376
3.26 K
flutter_flutterflutter_flutter
暂无简介
Dart
621
140
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
62
19
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.03 K
479
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
647
263
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.1 K
619
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
791
77