useRouter

useRouter 钩子允许你在客户端组件内以编程方式更改路由。

建议：除非你对使用 useRouter 有特定要求，否则请使用 <Link> 组件进行导航。

'use client'
 
import { useRouter } from 'next/navigation'
 
export default function Page() {
  const router = useRouter()
 
  return (
    <button type="button" onClick={() => router.push('/dashboard')}>
      Dashboard
    </button>
  )
}

`useRouter()`

router.push(href: string, { scroll: boolean })：执行客户端导航到提供的路由。在浏览器历史堆栈中添加一个新条目。
router.replace(href: string, { scroll: boolean })：执行客户端导航到提供的路由，而不向浏览器历史堆栈中添加新条目。
router.refresh()：刷新当前路由。向服务器发出新请求，重新获取数据请求，并重新渲染服务器组件。客户端将合并更新后的 React 服务器组件有效负载，而不会丢失未受影响的客户端 React（例如 useState）或浏览器状态（例如滚动位置）。
router.prefetch(href: string, options?: { onInvalidate?: () => void })：预取提供的路由以实现更快的客户端转换。当预取数据变得过时时，会调用可选的 onInvalidate 回调。
router.back()：导航回浏览器历史堆栈中的上一条路由。
router.forward()：导航到浏览器历史堆栈中的下一页。

须知:

你绝不能向 router.push 或 router.replace 发送不信任或未经净化的 URL，因为这会使你的网站面临跨站脚本 (XSS) 漏洞。例如，发送到 router.push 或 router.replace 的 javascript: URL 将在你的页面上下文中执行。

当 <Link> 组件在视口中可见时，它会自动预取路由。

如果 fetch 请求被缓存，refresh() 可能会产生相同的结果。其他动态 API（如 cookies 和 headers）也可能改变响应。

onInvalidate 回调在每个预取请求中最多调用一次。它表示你可能希望为更新的路由数据触发新的预取。

从 `next/router` 迁移

使用 App Router 时，useRouter 钩子应从 next/navigation 而不是 next/router 导入。
pathname 字符串已移除，并由 usePathname() 替换。
query 对象已移除，并由 useSearchParams() 替换。
router.events 已替换。请参阅下文。

查看完整迁移指南.

示例

路由器事件

你可以通过组合其他客户端组件钩子（如 usePathname 和 useSearchParams）来监听页面更改。

'use client'
 
import { useEffect } from 'react'
import { usePathname, useSearchParams } from 'next/navigation'
 
export function NavigationEvents() {
  const pathname = usePathname()
  const searchParams = useSearchParams()
 
  useEffect(() => {
    const url = `${pathname}?${searchParams}`
    console.log(url)
    // You can now use the current URL
    // ...
  }, [pathname, searchParams])
 
  return '...'
}

可以将其导入布局中。

import { Suspense } from 'react'
import { NavigationEvents } from './components/navigation-events'
 
export default function Layout({ children }) {
  return (
    <html lang="en">
      <body>
        {children}
 
        <Suspense fallback={null}>
          <NavigationEvents />
        </Suspense>
      </body>
    </html>
  )
}

值得注意的是：<NavigationEvents> 被包裹在 Suspense 边界中，因为 useSearchParams() 在静态渲染期间会导致客户端渲染直到最近的 Suspense 边界。了解更多。

禁用滚动到顶部

默认情况下，Next.js 在导航到新路由时会滚动到页面顶部。你可以通过将 scroll: false 传递给 router.push() 或 router.replace() 来禁用此行为。

'use client'
 
import { useRouter } from 'next/navigation'
 
export default function Page() {
  const router = useRouter()
 
  return (
    <button
      type="button"
      onClick={() => router.push('/dashboard', { scroll: false })}
    >
      Dashboard
    </button>
  )
}

版本历史

版本	更改
`v15.4.0`	为 `router.prefetch` 引入了可选的 `onInvalidate` 回调
`v13.0.0`	引入了 `next/navigation` 中的 `useRouter`。