Menu

useSearchParams

useSearchParams 是一个客户端组件 hook，让你能够读取当前 URL 的查询字符串。

useSearchParams 返回一个只读版本的 URLSearchParams 接口。

app/dashboard/search-bar.tsx
TypeScript
'use client'
 
import { useSearchParams } from 'next/navigation'
 
export default function SearchBar() {
  const searchParams = useSearchParams()
 
  const search = searchParams.get('search')
 
  // URL -> `/dashboard?search=my-project`
  // `search` -> 'my-project'
  return <>Search: {search}</>
}

参数

const searchParams = useSearchParams()

useSearchParams 不接收任何参数。

返回值

useSearchParams 返回一个只读版本的 URLSearchParams 接口，其中包含用于读取 URL 查询字符串的实用方法：

值得注意的是：

  • useSearchParams 是一个客户端组件 hook，在服务器组件中不支持使用，这是为了防止在部分渲染期间出现过期值。
  • 如果应用程序包含 /pages 目录，useSearchParams 将返回 ReadonlyURLSearchParams | null。在迁移过程中返回 null 值是为了兼容性，因为在不使用 getServerSideProps 的页面预渲染期间无法知道 search params。

行为

静态渲染

如果路由是静态渲染的，调用 useSearchParams 将导致客户端组件树直到最近的 Suspense 边界进行客户端渲染。

这允许路由的一部分进行静态渲染，而使用 useSearchParams 的动态部分则在客户端渲染。

我们建议将使用 useSearchParams 的客户端组件包装在 <Suspense/> 边界中。这将允许其上方的任何客户端组件进行静态渲染，并作为初始 HTML 的一部分发送。示例。

例如：

app/dashboard/search-bar.tsx
TypeScript
'use client'
 
import { useSearchParams } from 'next/navigation'
 
export default function SearchBar() {
  const searchParams = useSearchParams()
 
  const search = searchParams.get('search')
 
  // 使用静态渲染时，这段代码不会在服务器端打印
  console.log(search)
 
  return <>Search: {search}</>
}
app/dashboard/page.tsx
TypeScript
import { Suspense } from 'react'
import SearchBar from './search-bar'
 
// 这个组件作为 Suspense 边界的 fallback
// 将在初始 HTML 中替代搜索栏渲染。
// 当值在 React hydration 期间可用时，
// fallback 将被 `<SearchBar>` 组件替换。
function SearchBarFallback() {
  return <>placeholder</>
}
 
export default function Page() {
  return (
    <>
      <nav>
        <Suspense fallback={<SearchBarFallback />}>
          <SearchBar />
        </Suspense>
      </nav>
      <h1>Dashboard</h1>
    </>
  )
}

动态渲染

如果路由是动态渲染的，useSearchParams 将在客户端组件的初始服务器渲染期间可用。

例如：

app/dashboard/search-bar.tsx
TypeScript
'use client'
 
import { useSearchParams } from 'next/navigation'
 
export default function SearchBar() {
  const searchParams = useSearchParams()
 
  const search = searchParams.get('search')
 
  // 这将在初始渲染时在服务器端打印
  // 并在后续导航时在客户端打印。
  console.log(search)
 
  return <>Search: {search}</>
}
app/dashboard/page.tsx
TypeScript
import SearchBar from './search-bar'
 
export const dynamic = 'force-dynamic'
 
export default function Page() {
  return (
    <>
      <nav>
        <SearchBar />
      </nav>
      <h1>Dashboard</h1>
    </>
  )
}

值得注意的是：设置 dynamic 路由段配置选项 为 force-dynamic 可以强制动态渲染。

服务器组件

Pages

要在 Pages（服务器组件）中访问 search params，使用 searchParams 属性。

Layouts

与 Pages 不同，Layouts（服务器组件）不会接收 searchParams 属性。这是因为共享布局在导航期间不会重新渲染，这可能导致导航之间的 searchParams 过期。查看详细说明。

相反，使用 Page searchParams 属性或在客户端组件中使用 useSearchParams hook，它会在客户端使用最新的 searchParams 重新渲染。

示例

更新 searchParams

你可以使用 useRouter 或 Link 来设置新的 searchParams。执行导航后，当前的 page.js 将接收更新后的 searchParams 属性。

app/example-client-component.tsx
TypeScript
'use client'
 
export default function ExampleClientComponent() {
  const router = useRouter()
  const pathname = usePathname()
  const searchParams = useSearchParams()
 
  // 通过合并当前 searchParams 和提供的键值对
  // 获取新的 searchParams 字符串
  const createQueryString = useCallback(
    (name: string, value: string) => {
      const params = new URLSearchParams(searchParams.toString())
      params.set(name, value)
 
      return params.toString()
    },
    [searchParams]
  )
 
  return (
    <>
      <p>Sort By</p>
 
      {/* 使用 useRouter */}
      <button
        onClick={() => {
          // <pathname>?sort=asc
          router.push(pathname + '?' + createQueryString('sort', 'asc'))
        }}
      >
        ASC
      </button>
 
      {/* 使用 <Link> */}
      <Link
        href={
          // <pathname>?sort=desc
          pathname + '?' + createQueryString('sort', 'desc')
        }
      >
        DESC
      </Link>
    </>
  )
}

版本历史

版本更改
v13.0.0引入 useSearchParams。