使用PropTypes进行类型检查
1.组件特殊属性——propTypes
对Component设置propTypes属性,可以为Component的props属性进行类型检查。
- import PropTypes from 'prop-types';
- class Greeting extends React.Component {
- render() {
- return (
- <h1>Hello, {this.props.name}</h1>
- );
- }
- }
- Greeting.propTypes = {
- name: PropTypes.string
- };
PropTypes提供了许多验证工具,用来帮助你确定props数据的有效性。在上面这个例子中,我们使用了PropTypes.stirng
。意思是:name的值类型应该是string。 当Component的props接收到一个无效的值时,浏览器控制台就会输出一个警告。因此,<Greeting name={123}/> 控制台会出现如下警告:

处于性能原因,类型检查仅在开发模式下进行。
2.PropTypes的更多验证器
- import React from 'react';
- import PropTypes from 'prop-types';
- class MyComponent extends React.Component {
- render() {
- // 利用属性做更多得事
- }
- }
- MyComponent.propTypes = {
- //你可以定义一个属性是特定的JS类型(Array,Boolean,Function,Number,Object,String,Symbol)。默认情况下,这些都是可选的。
- optionalArray: PropTypes.array,
- optionalBool: PropTypes.bool,
- optionalFunc: PropTypes.func,
- optionalNumber: PropTypes.number,
- optionalObject: PropTypes.object,
- optionalString: PropTypes.string,
- optionalSymbol: PropTypes.symbol,
- //指定类型为:任何可以被渲染的元素,包括数字,字符串,react 元素,数组,fragment。
- 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({
- optionalProperty: PropTypes.string,
- requiredProperty: PropTypes.number.isRequired
- }),
- // 指定类型为对象,且可以指定对象的哪些属性必须有,哪些属性可以没有。如果出现没有定义的属性,会出现警告。
- //下面的代码optionalObjectWithStrictShape的属性值为对象,但是对象的属性最多有两个,optionalProperty 和 requiredProperty。
- //出现第三个属性,控制台出现警告。
- optionalObjectWithStrictShape: PropTypes.exact({
- optionalProperty: PropTypes.string,
- requiredProperty: PropTypes.number.isRequired
- }),
- //加上isReqired限制,可以指定某个属性必须提供,如果没有出现警告。
- 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对象。
- //验证器用来验证数组或对象的每个值。验证器的前两个参数是数组或对象本身,还有对应的key。
- 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. 限制单个子元素
使用 PropTypes.element 你可以指定只有一个子元素可以被传递给组件。
- //将children限制为单个子元素。
- Greeting.propTypes = {
- name: PropTypes.string,
- children: PropTypes.element.isRequired
- };
- 如果如下方式引用Greeting组件:
- //传了两个子元素给组件Greeting那么,控制台会出现警告
- <Greeting name={'world'}>
- <span>子元素1</span>
- <span>子元素2</span>
- </Greeting>
警告如图:

4.指定默认属性值。
- 你可以给组件分配一个特殊的defaultProps属性。
- //给Greeting属性中的name值指定默认值。当组件引用的时候,没有传入name属性时,会使用默认值。
- Greeting.defaultProps = {
- name: 'Stranger'
- };
- // ES6可以这样写
- class Greeting extends React.Component {
- static defaultProps = {
- name: 'stranger'
- }
- render() {
- return (
- <div>Hello, {this.props.name}</div>
- )
- }
- }
作者:打铁大师
链接:https://www.jianshu.com/p/2896acb5746b
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
使用PropTypes进行类型检查的更多相关文章
- React文档(十五)使用propTypes进行类型检查
注意: React.PropTypes 自 React v15.5 起已弃用.请使用 prop-types 库代替. 随着你的应用的开发,你会使用类型检查的方法来捕获很多bug.对于一些应用,你可以使 ...
- React 使用 PropTypes 进行类型检查
注意: React.PropTypes 自 React v15.5 起已弃用.请使用 prop-types 库代替. defaultProps 用来确保 this.props.name 在父组件没有特 ...
- 使用 PropTypes 进行类型检查
注意: 从 React v15.5 开始 ,React.PropTypes 助手函数已被弃用,建议使用 prop-types 库 来定义contextTypes. 1 2 3 4 5 6 7 8 9 ...
- React中使用 PropTypes 进行类型检查
官方文档学习链接:https://zh-hans.reactjs.org/docs/typechecking-with-proptypes.html import React, { Component ...
- react的类型检查PropTypes自React v15.5起已弃用,请使用prop-types
最近使用React的类型检查PropTypes时,遇到错误:TypeError: Cannot read property 'array' of undefined 看了下自己的React版本: ...
- React类型检查
类型检查 import PropTypes from 'prop-types' 类名==List List.propTypes = { list: PropTypes.array } // 默认值 L ...
- 编译器开发系列--Ocelot语言6.静态类型检查
关于"静态类型检查",想必使用C 或Java 的各位应该非常熟悉了.在此过程中将检查表达式的类型,发现类型不正确的操作时就会报错.例如结构体之间无法用+ 进行加法运算,指针和数值之 ...
- Java中静态类型检查是如何进行的
以下内容来自维基百科,关于静态类型检查和动态类型检查的解释: 静态类型检查:基于程序的源代码来验证类型安全的过程: 动态类型检查:在程序运行期间验证类型安全的过程: Java使用静态类型检查在编译期间 ...
- Flow: JavaScript静态类型检查工具
Flow: JavaScript静态类型检查工具 Flow是Facebook出品的,针对JavaScript的静态类型检查工具.其代码托管在github之上,并遵守BSD开源协议. 关于Flow 它可 ...
随机推荐
- RainbowPlan-Alpha版本发布1
博客介绍 这个作业属于哪个课程 https://edu.cnblogs.com/campus/xnsy/GeographicInformationScience/ 这个作业要求在哪里 https:// ...
- 《即时消息技术剖析与实战》学习笔记8——IM系统如何保证长连接的可用性:心跳机制
假设有以下突发意外情况: 用户进入信号不好的地方,手机没有网络信号了 上网的路由器突然掉线了 这个时候,比如微信发消息,消息就会转圈圈,甚至变成红色叹号-- 上面情况都会导致"长连接&quo ...
- Pycharm运行/调试程序说明
1.字体调整(optional) File -> Settings ->Editor->Colors & Fonts -> Size 22 2.打开程序所在文件夹hw5 ...
- python下的selenium和chrome driver的安装
selenium是一款支持多种语言.多种浏览器.多个平台的开源web自动化测试软件,测试人员可用python.java等语言编写自动化脚本,使得浏览器可以完全按照你的指令运行,大大节省了测试人员用鼠标 ...
- ElasticSearch快速入门
知识储备 学习ElasticSearch之前可以先了解一下lucene,这里是我整理的一篇关于lucene的笔记(传送门),对搜索框架有兴趣的还可以了解一下另一款企业级搜索应用服务器---solr(传 ...
- Tornadofx学习笔记(2)——FxRecyclerView控件的打造
Tornadofx是基于javafx的一个kotlin框架,用来写些电脑版的小程序 基于Scroll Pane控件,仿造Android中的RecyclerView,实现的一款tornadofx的控件 ...
- 对比PXC集群与主从架构在一致性上的区别
在上一篇文章中,已经完成了三节点PXC集群的搭建,现在搭建node3的从库node4,并且有如下测试: 搭建node3的从库,代号node4 测试1: 先断开node3节点,然后在node1构造数据, ...
- liberty | 在IDEA整合Springboot与IBM liberty
在IDEA整合Springboot与IBM liberty 简介 Liberty 是一款全新的轻量级应用服务器,它将用户的良好开发体验作为最主要的出发点.其主要特点和内容包括: 高模块化--该功能允许 ...
- 聊聊SpringBoot | 第一章:快速搭建SpringBoot第一个应用
快速搭建SpringBoot第一个应用 1.简介 本章仅介绍如何快速搭建第一个SpringBoot应用,细节内容下一章再做讲解,如果有需要,各位可以直接到Spring官网去了解. 从 Spring B ...
- [白话解析] Flink的Watermark机制
[白话解析] Flink的Watermark机制 0x00 摘要 对于Flink来说,Watermark是个很难绕过去的概念.本文将从整体的思路上来说,运用感性直觉的思考来帮大家梳理Watermark ...