highlight.js 在 Next.js 与 CKEditor 集成中的重复高亮问题解析

在 Next.js 项目中集成 highlight.js 进行代码高亮时，开发者可能会遇到一个典型问题：页面刷新后代码高亮失效，但路由跳转后却能正常显示。这种现象背后涉及多个技术层面的交互，需要从框架特性、生命周期和高亮机制三个维度来理解。

核心问题现象

当开发者使用 React 的 useEffect 配合 highlight.js 的 highlightElement 方法时，控制台会出现警告："Element previously highlighted. To highlight again, first unset dataset.highlighted"。这表明高亮操作被重复执行，而 highlight.js 的防重复机制阻止了二次高亮。

技术原理深度解析

1. highlight.js 的高亮标记机制
   该库通过给 DOM 元素的 dataset.highlighted 属性赋值为 "yes" 来标记已高亮状态。这是一种优化设计，避免重复解析相同的代码块。

2. React StrictMode 的副作用
   在开发环境下，React 18 的严格模式会故意执行两次渲染周期以检测副作用。这导致 highlightElement 被调用两次，第一次调用后设置的 dataset.highlighted 属性会阻止第二次执行。

3. Next.js 的混合渲染特性
   服务端渲染(SSR)时生成的静态 HTML 可能已包含高亮标记，当客户端 hydration 阶段再次尝试高亮时就会触发冲突。这解释了为何刷新页面时高亮失效（服务端结果被保留），而客户端导航时能正常高亮（纯客户端渲染）。

解决方案与最佳实践

1. 清除高亮标记
   在执行高亮前手动移除标记：

   useEffect(() => {
     const blocks = contentRef.current?.querySelectorAll('pre code');
     blocks?.forEach(block => {
       delete block.dataset.highlighted;
       hljs.highlightElement(block);
     });
   }, [content]);
   

2. 条件性高亮策略
   通过检查元素是否已包含高亮类名来避免重复操作：

   if (!block.classList.contains('hljs')) {
     hljs.highlightElement(block);
   }
   

3. 框架适配方案

   • 对于 Next.js：建议在客户端动态导入 highlight.js
   • 对于 CKEditor 内容：确保编辑器输出的是原始代码块，而非预高亮的 HTML

扩展思考

这个问题揭示了前端领域一个典型挑战：当静态渲染（SSR）与动态交互（CSR）结合时，如何协调两者的状态一致性。类似的模式也出现在其他需要客户端增强功能的场景中，如数学公式渲染、图表初始化等。理解这种渲染边界的划分，是构建现代化 Web 应用的关键技能。

通过这个案例，开发者可以更深入地掌握前端框架与第三方库的集成技巧，特别是在处理需要 DOM 操作的场景时，考虑生命周期和状态同步的重要性。