插件窝 干货文章 在 React 中创建自定义 Hook 的最佳技巧

在 React 中创建自定义 Hook 的最佳技巧

钩子 strong 挂钩 定义 586    来源:    2024-10-20

react 的自定义 hooks 是从组件中删除可重用功能的有效工具。它们支持代码中的 dry(不要重复)、可维护性和整洁性。但开发有用的自定义钩子需要牢牢掌握 react 的基本思想和推荐程序。在这篇文章中,我们将讨论在 react 中开发自定义钩子的一些最佳策略,并举例说明如何有效地应用它们。

1。了解 hooks 的用途

在深入创建自定义挂钩之前,了解什么是挂钩以及它们存在的原因至关重要。 hooks 允许您在功能组件中使用状态和其他 react 功能。自定义挂钩使您能够将组件逻辑提取到可重用的函数中,这些函数可以在多个组件之间共享。

示例:基本自定义 hook

这是管理计数器的自定义挂钩的简单示例:

import { usestate } from 'react';

function usecounter(initialvalue = 0) {
  const [count, setcount] = usestate(initialvalue);

  const increment = () => setcount(prevcount => prevcount + 1);
  const decrement = () => setcount(prevcount => prevcount - 1);
  const reset = () => setcount(initialvalue);

  return { count, increment, decrement, reset };
}

// usage in a component
// const { count, increment, decrement, reset } = usecounter(10);

2。遵循命名约定

react 有一个约定,自定义挂钩应以“use”一词开头。这不仅仅是一种风格选择——react 依赖于这个约定来自动应用钩子规则(比如不有条件地调用它们)。

提示:始终使用 use 来启动自定义钩子,以确保 react 知道它是一个钩子。

3。保持钩子纯净

自定义钩子应该是纯函数,这意味着它们不应该有修改全局变量或直接与外部系统交互等副作用。如果需要副作用,例如进行 api 调用,则应使用内置 react 钩子(如 useeffect)在钩子内处理它们。

示例:具有副作用的 hook

import { usestate, useeffect } from 'react';

function usefetchdata(url) {
  const [data, setdata] = usestate(null);
  const [error, seterror] = usestate(null);
  const [loading, setloading] = usestate(true);

  useeffect(() => {
    const fetchdata = async () => {
      try {
        const response = await fetch(url);
        const result = await response.json();
        setdata(result);
      } catch (err) {
        seterror(err);
      } finally {
        setloading(false);
      }
    };

    fetchdata();
  }, [url]);

  return { data, error, loading };
}

// usage in a component
// const { data, error, loading } = usefetchdata('https://api.example.com/data');

4。利用现有的 hook
创建自定义挂钩时,请确保利用现有的 react 挂钩,例如 usestate、useeffect、usecontext 等。这确保您的自定义钩子是可组合的,并且可以与 react 的内置功能无缝协作。

示例:组合 hook

这是一个结合 usestate 和 useeffect 来管理本地存储的自定义钩子:

import { usestate, useeffect } from 'react';

function uselocalstorage(key, initialvalue) {
  const [storedvalue, setstoredvalue] = usestate(() => {
    try {
      const item = window.localstorage.getitem(key);
      return item ? json.parse(item) : initialvalue;
    } catch (error) {
      console.error(error);
      return initialvalue;
    }
  });

  useeffect(() => {
    try {
      window.localstorage.setitem(key, json.stringify(storedvalue));
    } catch (error) {
      console.error(error);
    }
  }, [key, storedvalue]);

  return [storedvalue, setstoredvalue];
}

// usage in a component
// const [name, setname] = uselocalstorage('name', 'john doe');

5。可重用性和组合

创建自定义挂钩的主要原因之一是提高可重用性。一个好的自定义钩子应该能够跨多个组件使用,而不需要进行大量修改。此外,钩子可以组合在一起以构建更复杂的逻辑。

提示:专注于提取可能在多个组件之间重用的逻辑。

6。记录你的 hook

像任何代码一样,您的自定义挂钩应该有详细的文档记录。包括解释该钩子的作用、它接受什么参数、它返回什么以及它可能产生的任何副作用的注释。这使其他开发人员(以及未来的您)更容易正确理解和使用您的钩子。

示例:记录 hook

/**
 * usecounter
 * 
 * a custom hook to manage a counter.
 *
 * @param {number} initialvalue - initial value of the counter.
 * @returns {object} { count, increment, decrement, reset } - current count and functions to modify it.
 */
function usecounter(initialvalue = 0) {
  // implementation
}

7。测试你的 hook

测试对于确保您的自定义挂钩按预期运行至关重要。使用 react-hooks-testing-library 或 jest 等测试库为您的钩子编写单元测试。

示例:hook 的基本测试

import { renderHook, act } from '@testing-library/react-hooks';
import useCounter from './useCounter';

test('should increment and decrement counter', () => {
  const { result } = renderHook(() => useCounter(0));

  act(() => {
    result.current.increment();
  });

  expect(result.current.count).toBe(1);

  act(() => {
    result.current.decrement();
  });

  expect(result.current.count).toBe(0);
});

在整个应用程序中抽象和重用功能的一种有效技术是在 react 中使用自定义挂钩。您可以构建可靠且可维护的钩子,通过理解钩子的用途、遵守命名约定、保持钩子纯净、利用现有钩子、保证可重用性、文档化和测试来改进您的 react 开发过程。