在 React 中渲染列表项时,很多开发者喜欢使用 index 作为 key 值,例如:
{
todos.map((todo, index) => (
))
}
这段代码看起来没什么问题,也可以去掉烦人的警告(当我们不传递 key 值时,React会默认使用 index 作为 key 值,并且会进行警告,如果你手动指定 index 作为 key 值,React 会认为,你知道自己在干嘛)。但是这其中存在潜在的危险性,并且可能显示的错误的数据。
我来解释一下为什么会这样
key 值是 React 用来判断 DOM 元素的唯一依据。当我们尝试向列表中添加、删除一项数据的时候会发生什么?如果 key 值和之前的相同,React 会假设这是同一个组件。
看一下下面这个例子,这段代码要实现的功能是点击 增加 按钮时在表单顶部增加一个文本框。
class Item extends React.Component {
render() {
return (
{this.props.name}
)
}
}
class Example extends React.Component {
constructor(props) {
super(props);
this.state = {
list: []
};
}
addItem() {
const id = +new Date;
this.setState({
list: [ {name: 'Baz' + id, id} , ...this.state.list]
});
}
render() {
return (
添加
错误 key=index
{this.state.list.map((todo, index) =>
)}
正确 key=id
{this.state.list.map((todo) =>
)}
)
}
}
React.render(, document.getElementById('app'))
我们先点击添加按钮,在文本框中输入一些测试值。然后再点击一次添加按钮,在列表顶部添加一个空的文本框,这时候你就会发现问题所在了。 由于我们错误的使用 index 作为 key 值,React 在渲染 list 列表时,会假定 key = 0 就是我们之前添加的第一个文本框,于是错误的将第一次输入的内容渲染到了我们新添加的文本框上。
React.png
解决方案
使用唯一 id 作为 key 值。如果你的数据项有 id 并且是唯一的,就使用 id 作为 key。如果没有,可以设置一个全局变量来保证 id 的唯一性
class Example extends React.Component {
this.listCounter = 1
/// ...
addItem() {
const id = this.listCounter++;
this.setState({
list: [ {name: 'Baz' + id, id} , ...this.state.list]
});
}
render () {
//...
}
}
在实际生产环境中,一般使用第三方库来生成唯一 id
const shortid = require('shortid');
// ...
addItem() {
const id = shortid.generate();
this.setState({
list: [ {name: 'Baz' + id, id} , ...this.state.list]
});
}
//...
例外
虽然不建议,但是在以下场景中可以使用 index 作为 key 值
列表和项目时静态的,不会进行计算也不会背改变
列表中的项目没有ID
列表永远不会被重新排序或过滤
当符合这三个条件时,可以使用 index 作为 key 值