React入门系列教程(四)使用PropTypes验证自定义组件属性类型

先创建一个自定义组件,这次不用箭头函数,用普通函数。

//这是个用函数方式创建的自定义组件,记得函数名首字母大写
function Hi(props) {
    return (
        <div>
            你好, {props.lastName} {props.firstName}
        </div>
    )
}

我们来使用一下:

<div id="rootElement"></div>
<script src="https://unpkg.com/react@16.8.3/umd/react.production.min.js"></script>
<script src="https://unpkg.com/react-dom@16.8.3/umd/react-dom.production.min.js"></script>
<script src="https://unpkg.com/babel-standalone@6.26.0/babel.min.js"></script>
<script type="text/babel">
    const rootElement = document.getElementById('rootElement')
    
    function Hi(props) {
        return (
            <div>
                你好, {props.lastName} {props.firstName}
            </div>
        )
    }
    
    ReactDOM.render(<Hi firstName={true} />, rootElement)
</script>

Hi组件使用到了两个属性,并且这两个属性很明显是string类型,然而在使用中我们给firstName属性传入了一个bool类型的值,没有给lastName属性赋值。

有没有办法给属性值加上类型检查之类的验证呢?使用组件的静态propTypes属性,它是个对象。比如我们要给firstName加上验证,那就要在propTypes中添加一个键名为firstName,键值为一个函数,函数有三个输入参数,分别是propspropNamecomponentName。来看下怎么用:

<div id="rootElement"></div>
<!-- <script src="https://unpkg.com/react@16.8.3/umd/react.production.min.js"></script> -->
<!-- react库用development版本,propTypes才会起作用 -->
<script src="https://unpkg.com/react@16.8.3/umd/react.development.js"></script>
<script src="https://unpkg.com/react-dom@16.8.3/umd/react-dom.production.min.js"></script>
<script src="https://unpkg.com/babel-standalone@6.26.0/babel.min.js"></script>
<script type="text/babel">
    const rootElement = document.getElementById('rootElement')
    
    function Hi(props) {
        return (
            <div>
                你好, {props.lastName} {props.firstName}
            </div>
        )
    }
    
    Hi.propTypes = {
        //props就是Hi组件的props,propName这里就是firstName
        firstName(props, propName, componentName) {
            //props[propName]就是取得Hi组件firstName的值
            if(typeof props[propName] !== 'string') {
                return new Error(`${componentName}的${propName}属性的值应是字符串类型`)
            }
        }
    }
    
    ReactDOM.render(<Hi firstName={true} />, rootElement)
</script>

效果如图1。

图1

firstNamelastName的验证是一样的,之前提到过复用,我们可以把公共代码抽取成一个函数。

<div id="rootElement"></div>
<!-- <script src="https://unpkg.com/react@16.8.3/umd/react.production.min.js"></script> -->
<!-- react库用development版本,propTypes才会起作用 -->
<script src="https://unpkg.com/react@16.8.3/umd/react.development.js"></script>
<script src="https://unpkg.com/react-dom@16.8.3/umd/react-dom.production.min.js"></script>
<script src="https://unpkg.com/babel-standalone@6.26.0/babel.min.js"></script>
<script type="text/babel">
    const rootElement = document.getElementById('rootElement')
    
    function Hi(props) {
        return (
            <div>
                你好, {props.lastName} {props.firstName}
            </div>
        )
    }
    
    //公共代码包裹到string函数里,并放到一个对象中统一管理
    const PropTypes = {
        string(props, propName, componentName) {
            if(typeof props[propName] !== 'string') {
                return new Error(`${componentName}的${propName}属性的值应是字符串类型`)
            }
        }
    }
    
    Hi.propTypes = {
        //键为要验证的属性名,值为函数
        firstName: PropTypes.string,
        lastName: PropTypes.string
    }
    
    ReactDOM.render(<Hi firstName={true} />, rootElement)
</script>

其实react团队早已为我们准备好了PropTypes包供我们使用,我们只要引入就好了。

<div id="rootElement"></div>
<!-- <script src="https://unpkg.com/react@16.8.3/umd/react.production.min.js"></script> -->
<!-- react库用development版本,propTypes才会起作用 -->
<script src="https://unpkg.com/react@16.8.3/umd/react.development.js"></script>
<script src="https://unpkg.com/react-dom@16.8.3/umd/react-dom.production.min.js"></script>
<script src="https://unpkg.com/prop-types@15.7.2/prop-types.js"></script>
<script src="https://unpkg.com/babel-standalone@6.26.0/babel.min.js"></script>
<script type="text/babel">
    const rootElement = document.getElementById('rootElement')
    
    function Hi(props) {
        return (
            <div>
                你好, {props.lastName} {props.firstName}
            </div>
        )
    }
    
    Hi.propTypes = {
        //引入prop-types后,使用方式和之前相同
        firstName: PropTypes.string,
        lastName: PropTypes.string
    }
    
    ReactDOM.render(<Hi firstName={true} />, rootElement)
</script>

更具体的使用方式请查看prop-types包的文档。

其实定义react组件不仅可以使用函数的方式,还可以使用class,也就是类的方式来定义。用类的方式定义的组件如何使用prop-types包呢?看代码:

<div id="rootElement"></div>
<!-- <script src="https://unpkg.com/react@16.8.3/umd/react.production.min.js"></script> -->
<!-- react库用development版本,propTypes才会起作用 -->
<script src="https://unpkg.com/react@16.8.3/umd/react.development.js"></script>
<script src="https://unpkg.com/react-dom@16.8.3/umd/react-dom.production.min.js"></script>
<script src="https://unpkg.com/prop-types@15.7.2/prop-types.js"></script>
<script src="https://unpkg.com/babel-standalone@6.26.0/babel.min.js"></script>
<script type="text/babel">
    const rootElement = document.getElementById('rootElement')
    
    class Hi extends React.Component {
        //定义成静态属性
        static propTypes = {
            firstName: PropTypes.string,
            lastName: PropTypes.string
        }
        
        render() {
            const {lastName, firstName} = this.props
            return (
                <div>
                    你好, {lastName} {firstName}
                </div>
            )
        }
    }
    
    ReactDOM.render(<Hi firstName={true} />, rootElement)
</script>

最后提醒大家注意,当你要真正发布产品的时候,请使用react.production包,它不会使用PropTypes,因为PropTypes会大大降低程序的性能。所以我们在开发的时候才用react.development

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,233评论 6 495
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,357评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,831评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,313评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,417评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,470评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,482评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,265评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,708评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,997评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,176评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,827评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,503评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,150评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,391评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,034评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,063评论 2 352

推荐阅读更多精彩内容