# 通过 PropTypes 进行类型检查
随着 App 的增长，你可能或捕获很多关于 类型检查的 bugs 。对于一些应用，你可以使用 JavaScript 扩展比如 [Flow](https://flowtype.org/) 或者 [TypeScript](https://www.typescriptlang.org/) 类对整个应用进行类型检查。但是即使你不用这些，React 也有一些内置的类型检查能力。要在一个组件的 props 上运行类型检查，可以分配特定的 propTypes 属性：
~~~
class Greeting extends React.Component {
render() {
return (
<h1>Hello, {this.props.name}</h1>
);
}
}
Greeting.propTypes = {
name: React.PropTypes.string
};
~~~
React.PropTypes 暴露了一系列的验证器，可以用来确保接受的数据是有效的。在这个例子中，我们使用 React.PropTypes.string。当一个无效的值提供为一个 prop，在 JavaScript 控制台中将会显示一个警告。处于性能原因，propTypes只在开发模式中进行检查。
## React.PropTypes
这里是一个示例记录提供的不同的验证器：
~~~
MyComponent.propTypes = {
// You can declare that a prop is a specific JS primitive. By default, these
// are all optional.
optionalArray: React.PropTypes.array,
optionalBool: React.PropTypes.bool,
optionalFunc: React.PropTypes.func,
optionalNumber: React.PropTypes.number,
optionalObject: React.PropTypes.object,
optionalString: React.PropTypes.string,
optionalSymbol: React.PropTypes.symbol,
// Anything that can be rendered: numbers, strings, elements or an array
// (or fragment) containing these types.
optionalNode: React.PropTypes.node,
// A React element.
optionalElement: React.PropTypes.element,
// You can also declare that a prop is an instance of a class. This uses
// JS's instanceof operator.
optionalMessage: React.PropTypes.instanceOf(Message),
// You can ensure that your prop is limited to specific values by treating
// it as an enum.
optionalEnum: React.PropTypes.oneOf(['News', 'Photos']),
// An object that could be one of many types
optionalUnion: React.PropTypes.oneOfType([
React.PropTypes.string,
React.PropTypes.number,
React.PropTypes.instanceOf(Message)
]),
// An array of a certain type
optionalArrayOf: React.PropTypes.arrayOf(React.PropTypes.number),
// An object with property values of a certain type
optionalObjectOf: React.PropTypes.objectOf(React.PropTypes.number),
// An object taking on a particular shape
optionalObjectWithShape: React.PropTypes.shape({
color: React.PropTypes.string,
fontSize: React.PropTypes.number
}),
// You can chain any of the above with `isRequired` to make sure a warning
// is shown if the prop isn't provided.
requiredFunc: React.PropTypes.func.isRequired,
// A value of any data type
requiredAny: React.PropTypes.any.isRequired,
// You can also specify a custom validator. It should return an Error
// object if the validation fails. Don't `console.warn` or throw, as this
// won't work inside `oneOfType`.
customProp: function(props, propName, componentName) {
if (!/matchme/.test(props[propName])) {
return new Error(
'Invalid prop `' + propName + '` supplied to' +
' `' + componentName + '`. Validation failed.'
);
}
},
// You can also supply a custom validator to `arrayOf` and `objectOf`.
// It should return an Error object if the validation fails. The validator
// will be called for each key in the array or object. The first two
// arguments of the validator are the array or object itself, and the
// current item's key.
customArrayProp: React.PropTypes.arrayOf(function(propValue, key, componentName, location, propFullName) {
if (!/matchme/.test(propValue[key])) {
return new Error(
'Invalid prop `' + propFullName + '` supplied to' +
' `' + componentName + '`. Validation failed.'
);
}
})
};
~~~
## 要求单独的 Children
With React.PropTypes.element you can specify that only a single child can be passed to a component as children.
通过 React.PropTypes.element 你可以指定只有一个单独的 child 可以传递到一个组件作为 children。
~~~
class MyComponent extends React.Component {
render() {
// This must be exactly one element or it will warn.
const children = this.props.children;
return (
<div>
{children}
</div>
);
}
}
MyComponent.propTypes = {
children: React.PropTypes.element.isRequired
};
~~~
## 默认的 prop 值
可以定义你的 props 默认值，通过赋值到特定的 defaultProps 属性即可：
~~~
class Greeting extends React.Component {
render() {
return (
<h1>Hello, {this.props.name}</h1>
);
}
}
// Specifies the default values for props:
Greeting.defaultProps = {
name: 'Stranger'
};
// Renders "Hello, Stranger":
ReactDOM.render(
<Greeting />,
document.getElementById('example')
);
~~~
defaultProps 被用于确保 this.props.name 将有一个值，即使它没有被父组件指定。propTypes 类型检查发生在 defaultProps 被解析之后，所以类型检查也可以应用到 defaultProps 上。
