高阶组件(Higher-Order Components)

高阶组件(HOC)是 React 中用于重用组件逻辑的高级技术。 HOC 本身不是 React API 的一部分。 它们是从 React 构思本质中浮现出来的一种模式。

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

const EnhancedComponent = higherOrderComponent(WrappedComponent);

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

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

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

使用高阶组件(HOC)解决交叉问题(Cross-Cutting Concerns)

注意

我们之前建议使用mixins作为解决交叉问题的方法。 我们已经意识到mixins会产生的问题比它们带来的价值更加麻烦。 阅读这篇文章了解我们抛弃 mixin 以及如何转换现有的 mixin 组件。

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

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

class CommentList extends React.Component {
  constructor() {
    super();
    this.handleChange = this.handleChange.bind(this);
    this.state = {
      // "DataSource" 就是全局的数据源
      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} />;
  }
}

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

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

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

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

const CommentListWithSubscription = withSubscription(
  CommentList,
  (DataSource) => DataSource.getComments()
);

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

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

CommentListWithSubscriptionCommentListWithSubscription 被渲染时,CommentListBlogPost 将会被传递 data 属性,其中包含从DataSource 取回的最新数据。

// 函数接受一个组件参数……
function withSubscription(WrappedComponent, selectData) {
  // ……返回另一个新组件……
  return class extends React.Component {
    constructor(props) {
      super(props);
      this.handleChange = this.handleChange.bind(this);
      this.state = {
        data: selectData(DataSource, props)
      };
    }

    componentDidMount() {
      // ……注意订阅数据……
      DataSource.addChangeListener(this.handleChange);
    }

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

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

    render() {
      // ……使用最新的数据渲染组件
      // 注意此处将已有的props属性传递给原组件
      return <WrappedComponent data={this.state.data} {...this.props} />;
    }
  };
}

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

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

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

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

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

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

function logProps(InputComponent) {
  InputComponent.prototype.componentWillReceiveProps = function(nextProps) {
    console.log('Current props: ', this.props);
    console.log('Next props: ', nextProps);
  };
  // 我们返回的原始组件实际上已经
  // 被修改了。
  return InputComponent;
}

// EnhancedComponent会记录下所有的props属性
const 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() {
      // 用容器组件组合包裹组件且不修改包裹组件,这才是正确的打开方式。
      return <WrappedComponent {...this.props} />;
    }
  }
}

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

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

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

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

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

render() {
  // 过滤掉与高阶函数功能相关的props属性,
  // 不再传递
  const { extraProp, ...passThroughProps } = this.props;

  // 向包裹组件注入props属性,一般都是高阶组件的state状态
  // 或实例方法
  const injectedProp = someStateOrInstanceMethod;

  // 向包裹组件传递props属性
  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)(CommentList);

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

// connect是一个返回函数的函数(译者注:就是个高阶函数)
const enhance = connect(commentListSelector, commentListActions);
// 返回的函数就是一个高阶组件,该高阶组件返回一个与Redux store
// 关联起来的新组件
const ConnectedComment = enhance(CommentList);

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

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

// 不要这样做……
const EnhancedComponent = connect(commentSelector)(withRouter(WrappedComponent))

// ……你可以使用一个功能组合工具
// compose(f, g, h) 和 (...args) => f(g(h(...args)))是一样的
const enhance = compose(
  // 这些都是单参数的高阶组件
  connect(commentSelector),
  withRouter
)
const EnhancedComponent = enhance(WrappedComponent)

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

许多第三方库提供compose实用功能,包括 lodash (例如lodash.flowRight)、ReduxRamda

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

由高阶属性创建的容器组件在 React Developer Tools 中显示同其他的组件相似。为了方便调试,选择一个显示名称(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() {
  // 每一次render函数调用都会创建一个新的EnhancedComponent实例
  // EnhancedComponent1 !== EnhancedComponent2
  const EnhancedComponent = enhance(MyComponent);
  // 每一次都会使子对象树完全被卸载或移除
  return <EnhancedComponent />;
}

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

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

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

静态方法必须复制

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

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

// 定义静态方法
WrappedComponent.staticMethod = function() {/*...*/}
// 使用高阶组件
const EnhancedComponent = enhance(WrappedComponent);

// 增强型组件没有静态方法
typeof EnhancedComponent.staticMethod === 'undefined' // true

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

function enhance(WrappedComponent) {
  class Enhance extends React.Component {/*...*/}
  // 必须得知道要拷贝的方法 :(
  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;
}

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

// 替代……
MyComponent.someFunction = someFunction;
export default MyComponent;

// ……分别导出……
export { someFunction };

// ……在要使用的组件中导入
import MyComponent, { someFunction } from './MyComponent.js';

Refs不会被传递

虽然高阶组件的惯例是将所有 属性(props) 传递给包裹的组件,但是对 refs 不起作用。 那是因为 ref 不是一个真正的属性(props) - 不像 key。React 对它进行了特殊处理。 如果你向一个由高阶组件创建的组件的元素添加ref应用,那么ref指向的是最外层容器组件实例的,而不是包裹组件。

解决这个问题的方法是使用 React.forwardRef API(在 React 16.3 中引入)。 在 refs 转发章节了解更多信息