javascript - 在 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

score 613 · Accepted Answer

我建议在这里查看Dan Abramov（React 核心维护者之一）的答案：

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

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();

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

您可以在此处阅读有关实验悬念的更多信息。

如果你想在 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

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

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

如果您使用 useCallback，请查看 useCallback 的工作原理示例。沙盒。

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>
  );
}

score 98 · Accepted Answer

当您使用异步功能时

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();
}, []);

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

工作代码框

score 45 · Accepted Answer

在 React 提供更好的方法之前，您可以创建一个助手，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，以便您可以根据组件生命周期订阅和取消订阅。

score 22 · Accepted Answer

你也可以使用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>
}

score 19 · Accepted Answer

此处可以使用void 运算符。
代替：

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>;
}

score 15 · Accepted Answer

我通读了这个问题，感觉答案中没有提到实现 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

score 10 · Accepted Answer

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

考虑异步函数 initData

  async function initData() {
  }

此代码将导致您的错误：

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

但是这个，不会：

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

（注意 initData() 周围的括号

score 6 · Accepted Answer

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

像这样：

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();
}, []);

我强烈建议您不要在useEffectHook 中定义您的查询，因为它会无限次重新渲染。而且由于您无法进行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>
))}

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

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

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

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

score 4 · Accepted Answer

尝试

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

score 4 · Accepted Answer

其他答案已经很多例子给出并且解释清楚了，所以我将从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 () => {
  //...
}, [])

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

score 0 · Accepted Answer

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

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;

使用 axios 的相同演示

score 0 · Accepted Answer

请试试这个

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

score 0 · Accepted Answer

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（来自 NoahZinsmeister/web3-react 示例）

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杀死它Aff在cleanup函数中

被Aff实现为状态机（没有承诺）

但这里与我们相关的是：

Aff编码如何停止Aff- 你可以把你的 AbortController 放在这里
如果错误被抛出到光纤或光纤内部，它将停止运行Effects （未测试）和Affs （它不会then从第二个示例运行，所以它不会）setBalance(balance)

score 0 · Accepted Answer

忽略警告，并像这样使用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>);
}

score 0 · Accepted Answer

我知道已经很晚了，但我遇到了同样的问题，我想分享一下我用这样的函数解决了它！

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);
}
}) ()   
}, [])

score 0 · Accepted Answer

将其包装成 auseCallback并将其用作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]);

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

16 回答 16

没有纯文字

带有纯文本

Related

Reference