React高階組件

最后更新時間:2019/05/15
以下內(nèi)容來自:

1 HOC 基礎(chǔ)概念

1.1 定義

A higher-order component (HOC) is an advanced technique in React for reusing component logic. HOCs are not part of the React API, per se. They are a pattern that emerges from React’s compositional nature

They take any input - most of the time a component, but also optional arguments - and return a component as output. The returned component is an enhanced version of the input component and can be used in your JSX

const EnhancedComponent = higherOrderComponent(WrappedComponent);

1.2 理解

  1. 高階組件只是 React 建議的一種機制、模式,并非一個特殊的 API琼讽。
  2. HOC 的目的在于通過將不同的 Component 中相同的邏輯提取出來,在一個 function 實現(xiàn)這些通用邏輯门躯,之后接受 Component 輸入,“注入”通用邏輯酷师,實現(xiàn)對 component 的增強讶凉,減少代碼冗余,提高組件的復(fù)用性山孔。這種通用邏輯的注入可以是向 Component 注入新的 prop懂讯,可以是對 Component 的 prop 進行某種檢查,進行條件渲染等台颠。
  3. HOC 的返回可以是一個 class 組件褐望,function 組件或者另外的 HOC
  4. 傳入的 Component 作為return新的增強的組件的相對獨立的一部分,因此 <span style=“text-color: red”>不要在高階組件中直接修改傳入組件(方法等)</span>

2 實例

2.1 對 Component 注入新的 prop

2.1.1 思考與使用過程

現(xiàn)在存在兩個組件串前,CommentListBlogPost瘫里,他們都從一個外部數(shù)據(jù)DataSource中獲取數(shù)據(jù)進行展示。

class CommentList extends React.Component {
  constructor(props) {
    super(props);
    this.handleChange = this.handleChange.bind(this);
    this.state = {
      // "DataSource" is some global data source
      comments: DataSource.getComments(),
    };
  }

  componentDidMount() {
    DataSource.addChangeListener(this.handleChange);
  }

  componentWillUnmount() {
    DataSource.removeChangeListener(this.handleChange);
  }

  handleChange() {
    this.setState({
      comments: DataSource.getComments(),
    });
  }

  render() {
    return (
      <div>
        {this.state.comments.map(comment => (
          <Comment comment={comment} key={comment.id} />
        ))}
      </div>
    );
  }
}
class BlogPost extends React.Component {
  constructor(props) {
    super(props);
    this.handleChange = this.handleChange.bind(this);
    this.state = {
      blogPost: DataSource.getBlogPost(props.id),
    };
  }

  componentDidMount() {
    DataSource.addChangeListener(this.handleChange);
  }

  componentWillUnmount() {
    DataSource.removeChangeListener(this.handleChange);
  }

  handleChange() {
    this.setState({
      blogPost: DataSource.getBlogPost(this.props.id),
    });
  }

  render() {
    return <TextBlock text={this.state.blogPost} />;
  }
}

兩個組件的區(qū)別:

  1. DataSource中獲取數(shù)據(jù)的方法不同荡碾,一個是getComments谨读,一個是getBlogPost
  2. 展示數(shù)據(jù)的render函數(shù)不同。

相同點:

  1. 在組件掛載時 subscribe DataSource坛吁,當DataSource發(fā)生改變后劳殖,調(diào)用handleChange重新渲染;同時卸載時移除 listener
  2. 都從DataSource中獲取數(shù)據(jù)

可以看到這兩個組件存在相同的邏輯拨脉,即從DataSource中獲取數(shù)據(jù)哆姻,進行渲染。當中存在冗余的代碼玫膀,如果再寫第三個組件矛缨,如IssueList,那么這個邏輯還要重復(fù)一個匆骗。
因此我們可以采用以下的高階組件提取通用邏輯:

(1)定義高階組件
// This function takes a component...
function withSubscription(WrappedComponent, selectData) {
  // ...and returns another component...
  return class EnhancedComponent extends React.Component {
    constructor(props) {
      super(props);
      this.handleChange = this.handleChange.bind(this);
      this.state = {
        data: selectData(DataSource, props),
      };
    }

    componentDidMount() {
      // ... that takes care of the subscription...
      DataSource.addChangeListener(this.handleChange);
    }

    componentWillUnmount() {
      DataSource.removeChangeListener(this.handleChange);
    }

    handleChange() {
      this.setState({
        data: selectData(DataSource, this.props),
      });
    }

    render() {
      // ... and renders the wrapped component with the fresh data!
      // Notice that we pass through any additional props
      return <WrappedComponent data={this.state.data} {...this.props} />;
    }
  };
}

此 HOC 接受WrappedComponent劳景,以及selectData兩個參數(shù),前者是需要增強的組件碉就,后者是用來從DataSource中獲取數(shù)據(jù)的 function。
注意到 HOC 返回的是一個增強的闷串、新的 class react 組件瓮钥,具有以下幾個特征:

  1. local state中保存了通過 HOC 參數(shù)selectData拿到的數(shù)據(jù)
  2. render函數(shù)返回的還是傳入的WrappedComponent組件的實例,并且傳入了一個新的data屬性。
  3. 需要注意碉熄,{...this.props}桨武,保證了高階組件實例生成時定傳入的props都能夠傳入WrappedComponent組件。
(2)重新定義原組件

重新實現(xiàn)之前的CommentListBlogPost組件锈津,此時在它們的render函數(shù)中直接使用this.props.data來進行渲染呀酸,不需要再與DataSource進行交互。

class CommentList extends React.Component {
  render() {
    const { data, ...res } = this.props;
    return (
      <div>
        {data.map(comment => (
          <Comment comment={comment} key={comment.id} {...reas} />
        ))}
      </div>
    );
  }
}
class CommentList extends React.Component {
  render() {
    const { data, ...res } = this.props;
    return <TextBlock text={data} {...res} />;
  }
}
(3)定義增強組件
const CommentListWithSubscription = withSubscription(CommentList, DataSource =>
  DataSource.getComments(),
);

const BlogPostWithSubscription = withSubscription(
  BlogPost,
  (DataSource, props) => DataSource.getBlogPost(props.id),
);

此時的CommentListWithSubscriptionBlogPostWithSubscription是高階組件withSubscription返回的新增強的 class 組件琼梆。

(4) 使用新的增強組件
class App extends Component{
    ...
    render() {
        ...
        return (
            <div>
                <CommentListWithSubscription disabled/>
                <BlogPostWithSubscription />
            </div>
        )
    }
}

注意其中的disableed屬性會一層層的傳遞給Comment組件性誉,傳遞過程如下:

  1. 首先是傳入withSubscription返回的EnhancedComponent組件 render 函數(shù)中的props
  2. 通過 return 語句中{...this.props}被傳遞給<WrappedComponent />組件
  3. 此時WrappedComponentCommentList,在它的 render 函數(shù)可通過{...res}傳遞給<Component />

2.1.2 總結(jié)

可以看到這種方式的 HOC 沒有直接改變傳入的 Component茎杂,而是傳入新的prop错览,因此,在 Component 的render函數(shù)中可以使用新的prop進行渲染或其它操作煌往。以上例子在React docs進一步了解倾哺。

2.2 條件渲染

現(xiàn)在存在一個ToDoList組件

function TodoList({ todos, isLoadingTodos }) {
  if (isLoadingTodos) {
    return (
      <div>
        <p>Loading todos ...</p>
      </div>
    );
  }

  if (!todos) {
    return null;
  }

  if (!todos.length) {
    return (
      <div>
        <p>You have no Todos.</p>
      </div>
    );
  }

  return (
    <div>
      {todos.map(todo => (
        <TodoItem key={todo.id} todo={todo} />
      ))}
    </div>
  );
}

可以看到有很多關(guān)于 todos 的條件渲染,我們可以嘗試把這種條件渲染的邏輯提取出來刽脖,形成下面的情況:

const withLoadingIndicator = Component => ({ isLoadingTodos, ...others }) =>
  isLoadingTodos ? (
    <div>
      <p>Loading todos ...</p>
    </div>
  ) : (
    <Component {...others} />
  ); // (1)

const withTodosNull = Component => props =>
  !props.todos ? null : <Component {...props} />; // (2)

const withTodosEmpty = Component => props =>
  !props.todos.length ? (
    <div>
      <p>You have no Todos.</p>
    </div>
  ) : (
    <Component {...props} />
  ); // (3)

重新定義ToDoList組件:

const TodoList = ({ todos }) => (
  <div>
    {todos.map(todo => (
      <TodoItem key={todo.id} todo={todo} />
    ))}
  </div>
);

之后利用這三個新的 HOC羞海,定義新的增強組件:

const TodoListWithConditionalRendering = withLoadingIndicator(
  withTodosNull(withTodosEmpty(TodoList)),
);
// 可以寫成以下的形式
// const TodoListOne = withTodosEmpty(TodoList);
// const TodoListTwo = withTodosNull(TodoListOne);
// const TodoListThree = withLoadingIndicator(TodoListTwo);

現(xiàn)在,生成增強組件的實例:

    ...
    <TodoListWithConditionalRendering isLoadingTodos={true} />
    ...

isLoadingTodos屬性通過 (1)(2)(3)層層傳遞給TodoList組件曲管。
更多的了解可以參看A gentle Introduction to React's Higher Order Components

2.3 第三方庫 HOC 例子

讓我們來看實際的例子:

// antd Form組件的使用 參見https://ant.design/components/form-cn/#Form.create(options)
import { Form } from 'antd';

class CustomizedForm extends React.Component {}

export default (CustomizedForm = Form.create({})(CustomizedForm));

代碼中的Form.create()方法接受一個option參數(shù)扣猫,該參數(shù)的部分屬性如下表:

參數(shù) 說明
name 設(shè)置表單域內(nèi)字段id的前綴
onValuesChange 任一表單域的值發(fā)生改變時的回調(diào)

一個使用的例子如下:

const CustomizedForm = Form.create({
  name: 'global_state',
  onFieldsChange(props, changedFields) {
    props.onChange(changedFields);
  },
  mapPropsToFields(props) {
    return {
      username: Form.createFormField({
        ...props.username,
        value: props.username.value,
      }),
    };
  },
  onValuesChange(_, values) {
    console.log(values);
  },
})(CustomComponent);

Form.create()方法返回的還是一個 HOC,這個 HOC 單獨接受一個組件輸入翘地,返回增強組件申尤,即上面的Form.create({})(CustomizedForm)
此時在CustomizedForm組件中就可以使用被高階組件注入的屬性form衙耕。例如:

// CustomizedForm
render() {
    const {
      getFieldDecorator, getFieldsError, getFieldError, isFieldTouched,
    } = this.props.form;

    // Only show error after a field is touched.
    const userNameError = isFieldTouched('userName') && getFieldError('userName');
    return (
      <Form layout="inline" onSubmit={this.handleSubmit}>
        <Form.Item
          validateStatus={userNameError ? 'error' : ''}
          help={userNameError || ''}
        >
          {getFieldDecorator('userName', {
            rules: [{ required: true, message: 'Please input your username!' }],
          })(
            <Input prefix={<Icon type="user" style={{ color: 'rgba(0,0,0,.25)' }} />} placeholder="Username" />
          )}
        </Form.Item>
      </Form>
    );
}

2.4 使用注意事項

  1. 定義的 HOC 可以采用with開頭

  2. 不要在render中使用 HOC昧穿,而是在render之外就使用 HOC 定義好新的增強組件,在 render 函數(shù)中直接使用 HOC 返回的增強組件橙喘。原因有以下兩點:

    • 效率:每次render執(zhí)行時时鸵,都使用 HOC 生成新的增強組件,一方面效率較低厅瞎,另一方面virtual DOMreal DOM比較時饰潜,新的增強組件與舊的組件不會認為是相同的。
    • 增強組件的狀態(tài)丟失:每次render執(zhí)行會卸載之前的增強組件和簸,導(dǎo)致其中的state丟失
  3. 靜態(tài)方法需要特別對待:如果在原始組件中定義了靜態(tài)方法彭雾,之后使用 HOC 返回的增強組件是沒有該靜態(tài)方法的。如:

    // Define a static method
    WrappedComponent.staticMethod = function() {
      /*...*/
    };
    // Now apply a HOC
    const EnhancedComponent = enhance(WrappedComponent);
    
    // The enhanced component has no static method
    typeof EnhancedComponent.staticMethod === 'undefined'; // true
    

    要解決這個問題锁保,需要拷貝該靜態(tài)方法:

    function enhance(WrappedComponent) {
      class Enhance extends React.Component {
        /*...*/
      }
      // Must know exactly which method(s) to copy :(
      Enhance.staticMethod = WrappedComponent.staticMethod;
      return Enhance;
    }
    
  4. ref屬性無法傳遞薯酝,原因在于ref不是和其它普通 prop 一起存在props中的半沽,它會被 React 特殊處理,ref只會指向增強組件吴菠,而不是被包裹的原始 Component者填。解決這個問題在于使用React.forwardRef Learn more about it in the forwarding refs section.

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末做葵,一起剝皮案震驚了整個濱河市占哟,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌酿矢,老刑警劉巖榨乎,帶你破解...
    沈念sama閱讀 211,376評論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異棠涮,居然都是意外死亡谬哀,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,126評論 2 385
  • 文/潘曉璐 我一進店門严肪,熙熙樓的掌柜王于貴愁眉苦臉地迎上來史煎,“玉大人,你說我怎么就攤上這事驳糯∑螅” “怎么了?”我有些...
    開封第一講書人閱讀 156,966評論 0 347
  • 文/不壞的土叔 我叫張陵酝枢,是天一觀的道長恬偷。 經(jīng)常有香客問我,道長帘睦,這世上最難降的妖魔是什么袍患? 我笑而不...
    開封第一講書人閱讀 56,432評論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮竣付,結(jié)果婚禮上诡延,老公的妹妹穿的比我還像新娘。我一直安慰自己古胆,他們只是感情好肆良,可當我...
    茶點故事閱讀 65,519評論 6 385
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著逸绎,像睡著了一般惹恃。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上棺牧,一...
    開封第一講書人閱讀 49,792評論 1 290
  • 那天巫糙,我揣著相機與錄音,去河邊找鬼陨帆。 笑死曲秉,一個胖子當著我的面吹牛采蚀,可吹牛的內(nèi)容都是我干的疲牵。 我是一名探鬼主播承二,決...
    沈念sama閱讀 38,933評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼纲爸!你這毒婦竟也來了亥鸠?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,701評論 0 266
  • 序言:老撾萬榮一對情侶失蹤识啦,失蹤者是張志新(化名)和其女友劉穎负蚊,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體颓哮,經(jīng)...
    沈念sama閱讀 44,143評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡家妆,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,488評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了冕茅。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片伤极。...
    茶點故事閱讀 38,626評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖姨伤,靈堂內(nèi)的尸體忽然破棺而出哨坪,到底是詐尸還是另有隱情,我是刑警寧澤乍楚,帶...
    沈念sama閱讀 34,292評論 4 329
  • 正文 年R本政府宣布当编,位于F島的核電站,受9級特大地震影響徒溪,放射性物質(zhì)發(fā)生泄漏忿偷。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,896評論 3 313
  • 文/蒙蒙 一臊泌、第九天 我趴在偏房一處隱蔽的房頂上張望鲤桥。 院中可真熱鬧,春花似錦缺虐、人聲如沸芜壁。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,742評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽慧妄。三九已至,卻和暖如春剪芍,著一層夾襖步出監(jiān)牢的瞬間塞淹,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評論 1 265
  • 我被黑心中介騙來泰國打工罪裹, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留饱普,地道東北人运挫。 一個月前我還...
    沈念sama閱讀 46,324評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像套耕,于是被迫代替她去往敵國和親谁帕。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,494評論 2 348

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