D3 data join的key怎样保持节点身份
来源:17golang原创
时间:2026-10-13 21:08:09 185浏览 收藏
我在做可排序的 D3 列表时,最容易误判的一点是:数组顺序变了,并不代表 DOM 节点必须换人。默认的 selection.data(data) 按位置匹配,插入、删除或排序后,原节点可能拿到另一条数据,于是颜色、过渡动画和节点上的临时状态看起来像“串了”。要保持节点身份,应把稳定且唯一的业务字段作为第二个参数传给 data:selection.data(data, d => d.id)。
官方地址:https://d3js.org/
- 不传 key 时按下标匹配;传入 key 函数后,D3 用返回的字符串标识匹配旧元素和新数据。
- key 必须稳定、唯一并且来自对象身份,而不是当前数组下标或会变化的展示文本。
- key 只负责身份匹配;数据顺序变化后,还要用
selection.order()或sort()调整 DOM 顺序。
先看没有 key 时节点为什么会漂移
假设列表首次渲染为 a、b、c,下一次排序变成 c、a、b。默认 data join 只看位置:第一个旧节点继续留在第一位,但它现在绑定了 c。如果这个节点之前保存了焦点、动画进度或局部交互状态,状态就会跟着位置走,而不是跟着业务对象走。

用稳定 id 让旧元素和新数据重新相认
key 函数会分别读取旧元素当前的数据和新数组中的数据,并把返回值当成匹配标识。第一次创建元素时,旧元素还没有绑定数据,因此通常要在函数里兼容“旧数据不存在”的情况;如果元素本身已经有可用的 data-id,也可以把它作为回退。
const rows = [
{ id: "c", label: "第三项", value: 30 },
{ id: "a", label: "第一项", value: 10 },
{ id: "b", label: "第二项", value: 20 }
];
const list = d3.select("#list");
// id 表示业务对象身份;不要用 index,因为排序后 index 会改变。
const joined = list.selectAll("li")
.data(rows, d => d.id)
.join(
enter => enter.append("li").attr("class", "row"),
update => update,
exit => exit.remove() // 数据中消失的 id 才进入 exit。
);
// enter 和 update 合并后的选择都能安全地更新可见内容。
joined.text(d => `${d.label}: ${d.value}`);
这里 c 原来存在于 DOM 中,即使它从第三位移动到第一位,也会继续使用原来的元素;真正新增的 id 才进入 enter,旧数据中不存在的 id 才进入 exit。这就是“保持节点身份”的核心。
key 函数要满足三个条件
第一,值要稳定:同一个业务对象在多次更新中应返回同样的 id。第二,值要唯一:同一批数据出现两个相同 key,会让重复数据进入 enter,旧元素的重复 key 则会进入 exit。第三,值要与对象身份相关:姓名、排序位置或格式化后的文本通常不适合作为唯一标识,因为它们可能被修改或重复。

如果元素首次进入时没有旧 datum,可以使用元素属性回退,但要避免让新数据和旧元素得到两套不一致的规则:
const selection = svg.selectAll("circle")
.data(points, function (d) {
// 旧元素可能没有 d;首次绑定时用 DOM 上的 data-id 兜底。
return d ? d.id : this.getAttribute("data-id");
})
.join("circle")
.attr("data-id", d => d.id)
.attr("cx", d => d.x)
.attr("cy", d => d.y);
// key 只解决身份匹配;顺序调整交给 order,避免把两件事混在一起。
selection.order();
身份稳定后仍要处理顺序和边界
key 函数不等于排序函数。D3 文档说明,使用 key 后,update 和 enter 选择按数据顺序返回,但 DOM 中已有元素的顺序可能还保留原样;需要让视觉顺序跟随数据时,再显式调用 order() 或 sort()。这一步尤其重要于 SVG 图例、可排序列表和带过渡的散点图。
| 场景 | 建议 | 原因 |
|---|---|---|
| 数组重新排序 | 保留稳定 key,再调用 order/sort | 身份和显示顺序是两个问题 |
| 重复 id | 先修复数据唯一性 | 重复 key 会分别进入 enter 或 exit |
| id 会变化 | 引入不随展示修改的内部标识 | 可编辑 label 不应承担身份职责 |
| 多个父节点分组 | 按组返回 data,并确认 key 的作用域 | selection 的 data 按 group 处理 |
最后用一个判断确认是否选对了 key
更新前先记录某个 DOM 节点与业务 id 的关系,再交换数据顺序。如果同一个 id 仍然落在同一个节点对象上,说明身份匹配成功;如果只是文字变了但节点对象没有复用,通常是 key 不稳定、重复,或选择范围已经换了。实际项目里,把 id 作为数据契约的一部分,并把 order() 单独放在排序逻辑之后,最容易维护。
常见问题
key 可以直接用数组下标吗? 不建议。只有数据永远不插入、不删除、不排序时,下标才可能暂时等价于身份;可变列表应使用稳定 id。
key 相同会怎样? D3 会把重复的旧元素放入 exit,把重复的新数据放入 enter,因此应先修复数据唯一性,而不是依赖 join 猜测。
key 能自动改变 DOM 顺序吗? 不能把它当作排序 API。匹配完成后,按需要调用 selection.order() 或 selection.sort()。
-
130 收藏
-
414 收藏
-
163 收藏
-
137 收藏
-
160 收藏
-
271 收藏
-
308 收藏
-
130 收藏
-
297 收藏
-
281 收藏
-
191 收藏
-
367 收藏
-
241 收藏
-
390 收藏
-
429 收藏
-
327 收藏
-
文章 · 前端 | 11小时前 | 前端 · javascript · SyntaxError Web Components customElements.whenDefined Custom Elements 自定义元素名称223 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习