在 useEffect 中针对异步函数的 React Hook 警告：useEffect 函数必须返回一个清理函数或什么都不返回

Question

我正在尝试useEffect 示例，如下所示：

useEffect(async () => {
    try {
        const response = await fetch(`https://www.reddit.com/r/${subreddit}.json`);
        const json = await response.json();
        setPosts(json.data.children.map(it => it.data));
    } catch (e) {
        console.error(e);
    }
}, []);

我在控制台中收到此警告。但是我认为清理对于异步调用是可选的。我不确定为什么会收到此警告。以链接沙箱为例。 https://codesandbox.io/s/24rj871r0p

Answer 1

我建议看Dan Abramov (one of the React core maintainers) answer here:

我认为你让它变得比它需要的更复杂。

function Example() {
  const [data, dataSet] = useState<any>(null)

  useEffect(() => {
    async function fetchMyAPI() {
      let response = await fetch('api/data')
      response = await response.json()
      dataSet(response)
    }

    fetchMyAPI()
  }, [])

  return <div>{JSON.stringify(data)}</div>
}

从长远来看，我们将不鼓励这种模式，因为它鼓励竞争条件。例如 - 在您的通话开始和结束之间可能发生任何事情，并且您可以获得新的道具。相反，我们会推荐 Suspense 来获取数据，看起来更像

const response = MyAPIResource.read();

并且没有效果。但与此同时，您可以将异步内容移至单独的函数并调用它。

你可以阅读更多关于experimental suspense here的信息。

---

如果你想在 eslint 之外使用函数。

 function OutsideUsageExample({ userId }) {
  const [data, dataSet] = useState<any>(null)

  const fetchMyAPI = useCallback(async () => {
    let response = await fetch('api/data/' + userId)
    response = await response.json()
    dataSet(response)
  }, [userId]) // if userId changes, useEffect will run again
               // if you want to run only once, just leave array empty []

  useEffect(() => {
    fetchMyAPI()
  }, [fetchMyAPI])

  return (
    <div>
      <div>data: {JSON.stringify(data)}</div>
      <div>
        <button onClick={fetchMyAPI}>manual fetch</button>
      </div>
    </div>
  )
}

---

如果您将使用 useCallback，请查看它如何工作的示例useCallback。 Sandbox.

import React, { useState, useEffect, useCallback } from "react";

export default function App() {
  const [counter, setCounter] = useState(1);

  // if counter is changed, than fn will be updated with new counter value
  const fn = useCallback(() => {
    setCounter(counter + 1);
  }, [counter]);

  // if counter is changed, than fn will not be updated and counter will be always 1 inside fn
  /*const fnBad = useCallback(() => {
      setCounter(counter + 1);
    }, []);*/

  // if fn or counter is changed, than useEffect will rerun
  useEffect(() => {
    if (!(counter % 2)) return; // this will stop the loop if counter is not even

    fn();
  }, [fn, counter]);

  // this will be infinite loop because fn is always changing with new counter value
  /*useEffect(() => {
    fn();
  }, [fn]);*/

  return (
    <div>
      <div>Counter is {counter}</div>
      <button onClick={fn}>add +1 count</button>
    </div>
  );
}

Answer 2

当你使用异步函数时

async () => {
    try {
        const response = await fetch(`https://www.reddit.com/r/${subreddit}.json`);
        const json = await response.json();
        setPosts(json.data.children.map(it => it.data));
    } catch (e) {
        console.error(e);
    }
}

它返回一个promise并且useEffect不期望回调函数返回Promise，而是期望什么都不返回或者返回一个函数。

作为警告的解决方法，您可以使用自调用异步函数。

useEffect(() => {
    (async function() {
        try {
            const response = await fetch(
                `https://www.reddit.com/r/${subreddit}.json`
            );
            const json = await response.json();
            setPosts(json.data.children.map(it => it.data));
        } catch (e) {
            console.error(e);
        }
    })();
}, []);

或者为了更简洁，你可以定义一个函数然后调用它

useEffect(() => {
    async function fetchData() {
        try {
            const response = await fetch(
                `https://www.reddit.com/r/${subreddit}.json`
            );
            const json = await response.json();
            setPosts(json.data.children.map(it => it.data));
        } catch (e) {
            console.error(e);
        }
    };
    fetchData();
}, []);

第二种解决方案将更易于阅读，并且将帮助您编写代码以在触发新请求时取消先前的请求或将最新的请求响应保存在状态中

Working codesandbox

Answer 3

在 React 提供更好的方法之前，你可以创建一个 helper，useEffectAsync.js：

import { useEffect } from 'react';


export default function useEffectAsync(effect, inputs) {
    useEffect(() => {
        effect();
    }, inputs);
}

现在你可以传递一个异步函数了：

useEffectAsync(async () => {
    const items = await fetchSomeItems();
    console.log(items);
}, []);

更新

如果您选择这种方法，请注意它的形式不好。当我知道它是安全的时，我会使用它，但它总是很糟糕而且很随意。

Suspense for Data Fetching，仍处于试验阶段，将解决部分情况。

在其他情况下，您可以将异步结果建模为事件，以便您可以根据组件生命周期添加或删除侦听器。

或者您可以将异步结果建模为Observable，以便您可以根据组件生命周期订阅和取消订阅。

Answer 4

您也可以使用IIFE 格式来保持简短

function Example() {
    const [data, dataSet] = useState<any>(null)

    useEffect(() => {
        (async () => {
            let response = await fetch('api/data')
            response = await response.json()
            dataSet(response);
        })();
    }, [])

    return <div>{JSON.stringify(data)}</div>
}

Answer 5

void operator 可以在这里使用。
而不是：

React.useEffect(() => {
    async function fetchData() {
    }
    fetchData();
}, []);

或

React.useEffect(() => {
    (async function fetchData() {
    })()
}, []);

你可以写：

React.useEffect(() => {
    void async function fetchData() {
    }();
}, []);

它更干净更漂亮。

---

异步效果可能会导致内存泄漏，因此在卸载组件时执行清理非常重要。在 fetch 的情况下，这可能如下所示：

function App() {
    const [ data, setData ] = React.useState([]);

    React.useEffect(() => {
        const abortController = new AbortController();
        void async function fetchData() {
            try {
                const url = 'https://jsonplaceholder.typicode.com/todos/1';
                const response = await fetch(url, { signal: abortController.signal });
                setData(await response.json());
            } catch (error) {
                console.log('error', error);
            }
        }();
        return () => {
            abortController.abort(); // cancel pending fetch request on component unmount
        };
    }, []);

    return <pre>{JSON.stringify(data, null, 2)}</pre>;
}

Answer 6

我通读了这个问题，感觉答案中没有提到实现 useEffect 的最佳方法。 假设您有一个网络呼叫，并且想要在收到响应后做某事。 为了简单起见，让我们将网络响应存储在状态变量中。 可能需要使用 action/reducer 来使用网络响应更新存储。

const [data, setData] = useState(null);

/* This would be called on initial page load */
useEffect(()=>{
    fetch(`https://www.reddit.com/r/${subreddit}.json`)
    .then(data => {
        setData(data);
    })
    .catch(err => {
        /* perform error handling if desired */
    });
}, [])

/* This would be called when store/state data is updated */
useEffect(()=>{
    if (data) {
        setPosts(data.children.map(it => {
            /* do what you want */
        }));
    }
}, [data]);

参考 => https://reactjs.org/docs/hooks-effect.html#tip-optimizing-performance-by-skipping-effects

Answer 7

对于其他读者，错误可能来自于没有括号包裹异步函数的事实：

考虑异步函数initData

  async function initData() {
  }

这段代码会导致你的错误：

  useEffect(() => initData(), []);

但是这个，不会：

  useEffect(() => { initData(); }, []);

（注意 initData() 周围的括号

Answer 8

要使用React Hooks 从外部API 获取，您应该调用从useEffect 钩子内部的API 获取的函数。

像这样：

async function fetchData() {
    const res = await fetch("https://swapi.co/api/planets/4/");
    res
      .json()
      .then(res => setPosts(res))
      .catch(err => setErrors(err));
  }

useEffect(() => {
    fetchData();
}, []);

我强烈建议您不要在useEffect Hook 中定义您的查询，因为它会无限次地重新渲染。而且由于您无法使 useEffect 异步，因此您可以将其中的函数设为异步。

在上面显示的示例中，API 调用在另一个分离的异步函数中，因此它确保调用是异步的并且只发生一次。另外，useEffect's 依赖数组（[]）是空的，这意味着它的行为就像 React 类组件中的 componentDidMount，它只会在组件挂载时执行一次。

对于加载文本，您可以使用 React 的 条件渲染 来验证您的帖子是否为空，如果是，则渲染加载文本，否则，显示帖子。当您完成从 API 获取数据并且帖子不为空时，else 将为真。

{posts === null ? <p> Loading... </p> 
: posts.map((post) => (
    <Link key={post._id} to={`/blog/${post.slug.current}`}>
      <img src={post.mainImage.asset.url} alt={post.mainImage.alt} />
      <h2>{post.title}</h2>
   </Link>
))}

我看到您已经在使用条件渲染，所以我建议您更深入地研究它，尤其是在验证对象是否为空时！

如果您需要有关使用 Hook 使用 API 的更多信息，我建议您阅读以下文章。

https://betterprogramming.pub/how-to-fetch-data-from-an-api-with-react-hooks-9e7202b8afcd

https://reactjs.org/docs/conditional-rendering.html

Answer 9

其他的答案已经很多例子给出并且解释清楚了，所以我会从TypeScript类型定义的角度来解释。

useEffect 钩子 TypeScript 签名：

function useEffect(effect: EffectCallback, deps?: DependencyList): void;

effect的类型：

// NOTE: callbacks are _only_ allowed to return either void, or a destructor.
type EffectCallback = () => (void | Destructor);

// Destructors are only allowed to return void.
type Destructor = () => void | { [UNDEFINED_VOID_ONLY]: never };

现在我们应该知道为什么effect 不能是async 函数。

useEffect(async () => {
  //...
}, [])

异步函数将返回一个带有隐式 undefined 值的 JS 承诺。这不是useEffect的期望。

Answer 10

试试

const MyFunctionnalComponent: React.FC = props => {
  useEffect(() => {
    // Using an IIFE
    (async function anyNameFunction() {
      await loadContent();
    })();
  }, []);
  return <div></div>;
};

Answer 11

将其包装成useCallback 并将其用作useEffect 挂钩的依赖项。

const getPosts = useCallback(async () => {
    try {
        const response = await fetch(`https://www.reddit.com/r/${subreddit}.json`);
        const json = await response.json();
        setPosts(json.data.children.map(it => it.data));
    } catch (e) {
        console.error(e);
    }
}, []);

useEffect(async () => {
    getPosts();
}, [getPosts]);

Answer 12

只是关于纯脚本语言如何使用Aff monad 处理这个过时效果问题的说明

没有纯文本

你必须使用 AbortController

function App() {
    const [ data, setData ] = React.useState([]);

    React.useEffect(() => {
        const abortController = new AbortController();
        void async function fetchData() {
            try {
                const url = 'https://jsonplaceholder.typicode.com/todos/1';
                const response = await fetch(url, { signal: abortController.signal });
                setData(await response.json());
            } catch (error) {
                console.log('error', error);
            }
        }();
        return () => {
            abortController.abort(); // cancel pending fetch request on component unmount
        };
    }, []);

    return <pre>{JSON.stringify(data, null, 2)}</pre>;
}

或stale (from NoahZinsmeister/web3-react example)

function Balance() {
  const { account, library, chainId } = useWeb3React()

  const [balance, setBalance] = React.useState()
  React.useEffect((): any => {
    if (!!account && !!library) {      
      let stale = false
      
      library 
        .getBalance(account)
        .then((balance: any) => {
          if (!stale) {
            setBalance(balance)
          }
        })
        .catch(() => {
          if (!stale) {
            setBalance(null)
          }
        })

      return () => { // NOTE: will be called every time deps changes
        stale = true
        setBalance(undefined)
      }
    }
  }, [account, library, chainId]) // ensures refresh if referential identity of library doesn't change across chainIds

  ...

带有纯文本

检查如何useAff kills it's Aff in the cleanup function

Aff 被实现为state machine (without promises)

但这里与我们相关的是：

• the Aff encodes how to stop the Aff - 你可以把你的 AbortController 放在这里
• 它将停止运行Effects（未测试）和Affs（它不会从第二个示例运行then，因此它不会setBalance(balance)）如果错误是thrown TO the fiber OR INSIDE the fiber

Answer 13

请试试这个

 useEffect(() => {
        (async () => {
          const products = await api.index()
          setFilteredProducts(products)
          setProducts(products)
        })()
      }, [])

Answer 14

使用自定义 library 提供的 useAsyncEffect 挂钩，安全地执行异步代码和在效果内发出请求变得微不足道，因为它使您的代码可以自动取消（这只是功能列表中的一件事）。查看Live Demo with JSON fetching

import React from "react";
import { useAsyncEffect } from "use-async-effect2";
import cpFetch from "cp-fetch";

/*
 Notice: the related network request will also be aborted
 Checkout your network console
 */

function TestComponent(props) {
  const [cancel, done, result, err] = useAsyncEffect(
    function* () {
      const response = yield cpFetch(props.url).timeout(props.timeout);
      return yield response.json();
    },
    { states: true, deps: [props.url] }
  );

  return (
    <div className="component">
      <div className="caption">useAsyncEffect demo:</div>
      <div>
        {done ? (err ? err.toString() : JSON.stringify(result)) : "loading..."}
      </div>
      <button className="btn btn-warning" onClick={cancel} disabled={done}>
        Cancel async effect
      </button>
    </div>
  );
}

export default TestComponent;

The same demo using axios

Answer 15

忽略警告，使用 useEffect 钩子和 async function 像这样：

import { useEffect, useState } from "react";

function MyComponent({ objId }) {
  const [data, setData] = useState();

  useEffect(() => {
    if (objId === null || objId === undefined) {
      return;
    }

    async function retrieveObjectData() {
      const response = await fetch(`path/to/api/objects/${objId}/`);
      const jsonData = response.json();
      setData(jsonData);
    }
    retrieveObjectData();

  }, [objId]);

  if (objId === null || objId === undefined) {
    return (<span>Object ID needs to be set</span>);
  }

  if (data) {
    return (<span>Object ID is {objId}, data is {data}</span>);
  }

  return (<span>Loading...</span>);
}

Answer 16

这种情况最好使用SWR。

基本示例：

import useSWR from 'swr'

function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)

  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

在这个例子中，useSWR 钩子接受一个密钥字符串和一个提取函数。 key 是数据的唯一标识符（通常是 API URL），将传递给fetcher。 fetcher 可以是任何异步函数返回数据，你可以使用原生 fetch 或 Axios 之类的工具。

所以 fetcher 基本上可以定义为：

import fetch from 'unfetch'
const fetcher = url => fetch(url).then(r => r.json())

挂钩根据请求的状态返回 2 个值：数据和错误。

因此，您还可以获得错误处理和许多其他很酷的功能，例如 Automatic Revalidation。

来源：React Hooks for Data Fetching