React Hooks - 发出 Ajax 请求
React Hooks - Making an Ajax request
我刚开始玩 React hooks,想知道 AJAX 请求应该是什么样子?
我尝试了很多次,但无法让它工作,也不知道实现它的最佳方法。以下是我最近的尝试:
import React, { useState, useEffect } from 'react';
const App = () => {
const URL = 'http://api.com';
const [data, setData] = useState({});
useEffect(() => {
const resp = fetch(URL).then(res => {
console.log(res)
});
});
return (
<div>
// display content here
</div>
)
}
您可以创建一个名为 useFetch
的自定义挂钩,它将实现 useEffect
挂钩。
通过将空数组作为第二个参数传递给 useEffect
挂钩将触发 componentDidMount
上的请求。
Here is a demo in code sandbox.
请参阅下面的代码。
import React, { useState, useEffect } from 'react';
const useFetch = (url) => {
const [data, setData] = useState(null);
// empty array as second argument equivalent to componentDidMount
useEffect(() => {
async function fetchData() {
const response = await fetch(url);
const json = await response.json();
setData(json);
}
fetchData();
}, [url]);
return data;
};
const App = () => {
const URL = 'http://www.example.json';
const result = useFetch(URL);
return (
<div>
{JSON.stringify(result)}
</div>
);
}
工作正常...给你:
import React, { useState, useEffect } from 'react';
const useFetch = url => {
const [data, setData] = useState(null);
const [loading, setLoading] = useState(true);
const fetchUser = async () => {
const response = await fetch(url);
const data = await response.json();
const [user] = data.results;
setData(user);
setLoading(false);
};
useEffect(() => {
fetchUser();
}, []);
return { data, loading };
};
const App = () => {
const { data, loading } = useFetch('https://api.randomuser.me/');
return (
<div className="App">
{loading ? (
<div>Loading...</div>
) : (
<React.Fragment>
<div className="name">
{data.name.first} {data.name.last}
</div>
<img className="cropper" src={data.picture.large} alt="avatar" />
</React.Fragment>
)}
</div>
);
};
现场演示:
编辑
根据版本变化进行了更新(感谢@mgol 将其带到
我在评论中的关注)。
到目前为止答案很好,但我会为您想要触发请求的时间添加一个自定义挂钩,因为您也可以这样做。
function useTriggerableEndpoint(fn) {
const [res, setRes] = useState({ data: null, error: null, loading: null });
const [req, setReq] = useState();
useEffect(
async () => {
if (!req) return;
try {
setRes({ data: null, error: null, loading: true });
const { data } = await axios(req);
setRes({ data, error: null, loading: false });
} catch (error) {
setRes({ data: null, error, loading: false });
}
},
[req]
);
return [res, (...args) => setReq(fn(...args))];
}
如果您愿意,您可以使用此挂钩为特定的 API 方法创建一个函数,但请注意,这种抽象并不是严格必需的,而且可能非常危险(带有如果 hook 在 React 组件函数的上下文之外使用,则不是一个好主意。
const todosApi = "https://jsonplaceholder.typicode.com/todos";
function postTodoEndpoint() {
return useTriggerableEndpoint(data => ({
url: todosApi,
method: "POST",
data
}));
}
最后,在您的功能组件中
const [newTodo, postNewTodo] = postTodoEndpoint();
function createTodo(title, body, userId) {
postNewTodo({
title,
body,
userId
});
}
然后只需将 createTodo
指向 onSubmit
或 onClick
处理程序。 newTodo
将包含您的数据、加载和错误状态。沙盒代码 right here.
这是我认为可行的方法:
import React, { useState, useEffect } from 'react';
const App = () => {
const URL = 'http://api.com';
const [data, setData] = useState({})
useEffect(function () {
const getData = async () => {
const resp = await fetch(URL);
const data = await resp.json();
setData(data);
}
getData();
}, []);
return (
<div>
{ data.something ? data.something : 'still loading' }
</div>
)
}
有几个重要的位:
- 您传递给
useEffect
的函数充当 componentDidMount
这意味着它可能会执行多次。这就是为什么我们要添加一个空数组作为第二个参数,这意味着“这个效果没有依赖性,所以 运行 它只有一次”。
- 你的
App
组件仍然呈现一些东西,即使数据还没有出现。因此,您必须处理未加载数据但呈现组件的情况。顺便说一句,这没有任何变化。我们现在也在这样做。
传统上,您会在 class 组件的 componentDidMount
生命周期中编写 Ajax 调用,并在请求返回时使用 setState
显示返回的数据。
使用钩子,您将使用 useEffect
并传入一个空数组作为第二个参数,以便在组件挂载时进行回调 运行 一次。
这是一个从 API 中获取随机用户配置文件并呈现名称的示例。
function AjaxExample() {
const [user, setUser] = React.useState(null);
React.useEffect(() => {
fetch('https://randomuser.me/api/')
.then(results => results.json())
.then(data => {
setUser(data.results[0]);
});
}, []); // Pass empty array to only run once on mount.
return <div>
{user ? user.name.first : 'Loading...'}
</div>;
}
ReactDOM.render(<AjaxExample/>, document.getElementById('app'));
<script src="https://unpkg.com/react@16.7.0-alpha.0/umd/react.development.js"></script>
<script src="https://unpkg.com/react-dom@16.7.0-alpha.0/umd/react-dom.development.js"></script>
<div id="app"></div>
我发现上面的答案中 useEffect
有很多错误的用法。
不应将异步函数传递到 useEffect
。
让我们看看useEffect
的签名:
useEffect(didUpdate, inputs);
您可以在 didUpdate
函数和 return 处理函数中做副作用。 dispose 函数非常重要,你可以使用它来取消请求,清除定时器等。
任何异步函数都会 return 一个 promise,而不是一个函数,所以 dispose 函数实际上没有任何效果。
所以传入一个异步函数绝对可以处理你的副作用,但它是 Hooks 的反模式 API。
我建议您使用 react-request-hook,因为它涵盖了很多用例(同时多个请求、卸载时的可取消请求和托管请求状态)。它是用 typescript 编写的,因此如果您的项目也使用 typescript,您可以利用它,如果没有,根据您的 IDE,您可能会看到类型提示,并且该库还提供了一些帮助程序允许您安全地键入您期望的请求结果的有效负载。
它经过了很好的测试(100% 的代码覆盖率),您可以像这样简单地使用它:
function UserProfile(props) {
const [user, getUser] = useResource((id) => {
url: `/user/${id}`,
method: 'GET'
})
useEffect(() => getUser(props.userId), []);
if (user.isLoading) return <Spinner />;
return (
<User
name={user.data.name}
age={user.data.age}
email={user.data.email}
>
)
}
image example
作者免责声明:我们一直在生产中使用这个实现。有很多钩子可以处理 promises,但也有一些边缘情况没有被覆盖或没有足够的测试实现。 react-request-hook 甚至在正式发布之前就已经过测试。它的主要目标是在我们处理应用程序最关键的方面之一时经过良好测试和安全使用。
use-http is a little react useFetch hook used like: https://use-http.com
import useFetch from 'use-http'
function Todos() {
const [todos, setTodos] = useState([])
const { request, response } = useFetch('https://example.com')
// componentDidMount
useEffect(() => { initializeTodos() }, [])
async function initializeTodos() {
const initialTodos = await request.get('/todos')
if (response.ok) setTodos(initialTodos)
}
async function addTodo() {
const newTodo = await request.post('/todos', {
title: 'no way',
})
if (response.ok) setTodos([...todos, newTodo])
}
return (
<>
<button onClick={addTodo}>Add Todo</button>
{request.error && 'Error!'}
{request.loading && 'Loading...'}
{todos.map(todo => (
<div key={todo.id}>{todo.title}</div>
)}
</>
)
}
或者,如果你不想自己管理状态,你可以这样做
function Todos() {
// the dependency array at the end means `onMount` (GET by default)
const { loading, error, data } = useFetch('/todos', [])
return (
<>
{error && 'Error!'}
{loading && 'Loading...'}
{data && data.map(todo => (
<div key={todo.id}>{todo.title}</div>
)}
</>
)
}
现场演示
我刚开始玩 React hooks,想知道 AJAX 请求应该是什么样子?
我尝试了很多次,但无法让它工作,也不知道实现它的最佳方法。以下是我最近的尝试:
import React, { useState, useEffect } from 'react';
const App = () => {
const URL = 'http://api.com';
const [data, setData] = useState({});
useEffect(() => {
const resp = fetch(URL).then(res => {
console.log(res)
});
});
return (
<div>
// display content here
</div>
)
}
您可以创建一个名为 useFetch
的自定义挂钩,它将实现 useEffect
挂钩。
通过将空数组作为第二个参数传递给 useEffect
挂钩将触发 componentDidMount
上的请求。
Here is a demo in code sandbox.
请参阅下面的代码。
import React, { useState, useEffect } from 'react';
const useFetch = (url) => {
const [data, setData] = useState(null);
// empty array as second argument equivalent to componentDidMount
useEffect(() => {
async function fetchData() {
const response = await fetch(url);
const json = await response.json();
setData(json);
}
fetchData();
}, [url]);
return data;
};
const App = () => {
const URL = 'http://www.example.json';
const result = useFetch(URL);
return (
<div>
{JSON.stringify(result)}
</div>
);
}
工作正常...给你:
import React, { useState, useEffect } from 'react';
const useFetch = url => {
const [data, setData] = useState(null);
const [loading, setLoading] = useState(true);
const fetchUser = async () => {
const response = await fetch(url);
const data = await response.json();
const [user] = data.results;
setData(user);
setLoading(false);
};
useEffect(() => {
fetchUser();
}, []);
return { data, loading };
};
const App = () => {
const { data, loading } = useFetch('https://api.randomuser.me/');
return (
<div className="App">
{loading ? (
<div>Loading...</div>
) : (
<React.Fragment>
<div className="name">
{data.name.first} {data.name.last}
</div>
<img className="cropper" src={data.picture.large} alt="avatar" />
</React.Fragment>
)}
</div>
);
};
现场演示:
编辑
根据版本变化进行了更新(感谢@mgol 将其带到 我在评论中的关注)。
到目前为止答案很好,但我会为您想要触发请求的时间添加一个自定义挂钩,因为您也可以这样做。
function useTriggerableEndpoint(fn) {
const [res, setRes] = useState({ data: null, error: null, loading: null });
const [req, setReq] = useState();
useEffect(
async () => {
if (!req) return;
try {
setRes({ data: null, error: null, loading: true });
const { data } = await axios(req);
setRes({ data, error: null, loading: false });
} catch (error) {
setRes({ data: null, error, loading: false });
}
},
[req]
);
return [res, (...args) => setReq(fn(...args))];
}
如果您愿意,您可以使用此挂钩为特定的 API 方法创建一个函数,但请注意,这种抽象并不是严格必需的,而且可能非常危险(带有如果 hook 在 React 组件函数的上下文之外使用,则不是一个好主意。
const todosApi = "https://jsonplaceholder.typicode.com/todos";
function postTodoEndpoint() {
return useTriggerableEndpoint(data => ({
url: todosApi,
method: "POST",
data
}));
}
最后,在您的功能组件中
const [newTodo, postNewTodo] = postTodoEndpoint();
function createTodo(title, body, userId) {
postNewTodo({
title,
body,
userId
});
}
然后只需将 createTodo
指向 onSubmit
或 onClick
处理程序。 newTodo
将包含您的数据、加载和错误状态。沙盒代码 right here.
这是我认为可行的方法:
import React, { useState, useEffect } from 'react';
const App = () => {
const URL = 'http://api.com';
const [data, setData] = useState({})
useEffect(function () {
const getData = async () => {
const resp = await fetch(URL);
const data = await resp.json();
setData(data);
}
getData();
}, []);
return (
<div>
{ data.something ? data.something : 'still loading' }
</div>
)
}
有几个重要的位:
- 您传递给
useEffect
的函数充当componentDidMount
这意味着它可能会执行多次。这就是为什么我们要添加一个空数组作为第二个参数,这意味着“这个效果没有依赖性,所以 运行 它只有一次”。 - 你的
App
组件仍然呈现一些东西,即使数据还没有出现。因此,您必须处理未加载数据但呈现组件的情况。顺便说一句,这没有任何变化。我们现在也在这样做。
传统上,您会在 class 组件的 componentDidMount
生命周期中编写 Ajax 调用,并在请求返回时使用 setState
显示返回的数据。
使用钩子,您将使用 useEffect
并传入一个空数组作为第二个参数,以便在组件挂载时进行回调 运行 一次。
这是一个从 API 中获取随机用户配置文件并呈现名称的示例。
function AjaxExample() {
const [user, setUser] = React.useState(null);
React.useEffect(() => {
fetch('https://randomuser.me/api/')
.then(results => results.json())
.then(data => {
setUser(data.results[0]);
});
}, []); // Pass empty array to only run once on mount.
return <div>
{user ? user.name.first : 'Loading...'}
</div>;
}
ReactDOM.render(<AjaxExample/>, document.getElementById('app'));
<script src="https://unpkg.com/react@16.7.0-alpha.0/umd/react.development.js"></script>
<script src="https://unpkg.com/react-dom@16.7.0-alpha.0/umd/react-dom.development.js"></script>
<div id="app"></div>
我发现上面的答案中 useEffect
有很多错误的用法。
不应将异步函数传递到 useEffect
。
让我们看看useEffect
的签名:
useEffect(didUpdate, inputs);
您可以在 didUpdate
函数和 return 处理函数中做副作用。 dispose 函数非常重要,你可以使用它来取消请求,清除定时器等。
任何异步函数都会 return 一个 promise,而不是一个函数,所以 dispose 函数实际上没有任何效果。
所以传入一个异步函数绝对可以处理你的副作用,但它是 Hooks 的反模式 API。
我建议您使用 react-request-hook,因为它涵盖了很多用例(同时多个请求、卸载时的可取消请求和托管请求状态)。它是用 typescript 编写的,因此如果您的项目也使用 typescript,您可以利用它,如果没有,根据您的 IDE,您可能会看到类型提示,并且该库还提供了一些帮助程序允许您安全地键入您期望的请求结果的有效负载。
它经过了很好的测试(100% 的代码覆盖率),您可以像这样简单地使用它:
function UserProfile(props) {
const [user, getUser] = useResource((id) => {
url: `/user/${id}`,
method: 'GET'
})
useEffect(() => getUser(props.userId), []);
if (user.isLoading) return <Spinner />;
return (
<User
name={user.data.name}
age={user.data.age}
email={user.data.email}
>
)
}
image example
作者免责声明:我们一直在生产中使用这个实现。有很多钩子可以处理 promises,但也有一些边缘情况没有被覆盖或没有足够的测试实现。 react-request-hook 甚至在正式发布之前就已经过测试。它的主要目标是在我们处理应用程序最关键的方面之一时经过良好测试和安全使用。
use-http is a little react useFetch hook used like: https://use-http.com
import useFetch from 'use-http'
function Todos() {
const [todos, setTodos] = useState([])
const { request, response } = useFetch('https://example.com')
// componentDidMount
useEffect(() => { initializeTodos() }, [])
async function initializeTodos() {
const initialTodos = await request.get('/todos')
if (response.ok) setTodos(initialTodos)
}
async function addTodo() {
const newTodo = await request.post('/todos', {
title: 'no way',
})
if (response.ok) setTodos([...todos, newTodo])
}
return (
<>
<button onClick={addTodo}>Add Todo</button>
{request.error && 'Error!'}
{request.loading && 'Loading...'}
{todos.map(todo => (
<div key={todo.id}>{todo.title}</div>
)}
</>
)
}
或者,如果你不想自己管理状态,你可以这样做
function Todos() {
// the dependency array at the end means `onMount` (GET by default)
const { loading, error, data } = useFetch('/todos', [])
return (
<>
{error && 'Error!'}
{loading && 'Loading...'}
{data && data.map(todo => (
<div key={todo.id}>{todo.title}</div>
)}
</>
)
}