使用PropTypes進(jìn)行類型檢查

原文地址

1.組件特殊屬性——propTypes

對(duì)Component設(shè)置propTypes屬性村视,可以為Component的props屬性進(jìn)行類型檢查荷科。

import PropTypes from 'prop-types';
class Greeting extends React.Component {
render() {
    return (
      <h1>Hello, {this.props.name}</h1>
    );
  }
}
Greeting.propTypes = {
  name: PropTypes.string
};

PropTypes提供了許多驗(yàn)證工具洁段,用來(lái)幫助你確定props數(shù)據(jù)的有效性。在上面這個(gè)例子中咪笑,我們使用了PropTypes.stirng浸剩。意思是:name的值類型應(yīng)該是string钾军。 當(dāng)Component的props接收到一個(gè)無(wú)效的值時(shí),瀏覽器控制臺(tái)就會(huì)輸出一個(gè)警告绢要。因此吏恭,<Greeting name={123}/> 控制臺(tái)會(huì)出現(xiàn)如下警告:

WechatIMG198.jpeg

處于性能原因,類型檢查僅在開(kāi)發(fā)模式下進(jìn)行重罪。

2.PropTypes的更多驗(yàn)證器

import React from 'react';
import PropTypes from 'prop-types';

class MyComponent extends React.Component {
  render() {
    // 利用屬性做更多得事
   }
}

MyComponent.propTypes = {
//你可以定義一個(gè)屬性是特定的JS類型(Array,Boolean,Function,Number,Object,String,Symbol)樱哼。默認(rèn)情況下,這些都是可選的蛆封。

optionalArray: PropTypes.array,
optionalBool: PropTypes.bool,
optionalFunc: PropTypes.func,
optionalNumber: PropTypes.number,
optionalObject: PropTypes.object,
optionalString: PropTypes.string,
optionalSymbol: PropTypes.symbol,

//指定類型為:任何可以被渲染的元素唇礁,包括數(shù)字勾栗,字符串惨篱,react 元素,數(shù)組围俘,fragment砸讳。
optionalNode: PropTypes.node,

// 指定類型為:一個(gè)react 元素
optionalElement: PropTypes.element,

//你可以類型為某個(gè)類的實(shí)例琢融,這里使用JS的instanceOf操作符實(shí)現(xiàn)
optionalMessage: PropTypes.instanceOf(Message),


//指定枚舉類型:你可以把屬性限制在某些特定值之內(nèi)
optionalEnum: PropTypes.oneOf(['News', 'Photos']),

// 指定多個(gè)類型:你也可以把屬性類型限制在某些指定的類型范圍內(nèi)
optionalUnion: PropTypes.oneOfType([
  PropTypes.string,
  PropTypes.number,
  PropTypes.instanceOf(Message)
]),

// 指定某個(gè)類型的數(shù)組
optionalArrayOf: PropTypes.arrayOf(PropTypes.number),

// 指定類型為對(duì)象,且對(duì)象屬性值是特定的類型
optionalObjectOf: PropTypes.objectOf(PropTypes.number),


//指定類型為對(duì)象簿寂,且可以規(guī)定哪些屬性必須有漾抬,哪些屬性可以沒(méi)有
optionalObjectWithShape: PropTypes.shape({
  optionalProperty: PropTypes.string,
  requiredProperty: PropTypes.number.isRequired
}),

// 指定類型為對(duì)象,且可以指定對(duì)象的哪些屬性必須有常遂,哪些屬性可以沒(méi)有纳令。如果出現(xiàn)沒(méi)有定義的屬性,會(huì)出現(xiàn)警告克胳。
//下面的代碼optionalObjectWithStrictShape的屬性值為對(duì)象平绩,但是對(duì)象的屬性最多有兩個(gè),optionalProperty 和 requiredProperty漠另。
//出現(xiàn)第三個(gè)屬性捏雌,控制臺(tái)出現(xiàn)警告。
optionalObjectWithStrictShape: PropTypes.exact({
  optionalProperty: PropTypes.string,
  requiredProperty: PropTypes.number.isRequired
}),

//加上isReqired限制笆搓,可以指定某個(gè)屬性必須提供性湿,如果沒(méi)有出現(xiàn)警告。
requiredFunc: PropTypes.func.isRequired,
requiredAny: PropTypes.any.isRequired,

// 你也可以指定一個(gè)自定義的驗(yàn)證器满败。如果驗(yàn)證不通過(guò)肤频,它應(yīng)該返回Error對(duì)象,而不是`console.warn `或拋出錯(cuò)誤葫录。`oneOfType`中不起作用着裹。
customProp: function(props, propName, componentName) {
  if (!/matchme/.test(props[propName])) {
    return new Error(
      'Invalid prop `' + propName + '` supplied to' +
      ' `' + componentName + '`. Validation failed.'
    );
  }
},

//你也可以提供一個(gè)自定義的驗(yàn)證器 arrayOf和objectOf。如果驗(yàn)證失敗米同,它應(yīng)該返回一個(gè)Error對(duì)象骇扇。
//驗(yàn)證器用來(lái)驗(yàn)證數(shù)組或?qū)ο蟮拿總€(gè)值。驗(yàn)證器的前兩個(gè)參數(shù)是數(shù)組或?qū)ο蟊旧砻媪福€有對(duì)應(yīng)的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. 限制單個(gè)子元素

使用 PropTypes.element 你可以指定只有一個(gè)子元素可以被傳遞給組件。

 //將children限制為單個(gè)子元素熬苍。
Greeting.propTypes = {
  name: PropTypes.string,
  children: PropTypes.element.isRequired
};

如果如下方式引用Greeting組件:

 //傳了兩個(gè)子元素給組件Greeting那么稍走,控制臺(tái)會(huì)出現(xiàn)警告
<Greeting name={'world'}>
      <span>子元素1</span>
      <span>子元素2</span>
 </Greeting>

警告如圖:

WechatIMG199.jpeg

4.指定默認(rèn)屬性值。

你可以給組件分配一個(gè)特殊的defaultProps屬性柴底。

//給Greeting屬性中的name值指定默認(rèn)值婿脸。當(dāng)組件引用的時(shí)候,沒(méi)有傳入name屬性時(shí)柄驻,會(huì)使用默認(rèn)值狐树。
Greeting.defaultProps = {
  name: 'Stranger'
};

// ES6可以這樣寫(xiě)

class Greeting extends React.Component {
  static defaultProps = {
    name: 'stranger'
  }
  render() {
    return (
      <div>Hello, {this.props.name}</div>
    )
  }
}
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市鸿脓,隨后出現(xiàn)的幾起案子抑钟,更是在濱河造成了極大的恐慌涯曲,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,576評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件在塔,死亡現(xiàn)場(chǎng)離奇詭異幻件,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)蛔溃,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,515評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門(mén)绰沥,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人贺待,你說(shuō)我怎么就攤上這事揪利。” “怎么了狠持?”我有些...
    開(kāi)封第一講書(shū)人閱讀 168,017評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵疟位,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我喘垂,道長(zhǎng)甜刻,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 59,626評(píng)論 1 296
  • 正文 為了忘掉前任正勒,我火速辦了婚禮得院,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘章贞。我一直安慰自己祥绞,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,625評(píng)論 6 397
  • 文/花漫 我一把揭開(kāi)白布鸭限。 她就那樣靜靜地躺著蜕径,像睡著了一般。 火紅的嫁衣襯著肌膚如雪败京。 梳的紋絲不亂的頭發(fā)上兜喻,一...
    開(kāi)封第一講書(shū)人閱讀 52,255評(píng)論 1 308
  • 那天,我揣著相機(jī)與錄音赡麦,去河邊找鬼朴皆。 笑死,一個(gè)胖子當(dāng)著我的面吹牛泛粹,可吹牛的內(nèi)容都是我干的遂铡。 我是一名探鬼主播,決...
    沈念sama閱讀 40,825評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼晶姊,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼扒接!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,729評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤珠增,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后砍艾,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體蒂教,經(jīng)...
    沈念sama閱讀 46,271評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,363評(píng)論 3 340
  • 正文 我和宋清朗相戀三年脆荷,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了凝垛。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,498評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡蜓谋,死狀恐怖梦皮,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情桃焕,我是刑警寧澤剑肯,帶...
    沈念sama閱讀 36,183評(píng)論 5 350
  • 正文 年R本政府宣布,位于F島的核電站观堂,受9級(jí)特大地震影響让网,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜师痕,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,867評(píng)論 3 333
  • 文/蒙蒙 一溃睹、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧胰坟,春花似錦因篇、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,338評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至吹缔,卻和暖如春虽界,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背涛菠。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,458評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工莉御, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人俗冻。 一個(gè)月前我還...
    沈念sama閱讀 48,906評(píng)論 3 376
  • 正文 我出身青樓礁叔,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親迄薄。 傳聞我的和親對(duì)象是個(gè)殘疾皇子琅关,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,507評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容