bug记录——antd table组件的key值缺失原理及解决

使用antd自带的table组件时,遇到了控制台报错,虽然是warning不影响使用,但红红的一块看起来总觉得不舒服,遂决定彻底解决这个问题:

image.png

通过控制台提示我们可以看到,问题出在“table的数据缺失key值”上。

首先,我们来明确下什么是key值:key值是react用来识别组件/元素的身份标识符

react中,每个组件/元素都拥有特定的key,相同key值的会被识别为同一个组件/元素,引起控制台报错。如下例所示:

this.state = {
 statusList: [
      {
        value:"all",
        title:"全部",
        key:"all",
      },{
        value:"0",
        title:"是",
        key:"0",
      },{
        value:"1",
        title:"否",
        key:"1",
      },{
        value:"1",
        title:"错误示例",
        key:"1",
      }
    ],
}
render () {
 return(
  <div>
    <h3>状态栏</h3>
    {this.state.statusList.map(
        item => <div key={item.key}> {item.title} </div>)}
  </div>
 )
}

在这个案例中,后两个数组元素的key相同,执行代码后果不其然报了错:


image.png

其实,react是强制要求我们用key的,但是为什么这里只报了warning而不是error呢?是因为react默认为我们取数组的index作为key。

通常情况下,只要不涉及数组的新增、删除和排序等操作,那么使用index作为key值展示数据是没有问题的,但是一旦涉及到数组的动态变更,就很容易出现问题,比如:

class App extends React.Component{
    constructor(props) {
        super(props)
        this.state = {
            list: [{id: 1,title: 'a'}, {id: 2, title: 'b'}, {id: 3, title: 'c'}]
        }
    }

    click() {
        this.state.list.reverse()
    }

    render() {
        return (
            <ul>
                <div onClick={this.click.bind(this)}>reverse</div>
                {
                    this.state.list.map(function(item, index) {
                        return (
                            <li key={index}>{item.title} <input type="text"/></li>
                        )
                    }.bind(this))
                }
            </ul>
        )
    }
}

结果出现下面这种情况(图源网络):

image.png

点击reverse之后:


image.png

这是为什么呢?

原因在于:

  • 点击reverse后,组件重新渲染得到新的虚拟dom
  • 此时react会根据自己的diff算法对新老两个虚拟dom进行比较
  • 发现key值相同后,react便会判定组件没有发生变更,componentWillReceiveProps方法不会被执行
  • 接着,react会检查key相同的组件的文本内容,发现有变化之后更改了这部分
  • 最后,react会检查组件包含的input组件,由于input组件没有发生变化,又与父组件传入的props没有关系,所以input组件也不变,就导致了这种bug的出现

因此,在选择组件的key属性时必须是唯一且稳定的,使用random随机函数生成也不好,因为数组动态改变时会导致数组元素中的每项都重新销毁然后重新创建,有一定的性能开销;另外也可能导致一些意想不到的问题出现

最好的办法是,如果数据中有指定的id值,那么就使用数据中的id属性作为唯一key值,如果没有,可以指定一个全局变量来添加稳定唯一的key值。

    class Test extends React.Component { 
    this.keyCounter = 1;
    //给数组data赋上新属性key值
    addKey(data) {
        data.map((item,index)=>{
            data[index]['key'] = this.keyCounter++;
        })
        return data;
    }
}

而在react中,Table的dataSource和columns里的数据值都需要指定 key 值。对于 dataSource 默认将每列数据的 key 属性作为唯一的标识。

好,既然原理都清楚了,那我们就回到题目上来——antd table表格的key值缺失该如何解决呢?

我列下报错的几种情况,大家按照自己的实际运行效果进行处理:

1. 设置了rowKey属性,但所指定字段的值不是唯一的:

Warning: Each child in an array or iterator should have a unique "key" prop.

2. 没有设置rowKey属性,不过设置了table的columns属性的配置中第一列的key(react所需),但key所指定字段的值不是唯一的:

Warning: Each record in table should have a uniquekeyprop,or setrowKeyto an unique primary key.

3.没有设置rowKey属性,也没有设置columns属性的配置中第一列的key(react所需)

Warning: Each record in dataSource of table should have a uniquekeyprop, or setrowKeyto an unique primary key,see [https://u.ant.design/table-row-key](https://u.ant.design/table-row-key)

此时可以通过给每一行(dataSource)和每一列(columns)设置特定的key值来解决:

let columns = [{
    key: '1',
    title: '人民币',
    dataIndex: 'title'
},{
    key: '2',
    title: '美元',
    dataIndex: 'title'
},{
    key: '3',
    title: '日元',
    dataIndex: 'title'
},{
    key: '4',
    title: '英镑',
    dataIndex: 'title'
}]

let dataSource = [{
    key: 1,
    title: 'aaaa'
},{
    key: 2,
    title: 'bbbb'
},{
    key: 3,
    title: 'cccc'
}]

<Table
    columns={columns}
    dataSource={dataSource}
/>

也可以通过上面描述的全局变量设定key值来解决!

还可以为表格添加rowKey,当然了,也必须是稳定唯一的值:

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

推荐阅读更多精彩内容