React高阶组件详解:使用 TypeScript 实现日志记录组件

阅读时间约为:6 分钟。

本文首发于个人博客:React高阶组件详解:使用 TypeScript 实现日志记录组件


我们知道 React 是一个用于构建用户界面的 JavaScript 库,其中,React 组件是 React 应用程序的核心,它们用于组合并呈现应用程序的不同部分。有时,我们需要增强组件的功能,但又不希望修改原始组件的代码。这时,React 高阶组件(Higher-Order Components,HOC)就派上用场了。

React 高阶组件是一个非常强大的工具,可以帮助我们在不修改现有组件的情况下增强组件功能。在本文中,我们将使用 TypeScript 实现一个简单的日志记录高阶组件示例,并解释如何编写和使用高阶组件。以演示如何使用高阶组件来增强组件功能,而不需要修改原始组件的代码。

什么是高阶组件

高阶组件是一个函数,它接收一个组件作为参数,并返回一个新的组件。新组件包装了原始组件,并增强了它的功能。高阶组件可以用于添加共同的逻辑或功能到多个组件中,这种方法在很多情况下比继承或组件复用更灵活。

在 React 中,高阶组件通常被用于以下场景:

  • 代码复用:将共同的逻辑提取到高阶组件中,以便在多个组件中重复使用。
  • 功能增强:高阶组件可以通过添加或修改 props、渲染逻辑或生命周期方法来增强组件的功能。
  • 渲染劫持:高阶组件可以通过更改组件的渲染行为来修改组件的外观或行为。

实现一个日志记录高阶组件

在本文中,我们将使用 TypeScript 和 React 实现一个简单的日志记录高阶组件,以演示高阶组件的使用方法。

首先,我们定义一个高阶组件函数 withLogging ,它接收一个泛型参数 P ,表示原始组件的 props 类型。该函数返回一个新的函数组件 WithLogging ,这个组件可以包装原始组件并添加日志信息。


import React, { FC } from 'react';

// 高阶函数接收一个泛型参数 P,表示原始组件的 props 类型
interface WithLoggingProps {
  name: string;
}

const withLogging = <P extends object>(WrappedComponent: React.ComponentType<P>) => {
  // 返回一个新的函数组件,这个组件可以包装原始组件
  const WithLogging: FC<P & WithLoggingProps> = (props) => {
    // 在渲染时添加日志信息
    console.log(`Rendering component: ${WrappedComponent.displayName || WrappedComponent.name}`);
    return <WrappedComponent {...props as P} />;
  };
  // 设置新组件的 displayName,便于调试
  WithLogging.displayName = `WithLogging(${WrappedComponent.displayName || WrappedComponent.name})`;
  return WithLogging;
};

withLogging 函数内部,我们创建一个名为 WithLogging 的新函数组件。这个组件会接收原始组件的 props 和一个名为 name 的字符串参数。在渲染时,它会打印一个带有组件名称的日志消息,并渲染原始组件。我们还设置了新组件的 displayName,以便更好地调试。

现在,我们可以使用 withLogging 高阶组件来包装一个原始组件,并增强它的功能。例如,我们可以创建一个简单的无状态组件 Button ,它只是渲染了一个按钮。

// 一个简单的无状态组件
const Button: FC = () => {
  return <button>Click me</button>;
};

现在,我们可以像使用 Button 一样使用 LoggedButton 组件,但是它会在每次渲染后被点击时打印一个日志消息。

// 使用高阶组件包装 Button 组件
const ButtonWithLogging = withLogging(Button);

// 渲染应用程序组件
export default function App() {
  return (
    <div>
      {/* 使用包装后的 Button 组件 */}
      <ButtonWithLogging name="Submit" />
    </div>
  );
}

使用 withLogging 高阶组件,我们可以轻松地添加日志记录和其他功能到多个组件中,而不需要修改这些组件的代码。这使得代码更容易维护,更具可读性。

在浏览器中执行上面的例子,会渲染一个包含一个按钮的页面,并在每次点击按钮时,在浏览器的控制台中打印一条日志信息。这是由于 withLogging 高阶组件包装了 Button 组件,并添加了一个事件监听器,在每次点击按钮时记录一条日志。

假设这个按钮被点击了 5 次,输出到浏览器控制台的结果应该是类似下面这样的内容:

Rendering component: WithLogging(Button)
Rendering component: WithLogging(Button)
Rendering component: WithLogging(Button)
Rendering component: WithLogging(Button)
Rendering component: WithLogging(Button)

总结

React 高阶组件是一个非常强大的工具,可以帮助我们在不修改现有组件的情况下增强组件功能。在本文中,我们使用 TypeScript 和 React 实现了一个简单的日志记录高阶组件,并解释了如何编写和使用高阶组件。通过使用高阶组件,我们可以轻松地添加共同的逻辑或功能到多个组件中,使得代码更容易维护和重用。


喜欢的话,就来微信公众号“若非的日志”一起学习啊~
微信公众号:若非的日志原创

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

推荐阅读更多精彩内容