Highcharts从数据库获取含字符串formatter的配置如何处理?React场景下this指向异常
Highcharts 从服务端拉取的字符串形式formatter函数生效方案
问题背景
- 图表配置存储在数据库时受JSON格式限制,需要把原本的函数类型
tooltip.formatter序列化为字符串,拉取到前端后这类字符串没法被Highcharts直接识别执行 - 技术栈使用React + highcharts-react-official官方封装库
- 前期尝试方案存在this指向不匹配的问题:在useEffect中给formatter赋值自定义函数时,使用了箭头函数声明,导致函数内this和Highcharts运行时期望的上下文完全不一致,formatter逻辑无法正常运行
前期尝试的问题代码:
useEffect(() => { chartConfig.tooltip.formatter = tooltipsFormat; }, []) const tooltipsFormat = () => { return this.key + '<br/>' }
上述代码的核心问题:箭头函数不存在自身的this绑定,其this值在声明时就已经绑定到外层组件作用域,Highcharts在回调执行时无法修改箭头函数的this指向,自然拿不到函数运行所需的point、y、series等上下文属性。
正确实现逻辑
- 所有传给Highcharts的回调类配置,必须使用普通函数声明,不能使用箭头函数,这样Highcharts在执行回调时,会自动把上下文this绑定到当前tooltip的运行实例上,开发者可以直接在函数内读取需要的上下文属性
- 针对服务端返回的字符串形式函数,要做安全的格式转换,生成可被Highcharts识别的普通函数,不要使用全局
eval带来安全风险 - 转换过程做好白名单校验,仅对明确是formatter的字段做字符串转函数的操作,不执行来源不可信的代码字符串
示例代码
// 从服务端拉取的初始配置,formatter为字符串形式 let chartConfig = { chart: { type: "bar" }, tooltip: { formatter: `function () { return this.point.name + ':' + this.y; }` }, }; useEffect(() => { // 校验formatter字段类型,是字符串时做转换 if (typeof chartConfig.tooltip.formatter === 'string') { // 生成普通函数,交由Highcharts运行时绑定this chartConfig.tooltip.formatter = new Function(`return ${chartConfig.tooltip.formatter}`)(); } // 如果需要自定义formatter逻辑,必须使用普通函数声明 chartConfig.tooltip.formatter = function() { // 这里的this就是Highcharts注入的上下文 return `${this.point.name}: ${this.y}<br/>所属系列: ${this.series.name}` } }, [])
注意事项
- 不要为Highcharts配置写箭头函数形式的回调,不管是formatter、label还是其他回调场景,箭头函数的this绑定特性都会导致上下文丢失
- 字符串转函数的操作要严格做来源校验,避免把第三方返回的不可信字符串转成可执行代码,引发XSS安全问题
- highcharts-react-official会自动把传入的完整配置透传给底层Highcharts实例,只要配置里的函数是普通函数形式,不需要手动额外绑定this就能正常工作
内容的提问来源于stack exchange,提问作者jjzjx118_2
相关产品推荐
相关产品推荐

