• 使用 PropTypes 进行类型检查
    • PropTypes
    • 限制单个元素
    • 默认 Prop 值

    使用 PropTypes 进行类型检查

    注意:

    自 React v15.5 起,React.PropTypes 已移入另一个包中。请使用 prop-types 库 代替。

    我们提供了一个 codemod 脚本来做自动转换。

    随着你的应用程序不断增长,你可以通过类型检查捕获大量错误。对于某些应用程序来说,你可以使用 Flow 或 TypeScript 等 JavaScript 扩展来对整个应用程序做类型检查。但即使你不使用这些扩展,React 也内置了一些类型检查的功能。要在组件的 props 上进行类型检查,你只需配置特定的 propTypes 属性:

    1. import PropTypes from 'prop-types';
    2. class Greeting extends React.Component {
    3. render() {
    4. return (
    5. <h1>Hello, {this.props.name}</h1>
    6. );
    7. }
    8. }
    9. Greeting.propTypes = {
    10. name: PropTypes.string
    11. };

    PropTypes 提供一系列验证器,可用于确保组件接收到的数据类型是有效的。在本例中, 我们使用了 PropTypes.string。当传入的 prop 值类型不正确时,JavaScript 控制台将会显示警告。出于性能方面的考虑,propTypes 仅在开发模式下进行检查。

    PropTypes

    以下提供了使用不同验证器的例子:

    1. import PropTypes from 'prop-types';
    2. MyComponent.propTypes = {
    3. // 你可以将属性声明为 JS 原生类型,默认情况下
    4. // 这些属性都是可选的。
    5. optionalArray: PropTypes.array,
    6. optionalBool: PropTypes.bool,
    7. optionalFunc: PropTypes.func,
    8. optionalNumber: PropTypes.number,
    9. optionalObject: PropTypes.object,
    10. optionalString: PropTypes.string,
    11. optionalSymbol: PropTypes.symbol,
    12. // 任何可被渲染的元素(包括数字、字符串、元素或数组)
    13. // (或 Fragment) 也包含这些类型。
    14. optionalNode: PropTypes.node,
    15. // 一个 React 元素。
    16. optionalElement: PropTypes.element,
    17. // 一个 React 元素类型(即,MyComponent)。
    18. optionalElementType: PropTypes.elementType,
    19. // 你也可以声明 prop 为类的实例,这里使用
    20. // JS 的 instanceof 操作符。
    21. optionalMessage: PropTypes.instanceOf(Message),
    22. // 你可以让你的 prop 只能是特定的值,指定它为
    23. // 枚举类型。
    24. optionalEnum: PropTypes.oneOf(['News', 'Photos']),
    25. // 一个对象可以是几种类型中的任意一个类型
    26. optionalUnion: PropTypes.oneOfType([
    27. PropTypes.string,
    28. PropTypes.number,
    29. PropTypes.instanceOf(Message)
    30. ]),
    31. // 可以指定一个数组由某一类型的元素组成
    32. optionalArrayOf: PropTypes.arrayOf(PropTypes.number),
    33. // 可以指定一个对象由某一类型的值组成
    34. optionalObjectOf: PropTypes.objectOf(PropTypes.number),
    35. // 可以指定一个对象由特定的类型值组成
    36. optionalObjectWithShape: PropTypes.shape({
    37. color: PropTypes.string,
    38. fontSize: PropTypes.number
    39. }),
    40. // An object with warnings on extra properties
    41. optionalObjectWithStrictShape: PropTypes.exact({
    42. name: PropTypes.string,
    43. quantity: PropTypes.number
    44. }),
    45. // 你可以在任何 PropTypes 属性后面加上 `isRequired` ,确保
    46. // 这个 prop 没有被提供时,会打印警告信息。
    47. requiredFunc: PropTypes.func.isRequired,
    48. // 任意类型的数据
    49. requiredAny: PropTypes.any.isRequired,
    50. // 你可以指定一个自定义验证器。它在验证失败时应返回一个 Error 对象。
    51. // 请不要使用 `console.warn` 或抛出异常,因为这在 `onOfType` 中不会起作用。
    52. customProp: function(props, propName, componentName) {
    53. if (!/matchme/.test(props[propName])) {
    54. return new Error(
    55. 'Invalid prop `' + propName + '` supplied to' +
    56. ' `' + componentName + '`. Validation failed.'
    57. );
    58. }
    59. },
    60. // 你也可以提供一个自定义的 `arrayOf` 或 `objectOf` 验证器。
    61. // 它应该在验证失败时返回一个 Error 对象。
    62. // 验证器将验证数组或对象中的每个值。验证器的前两个参数
    63. // 第一个是数组或对象本身
    64. // 第二个是他们当前的键。
    65. customArrayProp: PropTypes.arrayOf(function(propValue, key, componentName, location, propFullName) {
    66. if (!/matchme/.test(propValue[key])) {
    67. return new Error(
    68. 'Invalid prop `' + propFullName + '` supplied to' +
    69. ' `' + componentName + '`. Validation failed.'
    70. );
    71. }
    72. })
    73. };

    限制单个元素

    你可以通过 PropTypes.element 来确保传递给组件的 children 中只包含一个元素。

    1. import PropTypes from 'prop-types';
    2. class MyComponent extends React.Component {
    3. render() {
    4. // 这必须只有一个元素,否则控制台会打印警告。
    5. const children = this.props.children;
    6. return (
    7. <div>
    8. {children}
    9. </div>
    10. );
    11. }
    12. }
    13. MyComponent.propTypes = {
    14. children: PropTypes.element.isRequired
    15. };

    默认 Prop 值

    您可以通过配置特定的 defaultProps 属性来定义 props 的默认值:

    1. class Greeting extends React.Component {
    2. render() {
    3. return (
    4. <h1>Hello, {this.props.name}</h1>
    5. );
    6. }
    7. }
    8. // 指定 props 的默认值:
    9. Greeting.defaultProps = {
    10. name: 'Stranger'
    11. };
    12. // 渲染出 "Hello, Stranger":
    13. ReactDOM.render(
    14. <Greeting />,
    15. document.getElementById('example')
    16. );

    如果你正在使用像 transform-class-properties 的 Babel 转换工具,你也可以在 React 组件类中声明 defaultProps 作为静态属性。此语法提案还没有最终确定,需要进行编译后才能在浏览器中运行。要了解更多信息,请查阅 class fields proposal。

    1. class Greeting extends React.Component {
    2. static defaultProps = {
    3. name: 'stranger'
    4. }
    5. render() {
    6. return (
    7. <div>Hello, {this.props.name}</div>
    8. )
    9. }
    10. }

    defaultProps 用于确保 this.props.name 在父组件没有指定其值时,有一个默认值。propTypes 类型检查发生在 defaultProps 赋值后,所以类型检查也适用于 defaultProps