HOWTO · React
有形状的 React Proptype 数组
了解如何使用带 shape 的 React PropTypes 数组来增强应用程序中的数据验证。本教程介绍了 PropTypes 的好处,提供代码示例,并指导你实现 PropTypes.shape() 以便更好地检测错误。立即了解如何及早发现错误并提升代码质量。
本页内容
PropTypes.arrayOf(PropTypes.shape(...)) 用于描述一个数组,其中每一项都是包含指定字段的对象。prop-types 包会在开发环境中检查组件契约;传入的 props 不符合契约时,它可以发出警告。
PropTypes 校验什么
PropTypes 声明组件所期望的类型和对象结构。它有助于说明组件接口,也能在开发过程中发现不匹配的值。这些检查会在控制台中生成警告;它们不会阻止组件渲染,也不能替代生产环境中的数据校验。
使用 PropTypes 校验对象数组
在 React 项目中安装 prop-types 包。在组件模块中通过 import PropTypes from 'prop-types' 导入它,并声明 items: PropTypes.arrayOf(PropTypes.shape({ name: PropTypes.string.isRequired, value: PropTypes.number.isRequired })).isRequired。这样会对数组中的每一项应用相同的对象结构校验。下面的简短 JavaScript 示例展示了相同的数据如何传入列表渲染器;该示例可以独立运行,而 PropTypes 声明应放在 React 组件模块中。
const items = [
{ name: 'Ada', value: 7 },
{ name: 'Lin', value: 9 },
];
function renderItems(items) {
return `<ul>${items.map((item) => `<li>${item.name}: ${item.value}</li>`).join('')}</ul>`;
}
console.log(renderItems(items));
<ul><li>Ada: 7</li><li>Lin: 9</li></ul>
在 React 组件中,使用 items prop 接收相同的数组,并通过 items.map(...) 渲染每一项;为每个渲染出的元素提供稳定的 key。示例值与声明的字段相符,因此会展示预期的列表内容。
将字段设为必填并理解警告
在声明中,items 上的 .isRequired 表示必须提供这个 prop。name 和 value 上的同一修饰符表示每个对象都应包含这两个字段,并且类型应符合声明。如果某个字段可以省略,就移除该字段上的 .isRequired;其他已声明字段仍会接受检查。如果对象中的 value 是字符串 '7' 而不是数字,该对象就不符合指定结构,因此 React 的开发检查会在控制台中发出警告。警告不会把字符串转换成数字、拒绝这个 prop,也不会阻止渲染。如果应用依赖外部数据或生产环境数据,请另行校验这些数据。
常见问题
PropTypes 会校验数组中的每一项吗?
会。PropTypes.arrayOf 会对每一项应用指定的校验器。与 PropTypes.shape 组合使用时,它会检查每个对象中指定的字段。
PropTypes.shape 本身会校验数组吗?
不会。PropTypes.shape 描述的是单个对象的字段。校验对象数组时,应使用 PropTypes.arrayOf(PropTypes.shape(...))。
在 React 中必须使用 PropTypes 吗?
不必。PropTypes 是可选的运行时检查,可以用于说明 props,并在开发过程中报告警告。它不能替代静态类型,也不能替代应用边界处的数据校验。