从零一起学react(6)---props属性验证v16.0.0

前言

在之前使用过React.PropTypes.string.isRequired，但是出错了，现在原因找到了，原来官网已经注明了：

注意: React.PropTypes 自 React v15.5 起已弃用。请使用 prop-types 库代替。

所以需要引入 prop-types 库，如下：

import PropTypes from 'prop-types'; //ES6
//
//我们之前一直使用的是<script>标签引入，可引入如下标签
<script src="https://unpkg.com/prop-types/prop-types.js"></script>
//或者
<script src="https://unpkg.com/prop-types/prop-types.min.js"></script>

简单使用

下面我们可以先敲一个例子。

class Hello extends React.Component {
  render() {
    return <h1>{this.props.message}</h1>;
  }
}
Hello.propTypes = {
  message: PropTypes.string
};
var data="hello";
// var data = 11;
ReactDOM.render(
  <Hello message={data}/>,
  document.getElementById('test')
);

这个例子在message为string类型时，没有问题，当message为其他类型（如number）时，控制台会产生如下warning。

Warning: Failed prop type: Invalid prop message of type number supplied to Hello, expected string.

我们还可以在后面加上isRequired如下：

Hello.propTypes = {
  message: PropTypes.string.isRequired
}

这样的话，如果该组件没有提供message属性，会打印警告信息。而前面的例子中，没有message属性并不会打印警告。

Warning: Failed prop type: The prop message is marked as required in Hello, but its value is undefined.

所有验证器

下面是react官网所有的验证器的例子：

MyComponent.propTypes = {
  // 你可以将属性声明为以下 JS 原生类型
  optionalArray: PropTypes.array,
  optionalBool: PropTypes.bool,
  optionalFunc: PropTypes.func,
  optionalNumber: PropTypes.number,
  optionalObject: PropTypes.object,
  optionalString: PropTypes.string,
  optionalSymbol: PropTypes.symbol,
  //
  // 任何可被渲染的元素（包括数字、字符串、子元素或数组）。
  optionalNode: PropTypes.node,
  //
  // 一个 React 元素
  optionalElement: PropTypes.element,
  //
  // 你也可以声明属性为某个类的实例，这里使用 JS 的
  // instanceof 操作符实现。
  optionalMessage: PropTypes.instanceOf(Message),
  //
  // 你也可以限制你的属性值是某个特定值之一
  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
  }),
  //
  // 你也可以在任何 PropTypes 属性后面加上 `isRequired` 
  // 后缀，这样如果这个属性父组件没有提供时，会打印警告信息
  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.'
      );
    }
  })
};