react中使用 PropTypes 进行类型检查

使用 PropTypes 进行类型检查

1.自 React v15.5 起,使用prop-types库 进行类型检查。
2.之前使用的React.PropTypes 已移入另一个包中,我们提供了一个 codemod 脚本来做自动转换。
3.详情可观看官网https://react.docschina.org/docs/typechecking-with-proptypes.html

一、前言

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

二、用法

import PropTypes from 'prop-types'

function HelloWorldComponent({ name }) {
  return (
    <div>Hello, {name}</div>
  )
}

HelloWorldComponent.propTypes = {
  name: PropTypes.string
}

export default HelloWorldComponent

三、不同验证器

1.指定属性类型

import PropTypes from 'prop-types';

.....

MyComponent.propTypes = {
  // 你可以将属性声明为 JS 原生类型，默认情况下
  // 这些属性都是可选的。
  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
  }),
}

2.指定一个自定义验证器

import PropTypes from 'prop-types';

.....

MyComponent.propTypes = {
	 // 你可以指定一个自定义验证器。它在验证失败时应返回一个 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.'
	     );
	   }
	 })
	};
}

3.属性后加isRequired必传

import PropTypes from 'prop-types';

.....

MyComponent.propTypes = {
 // 你可以在任何 PropTypes 属性后面加上 `isRequired` ，确保
  // 这个 prop 没有被提供时，会打印警告信息。
  requiredFunc: PropTypes.func.isRequired,
  // 任意类型的必需数据
  requiredAny: PropTypes.any.isRequired,
}

4.指定Props 默认值

import PropTypes from 'prop-types';

.....

MyComponent.propTypes = {
  name: PropTypes.string,
}

// 指定 props 的默认值：
MyComponent.defaultProps = {
  name: 'Stranger'
};