使用Typescript在react中编写高阶组件

介绍

在构建React应用程序时,通常需要在组件之间共享某些组件逻辑。 React可以使用许多模式来实现这一目标,其中最先进的,也是最受欢迎的模式是高阶组件。 本指南将说明如何使用Typescript语言在React中使用高阶组件来确保某些类型的安全性。

什么是高阶组件?

高阶组件类似于在函数编程中广泛使用的高阶函数模式。

尽可能简单地说,高阶组件是一个将组件作为参数并返回新组件的函数。 该函数应该是一个纯函数,因为它不会修改传递的组件并且没有其他副作用,并且通常会将传递的组件包装在另一个组件中以添加一些行为或注入一些预期的数据,或者有时两者。

可以在此处找到更完整的React高阶组件描述。

React组件

本指南将从包含标题,正文和页脚的React页面开始,该页面将在挂载时进行API调用以检索某些数据并将其显示在正文中。 然后,这将用于创建两个高阶组件,一个将在页眉和页脚中显示一个组件,另一个将从API读取数据并将数据注入组件的props。

初始组件的代码在这里:

class Page extends React.Component {
  state = { things: [] as string[] };
  async componentDidMount() {
    const things = await getThings();
    this.setState({ things });
  }
  render() {
    return (
      <>
        <header className="app-header">
          ....
        </header>
        <div className="app-body">
          <ul>
            {this.state.things.map(thing => (
              <li key={thing}>{thing}</li>
            ))}
          </ul>
        </div>
        <footer className="app-footer">
          ...
        </footer>
      </>);
  }
}

使用高阶组件

首先要做的是创建一个新的高阶组件,它将一个组件显示在页面的正文部分,将该组件放在一个<div>中,并提供页眉和页脚元素。

此函数的签名如下所示:

  function withHeaderAndFooter<T>(Component: React.ComponentType<T>)

在这个签名中,<T>是一个Typescript泛型类型。在这种情况下,T表示在渲染高阶组件时传递的组件props的类型,并且由于没有注入新的props,返回的组件应该拥有与原版相同类型的props。 完整功能的代码在这里:

function withHeaderAndFooter<T>(Component: React.ComponentType<T>) {
  return (props: T) => (
    <>
      <header className="app-header">
        ...
      </header>
      <div className="app-body">
        <Component {...props} />
      </div>
      <footer className="app-footer">
        ...
      </footer>
    </>);
}

此组件以与原react组件相同的方式呈现页眉和页脚,并在正文<div>中呈现传递的组件。传递到高阶组件的props使用对象扩展运算符传递到此组件中,如此{ ...props}

在高阶组件中注入props

将props注入组件可能是更高阶组件的更常用的用例。

原始react组件调用API来获取一些数据然后呈现它。这种行为也可以被提取到一个高阶组件中,该组件将在挂载时调用API并通过其props将数据传递到提供的组件中。

首先要做的是定义一个将数据描述为prop的接口:

interface ThingsProps {
  things: string[];
}

然后函数签名将如下所示:

function withThings<T extends ThingsProps>(Component: React.ComponentType<T>)

在这种情况下,签名使用泛型类型T指定props类型并扩展ThingsProps接口,这意味着传递给此函数的任何组件必须在其props中实现该接口。

因为thingsprop是由高阶组件注入的,所以直接返回props的组件是不正确的,因为组件的任何使用者都需要包含ThingsProps, 解决此问题的一种方法是使用Omit运算符,它接受一个类型T并从中删除ThingsProps类型中存在的任何属性。然后,这个高阶组件可以返回一个类型为Omit <T,ThingsProps>的props组件,使用者不需要提供ThingsProps,从而避免了Typescript编译器将抛出错误。

该函数的代码在这里:

function withThings<T extends ThingsProps>(Component: React.ComponentType<T>) {
  return (props)<Omit<T, keyof ThingsProps>> => {
    const [things, setThings] = React.useState([] as string[]);
    const fetchThings = async () => {
      const things = await getThings();
      setThings(things);
    }
    React.useEffect(() => {
      fetchThings()
    }, []);

    render() {
      return <Component {...this.props as T} things={things} />;
    }
  };
}

渲染此组件时,使用{ ... this.props }props传递到高阶组件,同时thing这个属性prop也设置为things的当前值,因此在使用这个组件时thing这个属性将使用API调用中的数据赋值。在这种情况下,必须将this.props强制转换为类型T,否则,Typescript编译器将抛出错误。

使用高阶的组件

正如预期的那样,使用这些新的高阶组件就是一个用现有组件调用该函数的情况,该组件具有正确的props并呈现函数的结果。 所以withHeaderAndFooter高阶组件可以像这样使用:

function helloWorld() {
  return <div>Hello world</div>;
}

const HelloWorldPage = withHeaderAndFooter(helloWorld);
return <HelloWorldPage />;

HelloWorldPage组件现在由标题,正文和页脚组成,正文中显示文本“Hello world”。

helloWorld组件传递给withThings高阶组件将导致Typescript编译器出错,因为withThings需要一个具有ThingsProps定义thing属性的组件。这个高阶组件可以像这样使用:

function helloThings(props: ThingsProps) {
  return (
    <ul>
      {props.things.map(thing => (
        <li key={thing}>{thing}</li>
      ))}
    </ul>);
}

const HelloThingsPage = withThings(helloThings);
return <HelloThingsPage />;

正如在创建withThings组件时所讨论的那样,在渲染时不需要传递thing prop,因为这是由高阶组件处理的。

创建一个由withHeaderAndFooterwithThings高阶组件组成的组件只是将结果从一个传递到另一个的问题。因此,创建一个组件,用于将页眉,页脚和正文中的helloThings组件包装在页面中还注入了thing,可以这样做:

const HelloThingsPage = withThings(helloThings);
const FullPage = withHeaderAndFooter(HelloThingsPage);

或者像这样组成一行:

const FullPage = withHeaderAndFooter(withThings(helloThings));

使用<FullPage />生成的FullPage组件现在与原始组件相同。

调用高阶组件的顺序没有区别,withThings(withHeaderAndFooter(helloThings))可以实现相同的结果。

参考
ts-higher-order-components
Higher Order Composition with Typescript for React
TypeScript 高级技巧

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,425评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,058评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,186评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,848评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,249评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,554评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,830评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,536评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,239评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,505评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,004评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,346评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,999评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,060评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,821评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,574评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,480评论 2 267

推荐阅读更多精彩内容