React中useEffect使用Chart.js时反复生成新图表实例的异常问题
问题根因定位
- 触发问题的核心是React 18开发模式下StrictMode的双调用机制:组件首次挂载时,框架会模拟「挂载→卸载→重挂载」流程校验副作用的清理逻辑是否合理。现有代码的清理逻辑存在闭包失效问题,导致第一次挂载生成的id=0的空实例没有被彻底销毁,持续占用canvas渲染上下文。
- 未销毁的残留空实例会和后续新建的实例发生上下文抢占冲突,最终带数据的id=1的新实例根本无法拿到canvas的实际渲染权限,画布上显示的始终是第一次生成的空实例。这也是手动刷新页面后,JS上下文重置、全局id计数器从0开始且无残留实例时,图表就能正常显示的原因。
- 将图表实例存在useState的写法存在天然缺陷:useState的更新是异步的,useEffect清理函数捕获的
chartInstance是闭包保存的旧值,根本无法指向最新创建的实例,导致销毁逻辑完全失效。组件反复挂载卸载时,实例id会持续递增,永远存在未清理的残留实例。
可直接落地的修复方案
按以下几点调整代码即可彻底解决问题:
- 用
useRef替代useState存储图表实例:ref的修改不会触发组件重渲染,所有回调中都能拿到最新的实例引用,从根源上解决闭包捕获旧值的问题。 - 每次创建新实例前,强制销毁同canvas上的残留实例,避免上下文占用冲突。
- 补全useEffect的依赖项,避免逻辑漏触发。
- 清理函数仅操作ref中存储的当前实例,不依赖外部状态值。
调整后的核心代码片段:
import { useRef, useEffect } from 'react'; import Chartjs from 'chart.js'; // 用ref保存图表实例,替代原useState存实例的逻辑 const chartInstanceRef = useRef<Chartjs | null>(null); const chartContainer = useRef<HTMLCanvasElement>(null); useEffect(() => { const canvas = chartContainer.current; if (!canvas) return; // 每次创建新实例前,彻底清空同canvas上的残留旧实例 if (chartInstanceRef.current) { chartInstanceRef.current.destroy(); chartInstanceRef.current = null; } const newChartInstance = new Chartjs(canvas, chartConfig); removeData(newChartInstance); chartInstanceRef.current = newChartInstance; // 清理函数仅销毁当前ref存储的实例,无闭包依赖问题 return () => { if (chartInstanceRef.current) { removeData(chartInstanceRef.current); chartInstanceRef.current.destroy(); chartInstanceRef.current = null; } }; }, [chartContainer, chartConfig]); useEffect(() => { if (!delay || !chartInstanceRef.current) return; const intervalUpdate = setInterval(() => { console.log("updating"); console.log(chartInstanceRef.current); chartInstanceRef.current?.update(); }, delay); return () => clearInterval(intervalUpdate); }, [delay]); return ( <div className={styles.chartContainer}> <canvas ref={chartContainer} height={"140"}/> </div> );
避坑提示
- 不要在同一个canvas上反复创建新实例而不调用
destroy()方法:Chart.js会在画布上绑定全局渲染监听,未销毁的实例会持续占用画布上下文,哪怕视觉上无异常,也会造成内存泄漏和渲染冲突。 - 路由级别的组件显隐切换场景下,不需要额外添加实例重置逻辑,只要保证useEffect的清理函数能正确销毁实例,组件卸载时的自动清理就足够覆盖所有场景。
内容的提问来源于stack exchange,提问作者Robolisk
相关产品推荐
相关产品推荐

