React中的Props類型檢查PropTypes

官方提示:從React V15.5彻磁,之前的React.PropTypes會(huì)在未來(lái)版本移除玻募,請(qǐng)使用 prop-types 替代斤吐。

隨著應(yīng)用程序的增長(zhǎng)辕漂,你可以用類型檢查找到更多錯(cuò)誤浦妄。你可以為你的應(yīng)用使用第三方類型檢查庫(kù)尼摹,如:FlowTypeScript 等剂娄。你也可以不使用它們蠢涝,因?yàn)镽eact內(nèi)嵌了一些類型檢查功能。你可以設(shè)置組件的指定屬性propTypes阅懦,為組件添加類型檢查的能力和二。

這是個(gè)簡(jiǎ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)證器。

import PropTypes from 'prop-types';

MyComponent.propTypes = {
  // JS原始類型耳胎,這些全部默認(rèn)是可選的
  optionalArray: PropTypes.array,
  optionalBool: PropTypes.bool,
  optionalFunc: PropTypes.func,
  optionalNumber: PropTypes.number,
  optionalObject: PropTypes.object,
  optionalString: PropTypes.string,
  optionalSymbol: PropTypes.symbol,

  // 可以直接渲染的任何東西惯吕,可以是數(shù)字、字符串场晶、元素或數(shù)組
  optionalNode: PropTypes.node,

  // React元素
  optionalElement: PropTypes.element,

  // 指定是某個(gè)類的實(shí)例
  optionalMessage: PropTypes.instanceOf(Message),

  // 可以是多個(gè)值中的一個(gè)
  optionalEnum: PropTypes.oneOf(['News', 'Photos']),

  // 可以是多種類型中的一個(gè)
  optionalUnion: PropTypes.oneOfType([
    PropTypes.string,
    PropTypes.number,
    PropTypes.instanceOf(Message)
  ]),

  // 只能是某種類型的數(shù)組
  optionalArrayOf: PropTypes.arrayOf(PropTypes.number),

  // 具有特定類型屬性值的對(duì)象
  optionalObjectOf: PropTypes.objectOf(PropTypes.number),

  // 具有相同屬性值的對(duì)象
  optionalObjectWithShape: PropTypes.shape({
    color: PropTypes.string,
    fontSize: PropTypes.number
  }),

  // 必選條件混埠,可以配合其他驗(yàn)證器,以確保在沒有提供屬性的情況下發(fā)出警告
  requiredFunc: PropTypes.func.isRequired,

  // 必選條件诗轻,提供的屬性可以為任意類型
  requiredAny: PropTypes.any.isRequired,

  // 自定義‘oneOfType’驗(yàn)證器钳宪。如果提供的屬性值不匹配的它應(yīng)該拋出一個(gè)異常
  // 注意:不能使用‘console.warn’ 和 throw
  customProp: function(props, propName, componentName) {
    if (!/matchme/.test(props[propName])) {
      return new Error(
        'Invalid prop `' + propName + '` supplied to' +
        ' `' + componentName + '`. Validation failed.'
      );
    }
  },

  // 自定義‘a(chǎn)rrayOf’或者‘objectOf’驗(yàn)證器。
  // 它會(huì)調(diào)用每個(gè)數(shù)組或者對(duì)象的key扳炬,參數(shù)前兩個(gè)是對(duì)象它本身和當(dāng)前key
  // 注意:不能使用‘console.warn’ 和 throw
  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.'
      );
    }
  })
};

Single Child組件

使用PropTypes.element你可以指定你的組件必須要有一個(gè)children吏颖,而且只能有一個(gè)。

import PropTypes from 'prop-types';

class MyComponent extends React.Component {
  render() {
    // 它必須是個(gè)React元素恨樟,否則會(huì)報(bào)錯(cuò)
    const children = this.props.children;
    return (
      <div>
        {children}
      </div>
    );
  }
}

MyComponent.propTypes = {
  children: PropTypes.element.isRequired
};

defaultProps中的值

設(shè)置組件的defaultProps屬性半醉,可以為props指定默認(rèn)值:

class Greeting extends React.Component {
  render() {
    return (
      <h1>Hello, {this.props.name}</h1>
    );
  }
}

// 為props指定默認(rèn)值:
Greeting.defaultProps = {
  name: 'Stranger'
};

// 渲染 "Hello, Stranger":
ReactDOM.render(
  <Greeting />,
  document.getElementById('example')
);

defaultProps用于確保this.props.name有一個(gè)值,如果上級(jí)組件沒有指定的話劝术。props類型檢查會(huì)發(fā)生在defaultProps解析之后缩多,所以類型檢查也適用于defaultProps

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末养晋,一起剝皮案震驚了整個(gè)濱河市衬吆,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌绳泉,老刑警劉巖逊抡,帶你破解...
    沈念sama閱讀 210,914評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異零酪,居然都是意外死亡冒嫡,警方通過(guò)查閱死者的電腦和手機(jī)拇勃,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,935評(píng)論 2 383
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)孝凌,“玉大人方咆,你說(shuō)我怎么就攤上這事√バ恚” “怎么了峻呛?”我有些...
    開封第一講書人閱讀 156,531評(píng)論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)辜窑。 經(jīng)常有香客問(wèn)我钩述,道長(zhǎng),這世上最難降的妖魔是什么穆碎? 我笑而不...
    開封第一講書人閱讀 56,309評(píng)論 1 282
  • 正文 為了忘掉前任牙勘,我火速辦了婚禮,結(jié)果婚禮上所禀,老公的妹妹穿的比我還像新娘方面。我一直安慰自己,他們只是感情好色徘,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,381評(píng)論 5 384
  • 文/花漫 我一把揭開白布恭金。 她就那樣靜靜地躺著,像睡著了一般褂策。 火紅的嫁衣襯著肌膚如雪横腿。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,730評(píng)論 1 289
  • 那天斤寂,我揣著相機(jī)與錄音耿焊,去河邊找鬼。 笑死遍搞,一個(gè)胖子當(dāng)著我的面吹牛罗侯,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播溪猿,決...
    沈念sama閱讀 38,882評(píng)論 3 404
  • 文/蒼蘭香墨 我猛地睜開眼钩杰,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了诊县?” 一聲冷哼從身側(cè)響起榜苫,我...
    開封第一講書人閱讀 37,643評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎翎冲,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體媳荒,經(jīng)...
    沈念sama閱讀 44,095評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡抗悍,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,448評(píng)論 2 325
  • 正文 我和宋清朗相戀三年驹饺,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片缴渊。...
    茶點(diǎn)故事閱讀 38,566評(píng)論 1 339
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡赏壹,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出衔沼,到底是詐尸還是另有隱情蝌借,我是刑警寧澤,帶...
    沈念sama閱讀 34,253評(píng)論 4 328
  • 正文 年R本政府宣布指蚁,位于F島的核電站菩佑,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏凝化。R本人自食惡果不足惜稍坯,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,829評(píng)論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望搓劫。 院中可真熱鬧瞧哟,春花似錦、人聲如沸枪向。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,715評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)秘蛔。三九已至陨亡,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間缠犀,已是汗流浹背数苫。 一陣腳步聲響...
    開封第一講書人閱讀 31,945評(píng)論 1 264
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留辨液,地道東北人虐急。 一個(gè)月前我還...
    沈念sama閱讀 46,248評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像滔迈,于是被迫代替她去往敵國(guó)和親止吁。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,440評(píng)論 2 348

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