React:渲染list时用index作为key到底对不对?

翻译自Index as a key is an anti-pattern


许多开发者在渲染一个list时使用item的index当作key

{todos.map((todo,index)=>
<Todo
    {...todo}
    key={index}
  />
)}

这看起来很优雅,而且确实消除了警告(但是产生警告真正的原因是什么呢?) 这样会不会有什么负面影响呢?

这可能使你的程序崩溃并渲染错误的数据!

key是React中用于标识DOM元素的惟一工具。如果在一个列表中间插入或删除一些数据会发生什么呢? 如果两个组件的key相同,那么React会认为DOM元素中的这两个组件也是同一个。这就开始错了。

注意: 当我使用map函数的索引参数作为映射react组件的键时,我遇到一个大问题。

state是一个对象列表,

容器组件将state的对象列表进行排序,并将其映射到小的ui组件上。

目前一切正常,但是当我向state中添加了一个新的item并重新排序映射时

React对哪些属性该映射到哪个组件感到困惑。这让我对所有我知道的React产生了疑问。

后来我改为使用uuid作为映射组件的键,一切就又正常了

为了演示潜在的问题,我创建了一个简单的示例

事实证明,当没有设置key时,React会使用index作为key,因为这是目前最好的解决办法。此外,它还会警告您,这不是最优化的解决办法。如果你自己提供一个key,React就会认为你知道你在做什么——记住这个例子——会导致不可预知的结果。

Better

每一个item都应该有一个不变且唯一的属性。理想情况下,应该在创建item时分配给它。当然,我指的就是id,我们可以使用以下方式:

{todos.map((todo)=>
<Todo {...todo}
    key={todo.id} />
)}

注意: 首先应该查看item的现有属性,可能它已经存在了可以用作id的属性

一种方法是在抽象(abstraction?)中添加一个编号。使用全局索引可以确保任意两个item具有不同的id。

todoCounter = 1;
function createNewTodo(text){
  return {
    completed: false,
    id: todoCounter++,
    text
  }
}

Much better

项目的解决方案应该是一个可以分布式创建item的更为健壮的方法,建议使用shortid,它能快速生成“简短的 不连续的 像url一样的(?) 唯一的(short non-sequential url-friendly unique?)”id。代码如下所示:

function createNewTodo(text){
  return {
    completed: false,
    id: shortid.generate(),
    text
  }
}

为每个item生成一个惟一的id,并在渲染列表时使用它作为key。

更新: 例外情况

很多人问是否所有情况都需要生成id。有些人觉得某些情况下使用index作为key是可以的。
的确,有时候生成新的id是多余的。例如翻译许可条款或贡献者列表。
为了帮助理解,我举出了这些例子的三个共同点:

1. list和item是静态的——它们不会被计算,也不会改变;
2. list中的item没有id;
3. list不会被重新排序或过滤

当同时满足以上条件时,就可以安全地使用index作为key。

更新2: React,Preact,and *react

尽管在这篇文章中我写的是React,但是这个问题并不是唯一的。在类似的库中,比如Preact,问题也依然存在,虽然可能影响不同。

参见下面的StackOverflow问题,移除最后一个元素。同时请注意《Preact》的作者Jason Miller提供的答案。

References and related articles

Dynamic ChildrenandKeyed Fragmentsin React Docs
Explanation from Paul O’Shannessy
The importance of component keys in React.js
React.js and Dynamic Children — Why the Keys are Important
React animations for a single component,sectionThe key is using key
Why you need keys for collections in ReactbyPaul Gray

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,524评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,869评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,813评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,210评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,085评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,117评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,533评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,219评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,487评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,582评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,362评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,218评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,589评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,899评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,176评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,503评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,707评论 2 335

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    X先生_未知数的X阅读 15,960评论 3 119
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,062评论 25 707
  • 不能说的话不能说的秘密压在我的心间,我好难受此刻。
    我是笑起来暖暖的爱丽丝阅读 150评论 0 1
  • (一) 空山浸雨涔 幽谷吐岚深。 浅淡风云色, 浓沉岁月纹。 (二) 层山立翠屏 静水卧青峰 笔墨云深处 人家意韵中
    向阳人家阅读 234评论 0 4