React高级指南(十一)【Higher Order Components】

Higher-Order Components

在React中，高阶组件是重用组件逻辑的一项高级技术。高阶组件并不是React API的一部分。高阶组件源自于React生态。

具体来说，高阶组件是一个函数，能够接受一个组件并返回一个新的组件。

const EnhancedComponent = higherOrderComponent(WrappedComponent);

组件是将props转化成UI，然而高阶组件将一个组价转化成另外一个组件。

React在第三方组件库中非常常见，例如Redux的connect和Relay’screateContainer

在这篇文档中，我们将讨论高阶组件为什么非常有用，并且如何构建。

在横切关注点中使用高阶组件

注意

我们之前介绍的mixins也是处理横切关注点的一种方法。我们已经意识到的mixin的使用时弊大于利。阅读这篇文章了解我们抛弃mixin和如果转换现有的组件。

组件是React中代码重用的最小单元。然而你会发现某些模式并不能直接适应传统组件。

例如，假设你有一个接受外部数据源渲染评论列表的CommentList组件：

class CommentList extends React.Component {  constructor() {    super();    this.handleChange = this.handleChange.bind(this);    this.state = {      // "DataSource" is some global data source      comments: DataSource.getComments()    };  }  componentDidMount() {    // Subscribe to changes    DataSource.addChangeListener(this.handleChange);  }  componentWillUnmount() {    // Clean up listener    DataSource.removeChangeListener(this.handleChange);  }  handleChange() {    // Update component state whenever the data source changes    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} />;  }}

CommentList和BlogPost是等价的，除了它们调用DataSource的不同方法，有不同的输出。但它们大部分的实现是类似的:

• 组件mount结束后，都添加DataSource的change监听
• 除了监听函数，无论什么时候datasource改变之后，都会调用setState
• 组件unmount之后，都会移除监听。

你可以想象在一个大型项目中，订阅DataSource并调用setState的函数将会一次次出现。我们需要将其抽象出来，使得我们能够在一个地方定义逻辑并且在我们的组件中共享。这就是高阶组件的优点。

我们可以写一个函数，能够创建类似于CommentList和BlogPost这类订阅DataSource的新的组件。这个函数接受一个子组件作为参数，这个子组件接受订阅数据源作为props，调用withSubscription如下：

const CommentListWithSubscription = withSubscription(  CommentList,  (DataSource) => DataSource.getComments());const BlogPostWithSubscription = withSubscription(  BlogPost,  (DataSource, props) => DataSource.getBlogPost(props.id)});

第一个参数是被包含的组件，第二个参数根据给定的DataSource和当前的props取回我们需要的数据。

当CommentListWithSubscription和CommentListWithSubscription被渲染时，CommentList和BlogPost将会被传递data属性，其中包含从DataSource取回的最新数据。

// This function takes a component...function withSubscription(WrappedComponent, selectData) {  // ...and returns another component...  return class 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} />;    }  };}

高阶组件既不会修改输入组件，也不会通过继承来复制行为。相反，通过包裹的形式，高阶组件将原先的组件组合在container组件中。高阶组件是纯函数，没有副作用。

就是这样。被包裹的元素接受container的所有props和新的props，并使用其渲染输出。高阶组件并不关心数据将会如何或者为什么使用，并且被包裹的元素并不关心数据的源头。

因为withSubscription只是一个普通函数，你可以按照你的意愿添加很多或者很少的参数。例如，你可能希望data的名字是可以配置的，为了进一步隔离高阶组件和被包裹组件。或者你可以接受一个参数，它可以配置shouldComponentUpdate,或者是可以配置数据的来源。这都是可行的，因为高阶组件可以完全自己控制组件该如何定义。

和组件相类似，withSubscription和被包裹组件的联系是基于props的。只要为被包裹元素提供相同的属性，那么很容易将一个高阶组件组件转化成不同的高阶组件。例如，如果你想要改变数据获取的库，这将非常有用。

不要改变原始组件，而是使用组合

要忍住在高阶组件修改组件原型(或者修改其他)的冲动。

function logProps(InputComponent) {  InputComponent.prototype.componentWillReceiveProps(nextProps) {    console.log('Current props: ', this.props);    console.log('Next props: ', nextProps);  }  // The fact that we're returning the original input is a hint that it has  // been mutated.  return InputComponent;}// EnhancedComponent will log whenever props are receivedconst EnhancedComponent = logProps(InputComponent);

这里存在一些问题，一个是输入组件(InputComponent)不能脱离增强组件分别重用。更重要的是，如果将另一个也修改componentWillReceiveProps的高阶组件应用于EnhancedComponent组件，第一个高阶组件的功能将会别覆盖。这个高阶组件对函数组件不会起作用，因为函数组件没有生命周期函数。

具有修改功能的高阶组件是一个漏洞的抽象过程：用户必须知道它是怎么实现的从而避免与其他高阶组件的冲突。

相比于修改，高阶组件最好是通过将输入组件包裹在容器组件的方式来使用组合:

function logProps(WrappedComponent) {  return class extends React.Component {    componentWillReceiveProps(nextProps) {      console.log('Current props: ', this.props);      console.log('Next props: ', nextProps);    }    render() {      // Wraps the input component in a container, without mutating it. Good!      return <WrappedComponent {...this.props} />;    }  }}

这个高阶组件与之前的修改原型的版本有着相同的功能，但又避免了潜在的冲突可能。其在class类型和函数类型的组件都起作用。并且，因为是纯函数，它可以与其他高阶组件，甚至是自己组合。

你可能已经注意到高阶组件和被称为容器组件(container components)的模式有相同之处。容器组件是分离责任策略的一部分。这个分离策略是关于高层次和低层次关注点之间的责任分离。容器管理着类似订阅和状态这类东西，和给组件传递属性来处理类似渲染UI这类事情。高阶组件使用容器作为其实现的一部分。你可以将高阶组件视为定义参数化容器组件。

约定: 给包裹组件传递不相关的属性(Props)

高阶组件可以向组件添加功能。他不应该大幅度地改变功能。期望地是高阶组件返回的组件和被包裹组件具有相似的界面。

高阶组件应该通过props传递那些与特定功能无关的特性。大多数的高阶组件包含如下的render函数:

render() {  // Filter out extra props that are specific to this HOC and shouldn't be  // passed through  const { extraProp, ...passThroughProps } = this.props;  // Inject props into the wrapped component. These are usually state values or  // instance methods.  const injectedProp = someStateOrInstanceMethod;  // Pass props to wrapped component  return (    <WrappedComponent      injectedProp={injectedProp}      {...passThroughProps}    />  );}

这个约定帮助确定高阶组件能够足够灵活和可以被重用。

约定: 最大化组合(Maximizing Composability)

不是所有的高阶组件看起来都是一样的。有时候，它接受包裹组件作为单一参数：

const NavbarWithRouter = withRouter(Navbar);

通常情况下，高阶组件接受其他的参数。在Relay这个例子中，配置对象用来指定组件的数据依赖关系：

const CommentWithRelay = Relay.createContainer(Comment, config);

高阶组件最常见的签名如下：

// React Redux's `connect`const ConnectedComment = connect(commentSelector, commentActions)(Comment);

什么?!，如果你把它分开，就更容易看到发生了什么。

// connect is a function that returns another functionconst enhance = connect(commentListSelector, commentListActions);// The returned function is an HOC, which returns a component that is connected// to the Redux storeconst ConnectedComment = enhance(CommentList);

总的来说，connect是一个返回高阶组件的高阶函数！

这种形式看起来是混乱的或者是没有必要的，但是它是一个有用的属性。单参数的高阶组件类似于connect函数所返回的函数，其签名为Component => Component。返回的函数的输出类型和输入类型是相同的，很容易相互组合。

// Instead of doing this...const EnhancedComponent = connect(commentSelector)(withRouter(WrappedComponent))// ... you can use a function composition utility// compose(f, g, h) is the same as (...args) => f(g(h(...args)))const enhance = compose(  // These are both single-argument HOCs  connect(commentSelector),  withRouter)const EnhancedComponent = enhance(WrappedComponent)

(这个相同的属性还允许连接和其他增强型高阶属性作为装饰器(decorators),这是一个实验性的JavaScript提案)。

包括lodash(例如lodash.flowRight)、Redux和Ramda在内的许多第三方库都提供了组合函数。

约定:为了方便调试包装显示名称(display name)

由高阶属性创建的容器组件在React开发者工具中显示同其他的组件相似。为了方便调试，选择一个显示名称(display name)，表示它是高阶组件的结果。

最常见的方法是给被包裹元素包裹一个显示名称(display name)。因此，如果你的高阶组件名字为withSubscription，被包裹的元素名称为CommentList，那就选择名称为WithSubscription(CommentList)。

function withSubscription(WrappedComponent) {  class WithSubscription extends React.Component {/* ... */}  WithSubscription.displayName = `WithSubscription(${getDisplayName(WrappedComponent)})`;  return WithSubscription;}function getDisplayName(WrappedComponent) {  return WrappedComponent.displayName || WrappedComponent.name || 'Component';}

警告

高阶组件有以下几个警告，如果你是刚接触React，这些警告可能不会立刻就被发现。

不要在render函数中使用高阶组件

React的diff算法(又称为reconciliation)使用组件标识符(component identity)来决定是否应该更新已有的子树或者将其抛出并安装一个新的子树。如果从render返回的组件等同于(===)之前render函数返回的组件，React将会迭代地通过diff算法更新子树到新的子树。如果不相等，则先前的子树将会完全卸载。

通常情况下，你不需要考虑这些。但是这对高阶组件非常重要，因为这意味你在组件的render方法中不能通过高阶组件产生组件:

render() {  // A new version of EnhancedComponent is created on every render  // EnhancedComponent1 !== EnhancedComponent2  const EnhancedComponent = enhance(MyComponent);  // That causes the entire subtree to unmount/remount each time!  return <EnhancedComponent />;}

这个问题不仅仅关乎于性能，卸载组件会造成组件状态和其子元素全部丢失。

相反地，在组件定义外应用高阶组件，以便生成的组件只会被创建一次。然后，它的标识符在每次渲染中都是相同的。无论如何，这才是你想要的。

在一些极少的例子中你需要动态地引用高阶组件，你可以在组件的声明周期函数中使用或者在构造函数中使用。

静态方法必须复制

有时候，在React组价中定义静态方法是非常有用的。例如，Relay容器对外暴露一个静态方法getFragment，来帮助组合GraphQL代码。

当你将一个组件应用于高阶组件式，虽然原有的组件被容器组件所包裹，但这以为这新的组件没有之前组件的静态函数。

// Define a static methodWrappedComponent.staticMethod = function() {/*...*/}// Now apply an HOCconst EnhancedComponent = enhance(WrappedComponent);// The enhanced component has no static methodtypeof EnhancedComponent.staticMethod === 'undefined' // true

为了解决这个问题，在返回之前，可以向容器组件中复制原有的静态方法：

function enhance(WrappedComponent) {  class Enhance extends React.Component {/*...*/}  // Must know exactly which method(s) to copy :(  Enhance.staticMethod = WrappedComponent.staticMethod;  return Enhance;}

然而，这需要你明确地知道哪些方法需要别复制。你可以使用hoist-non-react-statics来自动复制非React的静态方法。

import hoistNonReactStatic from 'hoist-non-react-statics';function enhance(WrappedComponent) {  class Enhance extends React.Component {/*...*/}  hoistNonReactStatic(Enhance, WrappedComponent);  return Enhance;}

另一个有效的方法是将静态方法与组件本身相分离：

// Instead of...MyComponent.someFunction = someFunction;export default MyComponent;// ...export the method separately...export { someFunction };// ...and in the consuming module, import bothimport MyComponent, { someFunction } from './MyComponent.js';

Refs不会被传递

尽管惯例是高阶组件会给被包裹组件传递所有的属性(props)，但是不会传递refs。因为ref不是一个属性，就像key一样，它是由React特殊处理的。如果你给高阶组件产生的组件的元素添加ref,ref引用的是外层的容器组件的实例，而不是被包裹的组件。

如果你遇到这个问题，最好的解决方法是避免使用ref。有时候，React新手用户依赖于refs，这时候props是更好的选择。

也就是说，也就是说refs有时候是必要的，否则React也不会提供refs。
选中输入框(focusing an input field)是一个你可能希望强制控制组件的例子。在这种例子中，一个解决办法是通过起一个别名，将ref作为一个普通的props传递：

function Field({ inputRef, ...rest }) {  return <input ref={inputRef} {...rest} />;}// Wrap Field in a higher-order componentconst EnhancedField = enhance(Field);// Inside a class component's render method...<EnhancedField  inputRef={(inputEl) => {    // This callback gets passed through as a regular prop    this.inputEl = inputEl  }}/>// Now you can call imperative methodsthis.inputEl.focus();

无论如何，这都是一个完美的解决方案。我们倾向于refs是由库去处理，而不是要求你手动地处理。我们正在寻找解决这个问题的办法，以便在使用高阶组件时不需要注意这个问题。