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

在基于 Next.js 的应用中集成 highlight.js 代码高亮功能时，开发者可能会遇到一个典型问题：当配合 CKEditor 等富文本编辑器使用时，代码块首次加载时未被正确高亮，而页面路由切换后却能正常显示。这种现象往往伴随着控制台警告："Element previously highlighted. To highlight again, first unset dataset.highlighted"。

问题本质

该问题的核心在于 highlight.js 的高亮标记机制与 React 的渲染特性之间的交互冲突。highlight.js 会在处理代码块后为其添加 data-highlighted="yes" 的 DOM 属性作为标记，而 React 18 的严格模式(Strict Mode)在开发环境下会故意执行双重渲染以检测副作用。这种机制导致以下连锁反应：

1. 首次渲染时 highlight.js 正常执行代码高亮
2. React 严格模式的二次渲染保留了 data-highlighted 标记
3. 后续的高亮尝试因检测到标记而拒绝重复执行

技术细节剖析

在 Next.js 的 SSR 环境中，问题会表现得更加复杂。当代码块在服务端已被部分处理时，客户端 hydration 过程可能导致高亮状态不一致。开发者常见的错误模式包括：

• 在 useEffect 中直接调用 highlightElement 而不检查高亮状态
• 未正确处理服务端渲染与客户端渲染的差异
• 忽略了 React 严格模式对 DOM 操作的影响

解决方案

对于 Next.js 项目，推荐采用以下优化方案：

1. 高亮状态重置
   在执行高亮前主动清除现有标记：

   codeBlocks?.forEach(block => {
     delete block.dataset.highlighted;
     hljs.highlightElement(block);
   });
   

2. 渲染模式适配
   针对开发环境特别处理严格模式：

   useEffect(() => {
     const handler = () => {
       document.querySelectorAll('pre code').forEach(block => {
         if (process.env.NODE_ENV === 'development') {
           delete block.dataset.highlighted;
         }
         hljs.highlightElement(block);
       });
     };
     
     const timer = setTimeout(handler, 100); // 延迟确保DOM稳定
     return () => clearTimeout(timer);
   }, [content]);
   

3. 服务端渲染协调
   对于 SSR 场景，建议在客户端完成所有高亮操作，避免服务端与客户端渲染结果不一致。

最佳实践建议

1. 对于动态内容编辑器（如 CKEditor），应在内容变化时重新触发高亮逻辑
2. 考虑使用 requestAnimationFrame 或微任务延迟高亮执行，确保 DOM 完全就绪
3. 在复杂应用中，可封装高阶组件统一管理代码高亮生命周期
4. 生产环境建议保留 React 严格模式，仅针对高亮逻辑做特殊处理

通过理解 highlight.js 的工作原理与 React 渲染机制的交互特点，开发者可以构建出更健壮的代码高亮解决方案。记住，框架的严格模式是有价值的开发辅助工具，正确的做法是适配而非禁用这些安全特性。