如何做好一个Javascript绘图渲染引擎适配器
Stephen Cui ... 2021-10-10 21:00:00 About 5 min
# 一、问题定义
一个好的适配器的原则就是当一三五需要讲人话的时候，可以讲人话，二四六讲鬼话的时候依然可以应付自如，周日可以不加班动手写文章 😄
# 1.1 什么是 Javascript 绘图引擎
能通过 Javascript 调用的可根据所提供的 API 绘制出不同图形的渲染工具，如 EChartJS 图表库，D3JS 绘图引擎，EChart 底层 ZRender 绘图引擎, AntV 系列绘图引擎等。
# 1.2 为什么要做适配器
适配器的作用就是承上启下，上可以认为是软件的业务层，中间是适配层，底层是各种图形渲染引擎。这样做的目的是，在需求分繁众多的各式各样的图形中，很难用一种引擎解决所有问题，诸如 EChartJS 这类优秀的图表库也很难覆盖所有场景，所以就需要一种兼容并蓄的“适配”层做转接，配合完成复杂的业务场景。
# 二、做好一个适配器有哪些要解决的痛点
适配的痛点就是典型的业务场景，这些通点需要在技术上找到合理的解决方案
# 2.1 如何兼容不同绘图引擎
首先来举几个例子，拿经典的 EChart 来说，EChart 在使用前需要先 Init 并传入 Mount 的 Dom 节点，然后可以使用 instance.setOption API 进行绘图属性更新，最后可以通过 intance.dispose 释放资源。
EChart 的折线图代码如下[1]：
import * as echarts from "echarts";
var chartDom = document.getElementById("main");
var myChart = echarts.init(chartDom);
var option;
option = {
xAxis: {
type: "category",
data: ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]
},
yAxis: {
type: "value"
},
series: [
{
data: [150, 230, 224, 218, 135, 147, 260],
type: "line"
}
]
};
option && myChart.setOption(option);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
接下来，我们再来看一个 D3JS 的基本折线图例子[2]。首先也是初始化 d3 实例，同时传入 Mount 的 Dom 节点#my_dataviz，异步加载完 CSV 数据源之后，直接在 d3 的 svg instance 上增加对象绘图。
<!DOCTYPE html>
<meta charset="utf-8" />
<!-- Load d3.js -->
<script src="https://d3js.org/d3.v4.js"></script>
<!-- Create a div where the graph will take place -->
<div id="my_dataviz"></div>
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
var margin = { top: 10, right: 30, bottom: 30, left: 60 },
width = 460 - margin.left - margin.right,
height = 400 - margin.top - margin.bottom;
// append the svg object to the body of the page
var svg = d3
.select("#my_dataviz")
.append("svg")
.attr("width", width + margin.left + margin.right)
.attr("height", height + margin.top + margin.bottom)
.append("g")
.attr("transform", "translate(" + margin.left + "," + margin.top + ")");
//Read the data
d3.csv(
"https://raw.githubusercontent.com/holtzy/data_to_viz/master/Example_dataset/3_TwoNumOrdered_comma.csv",
// When reading the csv, I must format variables:
function(d) {
return { date: d3.timeParse("%Y-%m-%d")(d.date), value: d.value };
},
// Now I can use this dataset:
function(data) {
// Add X axis --> it is a date format
var x = d3
.scaleTime()
.domain(
d3.extent(data, function(d) {
return d.date;
})
)
.range([0, width]);
svg
.append("g")
.attr("transform", "translate(0," + height + ")")
.call(d3.axisBottom(x));
// Add Y axis
var y = d3
.scaleLinear()
.domain([
0,
d3.max(data, function(d) {
return +d.value;
})
])
.range([height, 0]);
svg.append("g").call(d3.axisLeft(y));
// Add the line
svg
.append("path")
.datum(data)
.attr("fill", "none")
.attr("stroke", "steelblue")
.attr("stroke-width", 1.5)
.attr(
"d",
d3
.line()
.x(function(d) {
return x(d.date);
})
.y(function(d) {
return y(d.value);
})
);
}
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
从上面的两个例子不难看出，如果将图表渲染引擎当作绘图工具的话，那么适配器的职责就是转译绘画时机，绘图工具只需要适配到适配器的对应的生命周期上即可。适配器的工作完全是依赖于前端框架的生命周期调度，而底层绘图引擎则不关心前端框架的实现，从而做到前端框架和绘图引擎的解耦。
# 2.2 如何解决运行环境冲突
运行环境的冲突主要是在同一个宿主环境中，存在不兼容的多版本运行时库的依赖，例如，有些图表基于 EChart V3 与基于 V5 版本的图表不能共存的问题。
典型的解决方案有 iframe 和qiankun框架[3], iframe 依然是主流的隔离方案，而 ali 的 qiankun 则是用各种 hack 的方式模拟了 JS 沙箱机制，本质上来讲后者更灵活方便，但是需要大量的兼容方案，因为不是原生支持，一旦碰到很难解决的问题则束手无策，当然对于 iframe 的方案也有一些反对的声音[4]。
# 2.3 如何优化资源重复加载
当资源很好的通过 iframe 等方式进行隔离后，附带着的问题就是相同资源多次加载问题。如，在 iframe container1 中和 iframe container2 中都依赖了 lodash，react 等类库，解决的办法是提前进行资源预加载，减少重复请求。
典型的几种解决方案：
- 通过生成组件的方式，生成 iframe 内部的子组件，在生成的子组件的同时注入公共类库，此种方案需项目本身已加载资源类库。
- 通过浏览器请求的 cache 机制，缓存相同的网络静态资源请求，需设置 cache 策略以及过期策略[5]。
- 通过共享相同依赖的容器，使用 css 机制的 transform 或 visibility 来切换不同容器内容。
# 2.4 注入基于业务逻辑的配置
适配器的数据来源有两类：业务配置数据和绘图数据集，前者是基于业务系统的配置能力，后者同样是基于不同业务逻辑的数据获取。
借助于适配器生命周期的管理，很容易将配置数据和绘图数据传递给绘图引擎，在绘图引擎层面完成数据组装和转换。
# 总结
以上提出了一个适配器所需要完成的几个通点和解决痛点的方式，其中如有遗漏之处还请指出，欢迎共同探讨 👏。