使用 useSearchParam 钩子函数轻松处理搜索参数

使用 React 的 useSearchParam 钩子轻松从 URL 查询字符串获取参数

在 React 应用中，获取 URL 查询字符串中的参数至关重要。过去，我们依靠繁琐的 URLSearchParams 构造函数来解析查询字符串，这既不优雅也不符合函数组件的声明式风格。幸运的是，React 团队引入了一个更简单、更声明式的解决方案：useSearchParam 钩子。

什么是 useSearchParam 钩子？

useSearchParam 钩子是 React 16.8 版本中引入的一个内置钩子。它返回一个数组，其中包含两个元素：

• searchParams：一个 URLSearchParams 对象，包含查询字符串中的所有键值对。
• setSearchParams：一个函数，用于设置查询字符串。

如何使用 useSearchParam 钩子？

要使用 useSearchParam 钩子，请在组件中调用它。它接受一个可选的参数，该参数指定要获取的特定键。如果没有指定，它将返回所有查询字符串参数。

const [searchParams] = useSearchParam();
const id = searchParams.get('id');

useSearchParam 钩子的优势

useSearchParam 钩子具有许多优势：

• 简单易用： 只需一行代码即可获取查询字符串参数，无需手动解析。
• 声明式： 声明你要什么，而不是关心实现细节。
• 响应式： 当查询字符串更改时，钩子会自动更新状态。

示例

考虑以下示例，其中我们从 URL 中获取 id 参数并使用它来获取用户信息：

import React, { useState, useEffect } from 'react';

const App = () => {
  const [searchParams] = useSearchParam();
  const id = searchParams.get('id');

  const [user, setUser] = useState(null);

  useEffect(() => {
    fetch(`/api/users/${id}`)
      .then(res => res.json())
      .then(data => setUser(data));
  }, [id]);

  return (
    <div>
      <h1>User: {user && user.name}</h1>
    </div>
  );
};

export default App;

常见问题解答

1. 如何设置查询字符串参数？

使用 setSearchParams 函数，如下所示：

setSearchParams({ foo: 'bar' });

2. 如何处理没有查询字符串参数的情况？

使用 searchParams.has() 方法检查特定键是否存在：

if (!searchParams.has('id')) {
  // 执行替代逻辑
}

3. 如何监听查询字符串更改？

使用 useEffect 钩子并将其依赖项设置为 searchParams：

useEffect(() => {
  // 执行操作
}, [searchParams]);

4. 如何将查询字符串参数传递给子组件？

使用 useContext 钩子：

const SearchParamsContext = React.createContext();

const App = () => {
  const [searchParams] = useSearchParam();
  return (
    <SearchParamsContext.Provider value={searchParams}>
      {/* 子组件 */}
    </SearchParamsContext.Provider>
  );
};

const Child = () => {
  const searchParams = useContext(SearchParamsContext);
  return (
    <div>参数：{searchParams.get('id')}</div>
  );
};

5. 如何使用 TypeScript？

TypeScript 类型定义为：

declare function useSearchParam<K extends string>(key?: K): [URLSearchParams, (newParams: URLSearchParamsInit) => void];

结论

useSearchParam 钩子是获取 URL 查询字符串参数的强大而方便的工具。它消除了繁琐的手动解析，使其成为 React 开发人员的宝贵工具。通过其简单易用、声明式和响应式特性，它将帮助你创建交互式和用户友好的应用程序。