快捷導(dǎo)航

React之echarts-for-react源碼解讀

更新時間：2022年10月15日 09:07:25 作者：肥仔John

這篇文章主要介紹了React之echarts-for-react源碼解讀,echarts-for-react的源碼非常精簡，本文將針對主要邏輯分析介紹，需要的朋友可以參考下

前言

在當(dāng)前工業(yè)4.0和智能制造的產(chǎn)業(yè)升級浪潮當(dāng)中，智慧大屏無疑是展示企業(yè)IT成果的最有效方式之一。然而其背后怎么能缺少ECharts的身影呢？對于React應(yīng)用而言，直接使用ECharts并不是最高效且優(yōu)雅的方式，而echarts-for-react則是針對React應(yīng)用對ECharts進(jìn)行輕量封裝和增強(qiáng)的工具庫。

echarts-for-react的源碼非常精簡，本文將針對主要邏輯分析介紹。

從與原生初始化對比開始

原生ECharts中我們會通過如下代碼初始化圖表實例

<div id="container" style="width: 100px; height: 100px"></div>
<script>
  const chart = echarts.init(document.getElementById('container'))
</script>

那么生成的HTML Element結(jié)構(gòu)為

<div id="container" style="width: 100px; height: 100px" _echarts_instance=".....">
  <div style="width: 100px; height: 100px;position: relative;">
    <canvas width="100" height="100"></canvas>
  </div>
</div>

其中第二層的div和canvas的寬高默認(rèn)為容器div#container的寬高，我們可以通過init入?yún)⒅付▋烧邔挾取?/p>

const chart = echarts.init(
  document.getElementById('container'), 
  null, 
  { 
    width: 300, // 可顯式指定實例寬度，單位為像素。如果傳入值為null/undefined/'auto'，則表示自動取 dom（實例容器）的寬度
    height: 300 // 可顯式指定實例高度，單位為像素。如果傳入值為null/undefined/'auto'，則表示自動取 dom（實例容器）的高度
  }
)

注意：若此時容器div#container尺寸發(fā)生變化，第二層div和canvas尺寸并不會自適應(yīng)，需要我們手工調(diào)用chart.resize()觸發(fā)。

而通過echarts-for-react上述步驟將被簡化為如下，并且生成相同的HTML Element結(jié)構(gòu)：

import ReactECharts from 'echarts-for-react'

function Demo() {
  return (
    <ReactECharts
      style={{width: 100, height: 100}} // 設(shè)置容器的寬高
      autoResize={true} // 默認(rèn)為true，自動監(jiān)測容器尺寸的變化，并調(diào)用`chart.resize()`
    />
  )
}

陷阱-默認(rèn)值height為300px

由于ReactECharts的style默認(rèn)內(nèi)置height: 300，源碼如下：

// src/core.tsx

render(): JSX.Element {
  const { style, className = '' } = this.props
  const newStyle = { height: 300, ...style }

  return (
    <div
      ref={(e: HTMLElement) => {
        this.ele = e
      }}
      style={newStyle}
      className={`echarts-for-react ${className}`}
    />
  )
}

因此通過className的方式設(shè)置容器高度時必須使用!important

<ReactECharts
  className={styles.container}
/>

// index.module.css
.container {
  height: 500px !important;
}

獲取ECharts實例

const ref = useRef()

useEffect(() => {
  const instance = ref.current.getEchartsInstance()
}, [])

<EchartsReact
  ref={ref}
/>

主邏輯源碼剖析

核心邏輯均在EChartsReactCore組件上(位于文件src/core.tsx)，特點如下：

采用PureComponent方式編寫組件以便適配所有React版本；
僅對ECharts 命令式API進(jìn)行聲明式API的封裝，并沒有將每種EChart圖表類型封裝為組件；
添加特性，監(jiān)測容器尺寸的變化，并自動調(diào)用ECharts實例的resize方法實現(xiàn)自適應(yīng)。

掛載渲染過程

在componentDidMount時調(diào)用renderNewEcharts方法執(zhí)行ECharts組件的生成邏輯；
renderNewEcharts方法內(nèi)部邏輯
通過echarts.getInstanceByDom(容器DOM元素)或echarts.init(容器DOM元素,主題,配置)獲取已有ECharts實例或生成新的ECharts實例；

通過ECharts實例的setOption方法設(shè)置或更新圖表內(nèi)容；

通過ECharts實例的showLoading或hideLoading控制圖表渲染前是否顯示加載進(jìn)度條；

將通過props onEvents配置的ECharts支持的事件處理器綁定到ECharts實例上；

觸發(fā)props onChartsReady 方法；

訂閱通過size-sensor監(jiān)測容器尺寸并自動調(diào)用ECharts實例的resize方法，實現(xiàn)圖表尺寸的自適應(yīng)。

更新渲染過程

由于render方法無論執(zhí)行多少遍，實際上僅僅有可能影響容器本身而已，對ECharts實例并沒有任何影響。因此實際影響ECharts實例的邏輯被放置到componentDidUpdate那里，這做法和react-amap中在useEffect中通過Marker等實例內(nèi)置的set方法更新狀態(tài)的原理是一致的。

若更新的props包含theme, opts或onEvents則要銷毀原來的ECharts實例，重新構(gòu)建一個新的ECharts實例，并終止更新渲染過程；否則執(zhí)行第2步。
若props中的option,notMergela,lazyUpdate,showLoading和loadingOption均沒有變化，則不更新ECharts實例；
注意：EChartsReactCore繼承PureComponent，若上述props進(jìn)行shallow equal比較為true時也不會更新ECharts實例；但這一步采用deep equal比較，來減少ECharts實例的更新。
若props中的style或className發(fā)生變化則會觸發(fā)ECharts實例的resize方法。