NNext.js 中文网 GitHub

使用 @next/routing 进行路由

使用 @next/routing 在 adapter 中应用 Next.js 的路由匹配行为。

你可以使用 @next/routing 结合来自 onBuildComplete 的数据来重现 Next.js 的路由匹配行为。

typescript
import { resolveRoutes } from '@next/routing'

const pathnames = [
  ...outputs.pages,
  ...outputs.pagesApi,
  ...outputs.appPages,
  ...outputs.appRoutes,
  ...outputs.staticFiles,
].map((output) => output.pathname)

const result = await resolveRoutes({
  url: new URL(requestUrl),
  buildId,
  basePath: config.basePath || '',
  i18n: config.i18n,
  headers: new Headers(requestHeaders),
  requestBody, // ReadableStream
  pathnames,
  routes: routing,
  invokeMiddleware: async (ctx) => {
    // 特定于平台的 middleware 调用
    return {}
  },
})

if (result.resolvedPathname) {
  console.log('Resolved pathname:', result.resolvedPathname)
  console.log('Resolved query:', result.resolvedQuery)
  console.log('Invocation target:', result.invocationTarget)
}

resolveRoutes() 返回:

  • middlewareResponded:当 middleware 已经发送响应时为 true(adapter 不应调用入口点)。
  • externalRewrite:当路由解析到外部 rewrite 目标时为 URL。
  • redirect:当请求应被重定向时,为包含 url(URL)和 status 的对象。
  • resolvedPathname:由 Next.js 路由选择的路由路径名。对于动态路由,这是匹配到的路由模板,如 /blog/[slug]。
  • resolvedQuery:在 rewrite 或 middleware 添加或替换搜索参数后的最终查询。
  • invocationTarget:为匹配的路由调用的具体路径名和查询。
  • resolvedHeaders:一个 Headers 对象,包含路由期间添加或修改的任何请求头。
  • status:由路由设置的 HTTP 状态码(例如来自重定向或 rewrite 规则)。
  • routeMatches:从动态路由段中提取的命名匹配项的记录。

例如,如果 /blog/post-1?draft=1 匹配 /blog/[slug]?slug=post-1,则 resolvedPathname 为 /blog/[slug],而 invocationTarget.pathname 为 /blog/post-1。