react new context API的一次实践

最新推荐文章于 2024-04-19 09:51:45 发布

weixin_34283445

最新推荐文章于 2024-04-19 09:51:45 发布

阅读量84

点赞数

文章标签： javascript ViewUI

原文链接：https://juejin.im/post/5a900daaf265da4e8a3202c6

版权

最近接到一个简单的内部项目，逻辑并不复杂，就想着不用redux了，用react的new context API试试看，折腾了两天，把过程和感想跟大家分享下。

由于是公司的项目，所以下文的示例代码都是我重新写的，望见谅！

基本用法

先让我们来看一下这个接口的基本用法：使用它首先需要使用react的createContext方法创建一个实例：

import React, { createContext } from "react";
const Context = createContext();
复制代码

Context实例提供两个组件：Provider和Consumer

const ContextProvider = Context.Provider;
const ContextConsumer = Context.Consumer;

复制代码

其中ContextProvider是数据的发布方，而ContextConsumer是数据的订阅方。

<ContextProvider value={{ name: "A", age: 18 }}>
    <ContextConsumer>
        {
            context => (
                <div>
                    name:&nbsp;
                    <span>{context.name}</span>
                    &nbsp;age:&nbsp;
                    <span>{context.age}</span>
                </div>
            )
        }
    </ContextConsumer>
</ContextProvider>
复制代码

ContextProvider是数据的发布方。它拥有一个名为value的属性，用于维护数据内容，通过value传递给ContextProvider的数据会被发布出去。而ContextConsumer是数据的订阅方，它的props.children是一个函数，接收的参数是被发布的数据，我们通过调用这个函数来获取被ContextProvider发布的数据，并且返回我们想要渲染的组件。在这个示例中，我们最后在页面上能够显示出name: A age: 18。

关于调用createContext方法时候的传参，理论上第一个传参应该是初始化的数据，但是我使用后发现，如果在ContextProvider的value属性中不传入对应的属性的话，无法在ContextConsumer中获取到那个初始化的属性。

const Context = createContext({ name: "A" });
<Context.Provider value={{ age: 18 }}>
    <Context.Consumer>
        {
            context => (
                <div>
                    name:&nbsp;
                    <span>{context.name}</span>
                    &nbsp;age:&nbsp;
                    <span>{context.age}</span>
                </div>
            )
        }
    </Context.Consumer>
</Context.Provider>
复制代码

这个例子中，name的值无法被获取到。我目前还没找到原因，如果知道的朋友请告诉我一下，谢谢！

补充

关于我这个问题的答案，感谢 @我很西瓜的瓜朋友的解答，我去试了下，果然是这样：只有当Provider不被使用，也就是Context仅仅被用作订阅数据而不是用来发布数据的时候，调用createContext()方法时传递的数据才会被当作当作源数据发布；而使用Provider来发布数据的时候，Provider的value属性会把初始化的数据覆盖掉。

实践

为了适应项目的需求，我主要是对ContextProvider和ContextConsumer做了封装。

ContextProvider

由于在我的项目中组件需要订阅并且修改和维护被发布的数据，所以我需要有一个可以维护这些数据的地方。因此我创建了一个名为MyProvider的高阶组件，并把它放在组件树的顶层，而各个组件需要订阅的数据就存放在MyProvider的state中，那么我只需要维护它的state就能维护这些全局的数据了。

export class MyProvider extends React.Component {
  constructor() {
    super();
    this.state = {
      name: "A",
      age: 18
    };
    this.updateContext = this.updateContext.bind(this);
  }
  updateContext(newData) {
    this.setState(Object.assign({}, this.state, newData));
  }
  render() {
    const contextData = { data: this.state };
    Object.defineProperty(contextData, "updateContext", {
      value: this.updateContext
    });
    return (
      <Context.Provider value={contextData}>
        {this.props.children}
      </Context.Provider>
    );
  }
}
复制代码

MyProvider组件返回的是ContextProvider组件，并把MyProvider的state作为要发布的数据绑定到了ContextProvider的value属性上。前面讲过，由于其他组件有要修改被发布数据的需求，所以我给数据添加了一个不可修改的方法updateContext，这个方法能够接收新的数据并更新MyProvider的state，即更新了被发布的数据。最后，MyProvider组件将自己的children原封不动的传递给ContextProvider。

ContextConsumer

考虑到ContextConsumer作为订阅方使用比较频繁，为了方便其他组件的使用，我将它封装到高阶组件中，并作为函数的返回值使用，如下：

export const MyConsumer = Component => {
  return props => (
    <Context.Consumer>
      {context => {
        return <Component context={context} {...props} />;
      }}
    </Context.Consumer>
  );
};
复制代码

MyConsumer函数返回一个高阶组件。在这个高阶组件中，我把ContextConsumer提供的数据加入到Component的props中，这样我只需要在export组件的时候调用MyConsumer，并且在组件中使用this.props.context.data就能得到被发布的数据了。如下：

class MyComponent extends React.Component {
  addAge() {
    const { data: { age }, updateContext } = this.props.context;
    const newAge = age + 1;
    updateContext({ age: newAge });
  }
  render() {
    const { name, age } = this.props.context.data;
    return (
      <div>
        name:
        <span>{name}</span>
        age:
        <span>{age}</span>
        <button onClick={() => this.addAge()}>add age</button>
      </div>
    );
  }
}

export default Consumer(MyComponent);
复制代码

在这个例子中，点击按钮，调用this.props.context.updateContext方法就可以通过更新MyProvider的state来修改被发布数据中的age的值。

示例代码：react-new-context-api-demo