如何封装可传API ID的通用Chart.vue组件替换多个冗余组件
通用图表组件实现方案
核心改造点
- 组件新增
chartIdprops入参,接收外部传入的图表接口ID,替换原代码中硬编码的接口路径参数 - 移除canvas写死的全局id,改用Vue
ref绑定获取当前组件的canvas上下文,避免多实例同页面渲染时的DOM选择冲突 - 修正原代码中无效的图表实例销毁逻辑,将图表实例存储在组件实例属性上,在重复渲染、组件卸载时统一销毁,防止内存泄漏
- 新增props类型校验,避免无效入参导致的接口请求错误
改造后的通用Chart组件代码
<template> <div class="chart-container" style="position: relative; height: 25vh; width:100%;"> <canvas ref="chartCanvas" ></canvas> </div> </template> <script> import moment from 'moment' // 若未全局注册Chart.js,需在此显式引入 import Chart from 'chart.js' export default { name: 'BaseChart', props: { // 接收外部传入的图表API ID chartId: { type: [Number, String], required: true, validator: (val) => val !== '' && val !== null } }, data () { return { // 存储图表实例,用于后续销毁释放 chartInstance: null } }, async mounted () { await this.fetchChartData() }, beforeDestroy () { // 组件卸载时清理图表实例 if (this.chartInstance) { this.chartInstance.destroy() this.chartInstance = null } }, methods: { async fetchChartData () { try { // 动态拼接接口路径,替换原硬编码的图表ID const response = await this.$http.get(`/farfrom/chart/${this.chartId}`) const result = response.data // 从当前组件的ref中获取canvas上下文,避免全局id冲突 const ctx = this.$refs.chartCanvas.getContext('2d') // 销毁旧实例,防止重复渲染 if (this.chartInstance) { this.chartInstance.destroy() } const chartData = [] for (let i = 0; i < result.date.length; i++) { chartData.push({ x_axis: moment(result.date[i], 'X').toDate(), y_axis: result.challenge[i] }) } // 初始化图表实例 this.chartInstance = new Chart(ctx, { type: 'line', data: { datasets: [ { label: 'Chart_from_API', data: chartData, } ] }, options: { lineTension: 0, maintainAspectRatio: false, scales: { yAxes: [ { scaleLabel: { display: false }, ticks: { beginAtZero: true, callback (value) { return `${value}k` } } } ], xAxes: [ { type: 'time', time: { unit: 'month' }, scaleLabel: { display: true } } ] } } }) } catch (error) { console.log('图表数据加载失败:', error) } } } } </script>
父组件使用方式
同个页面可直接复用同一个组件,传入不同的图表ID即可渲染对应数据的图表,无需重复开发独立组件:
<template> <div class="chart-page"> <!-- 传入对应图表的ID即可 --> <BaseChart :chart-id="1" /> <BaseChart :chart-id="2" /> <BaseChart :chart-id="3" /> <BaseChart :chart-id="4" /> </div> </template> <script> import BaseChart from '@/components/BaseChart.vue' export default { components: { BaseChart } } </script>
原代码存在的隐患说明
- 写死的全局canvas id:同一页面渲染多个图表时,重复的
DisplayChartid会导致getElementById匹配到错误的DOM元素,出现图表渲染位置错乱 - 无效的实例销毁逻辑:原代码中定义的局部变量
myChart每次执行时值都是undefined,预设的销毁判断永远不会触发,容易产生冗余实例、造成内存泄漏 - 硬编码的接口参数:无法通过同一份逻辑复用渲染不同ID对应的图表数据
内容的提问来源于stack exchange,提问作者Quantum
相关产品推荐
相关产品推荐

