跳到内容
API 参考函数useSearchParams

useSearchParams

useSearchParams 是一个**客户端组件** Hook，它允许您读取当前 URL 的**查询字符串**。

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

app/dashboard/search-bar.tsx
'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，在服务器组件中**不支持**，以防止部分渲染期间出现陈旧值。
  • 如果您想在服务器组件中根据搜索参数获取数据，通常更好的选择是读取相应页面的searchParams prop。然后可以通过 props 将其传递给该页面中的任何组件（服务器或客户端）。
  • 如果应用程序包含 /pages 目录，useSearchParams 将返回 ReadonlyURLSearchParams | null。null 值是为了在迁移期间的兼容性，因为在使用 getServerSideProps 的页面预渲染期间无法知道搜索参数。

行为

静态渲染

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

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

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

例如

app/dashboard/search-bar.tsx
'use client'
 
import { useSearchParams } from 'next/navigation'
 
export default function SearchBar() {
  const searchParams = useSearchParams()
 
  const search = searchParams.get('search')
 
  // This will not be logged on the server when using static rendering
  console.log(search)
 
  return <>Search: {search}</>
}
app/dashboard/page.tsx
import { Suspense } from 'react'
import SearchBar from './search-bar'
 
// This component passed as a fallback to the Suspense boundary
// will be rendered in place of the search bar in the initial HTML.
// When the value is available during React hydration the fallback
// will be replaced with the `<SearchBar>` component.
function SearchBarFallback() {
  return <>placeholder</>
}
 
export default function Page() {
  return (
    <>
      <nav>
        <Suspense fallback={<SearchBarFallback />}>
          <SearchBar />
        </Suspense>
      </nav>
      <h1>Dashboard</h1>
    </>
  )
}

须知:

  • 在开发中，路由是按需渲染的，所以 useSearchParams 不会暂停，而且在没有 Suspense 的情况下可能会正常工作。
  • 在生产构建期间，从客户端组件调用 useSearchParams 的静态页面必须包装在 Suspense 边界中，否则构建将失败并出现缺少带 useSearchParams 的 Suspense 边界错误。
  • 如果您打算动态渲染路由，请优先在服务器组件中首先使用 connection 函数来等待传入请求，这会排除下面的所有内容进行预渲染。请参阅动态渲染指南中使路由动态化的内容。
  • 如果您已经在服务器组件页面中，请考虑使用 searchParams prop 并将值传递给客户端组件。
  • 您还可以将页面 searchParams prop 直接传递给客户端组件，并使用 React 的 use() 解包它。尽管这会导致暂停，因此客户端组件应该用 Suspense 边界包装起来。

动态渲染

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

例如

app/dashboard/search-bar.tsx
'use client'
 
import { useSearchParams } from 'next/navigation'
 
export default function SearchBar() {
  const searchParams = useSearchParams()
 
  const search = searchParams.get('search')
 
  // This will be logged on the server during the initial render
  // and on the client on subsequent navigations.
  console.log(search)
 
  return <>Search: {search}</>
}
app/dashboard/page.tsx
import { connection } from 'next/server'
import SearchBar from './search-bar'
 
export default async function Page() {
  await connection()
  return (
    <>
      <nav>
        <SearchBar />
      </nav>
      <h1>Dashboard</h1>
    </>
  )
}

须知:

  • 以前，在页面上设置 export const dynamic = 'force-dynamic' 用于强制动态渲染。现在建议改用 connection()，因为它在语义上将动态渲染与传入请求关联起来。

服务器组件

页面

要在页面（服务器组件）中访问搜索参数，请使用searchParams prop。

布局

与页面不同，布局（服务器组件）**不**接收 searchParams prop。这是因为共享布局在导航期间不会重新渲染，这可能导致导航之间 searchParams 过时。查看详细解释。

相反，请在客户端组件中使用页面 searchParams prop 或 useSearchParams hook，它会在客户端使用最新的 searchParams 重新渲染。

示例

更新 searchParams

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

app/example-client-component.tsx
'use client'
 
export default function ExampleClientComponent() {
  const router = useRouter()
  const pathname = usePathname()
  const searchParams = useSearchParams()
 
  // Get a new searchParams string by merging the current
  // searchParams with a provided key/value pair
  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>
 
      {/* using useRouter */}
      <button
        onClick={() => {
          // <pathname>?sort=asc
          router.push(pathname + '?' + createQueryString('sort', 'asc'))
        }}
      >
        ASC
      </button>
 
      {/* using <Link> */}
      <Link
        href={
          // <pathname>?sort=desc
          pathname + '?' + createQueryString('sort', 'desc')
        }
      >
        DESC
      </Link>
    </>
  )
}

版本历史

版本更改
v13.0.0useSearchParams 已引入。