NNext.js 中文网 GitHub

链接和导航

了解 Next.js 中的导航工作原理,以及如何使用 Link 组件和 useRouter hook。

Next.js 路由允许你在页面之间进行客户端路由切换,类似于单页应用。

提供了一个名为 Link 的 React 组件来实现这种客户端路由切换。

jsx
import Link from 'next/link'

function Home() {
  return (
    <ul>
      <li>
        <Link href="/">Home</Link>
      </li>
      <li>
        <Link href="/about">About Us</Link>
      </li>
      <li>
        <Link href="/blog/hello-world">Blog Post</Link>
      </li>
    </ul>
  )
}

export default Home

上面的示例使用了多个链接。每个链接都将一个路径(href)映射到一个已知的页面:

  • / → pages/index.js
  • /about → pages/about.js
  • /blog/hello-world → pages/blog/[slug].js

对于使用静态生成的页面,视口中的任何 <Link />(初始或通过滚动进入)都会被默认预取(包括相应的数据)。服务端渲染路由的相应数据仅在 <Link /> 被点击时才会获取。

链接到动态路径#

你也可以使用插值来创建路径,这对动态路由段很方便。例如,显示一个作为 prop 传递给组件的文章列表:

jsx
import Link from 'next/link'

function Posts({ posts }) {
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>
          <Link href={`/blog/${encodeURIComponent(post.slug)}`}>
            {post.title}
          </Link>
        </li>
      ))}
    </ul>
  )
}

export default Posts

示例中使用了 encodeURIComponent 来保持路径与 utf-8 兼容。

或者,使用 URL 对象:

jsx
import Link from 'next/link'

function Posts({ posts }) {
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>
          <Link
            href={{
              pathname: '/blog/[slug]',
              query: { slug: post.slug },
            }}
          >
            {post.title}
          </Link>
        </li>
      ))}
    </ul>
  )
}

export default Posts

现在,我们不再使用插值来创建路径,而是在 href 中使用 URL 对象,其中:

  • pathname 是 pages 目录中页面的名称。本例中为 /blog/[slug]。
  • query 是包含动态段的对象。本例中为 slug。

注入路由#

要在 React 组件中访问 router 对象,可以使用 useRouter 或 withRouter。

一般来说,我们建议使用 useRouter。

命令式路由#

next/link 应该能满足你大部分的路由需求,但你也可以在不使用它的情况下进行客户端导航,可以查看 next/router 的文档。

以下示例展示了如何使用 useRouter 进行基本的页面导航:

jsx
import { useRouter } from 'next/router'

export default function ReadMore() {
  const router = useRouter()

  return (
    <button onClick={() => router.push('/about')}>
      Click here to read more
    </button>
  )
}

浅层路由#

<details> <summary>示例</summary>

</details>

浅层路由允许你更改 URL 而无需再次运行数据获取方法,包括 getServerSideProps、getStaticProps 和 getInitialProps。

你将通过 router 对象(由 useRouter 或 withRouter 添加)获得更新后的 pathname 和 query,而不会丢失状态。

要启用浅层路由,请将 shallow 选项设置为 true。请看以下示例:

jsx
import { useEffect } from 'react'
import { useRouter } from 'next/router'

// 当前 URL 为 '/'
function Page() {
  const router = useRouter()

  useEffect(() => {
    // 始终在首次渲染后再进行导航
    router.push('/?counter=10', undefined, { shallow: true })
  }, [])

  useEffect(() => {
    // 计数器变化了!
  }, [router.query.counter])
}

export default Page

URL 将更新为 /?counter=10,页面不会被替换,只有路由的状态发生变化。

你也可以通过 componentDidUpdate 来监听 URL 变化,如下所示:

jsx
componentDidUpdate(prevProps) {
  const { pathname, query } = this.props.router
  // 验证 props 已更改,以避免无限循环
  if (query.counter !== prevProps.router.query.counter) {
    // 根据新的 query 获取数据
  }
}

注意事项#

浅层路由仅适用于当前页面的 URL 变化。例如,假设我们有另一个名为 pages/about.js 的页面,然后你执行以下操作:

js
router.push('/?counter=10', '/about?counter=10', { shallow: true })

由于这是一个新页面,它会卸载当前页面、加载新页面并等待数据获取,即使我们要求进行的是浅层路由。

当浅层路由与 proxy 一起使用时,它不会像以前不使用 proxy 时那样确保新页面与当前页面匹配。这是因为 proxy 能够动态重写,而在不进行(浅层路由所跳过的)数据获取的情况下无法在客户端进行验证,因此浅层路由变化必须始终被视为浅层。

Next.js 中文网