使用 PropTypes 进行类型检查

可以通过设置 propTypes 来对组件收到的数据进行类型检查：

import PropTypes from 'prop-types'

class Greeting extends React.Component {
  render() {
    return <h1>Hello, {this.props.name}</h1>
  }
}

Greeting.propTypes = {
  name: PropTypes.string
}

也可用于函数组件，或者是由 React.memo / React.forwardRef 创建的组件。

类型检查器使用

import PropTypes from 'prop-types'

MyComponent.propTypes = {
  // 常用类型
  optionalArray: PropTypes.array,
  optionalBool: PropTypes.bool,
  optionalFunc: PropTypes.func,
  optionalNumber: PropTypes.number,
  optionalObject: PropTypes.object,
  optionalString: PropTypes.string,
  optionalSymbol: PropTypes.symbol,

  // 任何可被渲染的元素（包括数字、字符串、元素、数组或 Fragment） 也包含这些类型
  optionalNode: PropTypes.node,

  // 一个 React 元素
  optionalElement: PropTypes.element,
  // 一个 React 元素类型（即，MyComponent）
  optionalElementType: PropTypes.elementType,

  // 你也可以声明 prop 为类的实例，这里使用 JS 的 instanceof 操作符
  optionalMessage: PropTypes.instanceOf(Message),

  // 你可以让你的 prop 只能是特定的值，指定它为枚举类型
  optionalEnum: PropTypes.oneOf(['News', 'Photos']),

  // 一个对象可以是几种类型中的任意一个类型
  optionalUnion: PropTypes.oneOfType([
    PropTypes.string,
    PropTypes.number,
    PropTypes.instanceOf(Message)
  ]),

  // 可以指定一个数组由某一类型的元素组成
  optionalArrayOf: PropTypes.arrayOf(PropTypes.number),

  // 可以指定一个对象由某一类型的值组成
  optionalObjectOf: PropTypes.objectOf(PropTypes.number),

  // 可以指定一个对象由特定的类型值组成
  optionalObjectWithShape: PropTypes.shape({
    color: PropTypes.string,
    fontSize: PropTypes.number
  }),

  // An object with warnings on extra properties
  optionalObjectWithStrictShape: PropTypes.exact({
    name: PropTypes.string,
    quantity: PropTypes.number
  }),

  // 你可以在任何 PropTypes 属性后面加上 `isRequired` ，确保
  // 这个 prop 没有被提供时，会打印警告信息
  requiredFunc: PropTypes.func.isRequired,

  // 任意类型的必需数据
  requiredAny: PropTypes.any.isRequired,

  // 你可以指定一个自定义验证器，它在验证失败时应返回一个 Error 对象
  // 请不要使用 `console.warn` 或抛出异常，因为这在 `oneOfType` 中不会起作用
  customProp: function(props, propName, componentName) {
    if (!/matchme/.test(props[propName])) {
      return new Error(
        'Invalid prop `' + propName + '` supplied to' +
        ' `' + componentName + '`. Validation failed.'
      );
    }
  },

  // 你也可以提供一个自定义的 `arrayOf` 或 `objectOf` 验证器
  // 它应该在验证失败时返回一个 Error 对象
  // 验证器将验证数组或对象中的每个值。验证器的前两个参数
  // 第一个是数组或对象本身，第二个是他们当前的键
  customArrayProp: PropTypes.arrayOf(function(propValue, key, componentName, location, propFullName) {
    if (!/matchme/.test(propValue[key])) {
      return new Error(
        'Invalid prop `' + propFullName + '` supplied to' +
        ' `' + componentName + '`. Validation failed.'
      );
    }
  })
}

限制单个元素

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

MyComponent.propTypes = {
  children: PropTypes.element.isRequired
}

Prop 默认值

Greeting.defaultProps = {
  name: 'Stranger'
}

类型检查也会检查默认值

---

参考

使用 PropTypes 进行类型检查 - React