server/ · Nuxt 目录结构

Nuxt 会自动扫描这些目录中的文件，以注册 API 和服务器处理程序，并支持热模块替换 (HMR)。

目录结构

-| server/
---| api/
-----| hello.ts      # /api/hello
---| routes/
-----| bonjour.ts    # /bonjour
---| middleware/
-----| log.ts        # log all requests

每个文件应导出一个使用 defineEventHandler() 或 eventHandler() (别名) 定义的默认函数。

处理程序可以直接返回 JSON 数据、一个 Promise，或者使用 event.node.res.end() 发送响应。

server/api/hello.ts

export default defineEventHandler
((event
) => {
  return {
    hello
: 'world'
  }
})

你现在可以在你的页面和组件中全局调用这个 API

pages/index.vue

<script setup lang="ts">
const { data } = await useFetch('/api/hello')
</script>

<template>
  <pre>{{ data }}</pre>
</template>

服务器路由

~/server/api 内的文件会在其路由中自动添加 /api 前缀。

要在没有 /api 前缀的情况下添加服务器路由，请将它们放入 ~/server/routes 目录中。

示例

server/routes/hello.ts

export default defineEventHandler(() => 'Hello World!')

给定以上示例，/hello 路由可以在 https://127.0.0.1:3000/hello 访问。

请注意，目前服务器路由不支持像页面那样的动态路由的全部功能。

服务器中间件

Nuxt 将自动读取 ~/server/middleware 中的任何文件，为你的项目创建服务器中间件。

中间件处理程序将在任何其他服务器路由之前在每次请求上运行，以添加或检查标头、记录请求或扩展事件的请求对象。

中间件处理程序不应返回任何内容（也不应关闭或响应请求），而只能检查或扩展请求上下文或抛出错误。

示例

server/middleware/log.ts

export default defineEventHandler((event) => {
  console.log('New request: ' + getRequestURL(event))
})

server/middleware/auth.ts

export default defineEventHandler((event) => {
  event.context.auth = { user: 123 }
})

服务器插件

Nuxt 会自动读取 ~/server/plugins 目录中的任何文件，并将它们注册为 Nitro 插件。这允许扩展 Nitro 的运行时行为并挂钩生命周期事件。

示例

server/plugins/nitroPlugin.ts

export default defineNitroPlugin((nitroApp) => {
  console.log('Nitro plugin', nitroApp)
})

阅读 Nitro 插件了解更多信息。

服务器实用程序

服务器路由由 unjs/h3 提供支持，它带有一组方便的助手。

阅读可用的 H3 请求助手了解更多信息。

你可以在 ~/server/utils 目录中添加更多助手。

例如，你可以定义一个自定义处理程序实用程序，该实用程序包装原始处理程序并在返回最终响应之前执行其他操作。

示例

server/utils/handler.ts

import type { EventHandler, EventHandlerRequest } from 'h3'

export const defineWrappedResponseHandler = <T extends EventHandlerRequest, D> (
  handler: EventHandler<T, D>
): EventHandler<T, D> =>
  defineEventHandler<T>(async event => {
    try {
      // do something before the route handler
      const response = await handler(event)
      // do something after the route handler
      return { response }
    } catch (err) {
      // Error handling
      return { err }
    }
  })

服务器类型

此功能从 Nuxt >= 3.5 开始可用

为了提高 IDE 中来自 'nitro' 和 'vue' 的自动导入的清晰度，你可以添加一个具有以下内容的 ~/server/tsconfig.json

server/tsconfig.json

{
  "extends": "../.nuxt/tsconfig.server.json"
}

目前，当进行类型检查 (nuxi typecheck) 时，这些值不会被遵守，但你应该在 IDE 中获得更好的类型提示。

食谱

路由参数

服务器路由可以在文件名中使用方括号内的动态参数，如 /api/hello/[name].ts，并通过 event.context.params 访问。

server/api/hello/[name].ts

export default defineEventHandler((event) => {
  const name = getRouterParam(event, 'name')

  return `Hello, ${name}!`
})

或者，将 getValidatedRouterParams 与 Zod 等模式验证器一起使用，以实现运行时和类型安全。

你现在可以在 /api/hello/nuxt 上全局调用这个 API，并获得 Hello, nuxt!。

匹配 HTTP 方法

可以为处理文件名添加后缀 .get、.post、.put、.delete、... 以匹配请求的 HTTP 方法。

server/api/test.get.ts

export default defineEventHandler(() => 'Test get handler')

server/api/test.post.ts

export default defineEventHandler(() => 'Test post handler')

给定上面的示例，使用以下方法获取 /test：

GET 方法：返回 Test get handler
POST 方法：返回 Test post handler
任何其他方法：返回 405 错误

您还可以在目录中使用 index.[method].ts 来以不同的方式组织代码，这对于创建 API 命名空间非常有用。

export default defineEventHandler((event) => {
  // handle GET requests for the `api/foo` endpoint
})

捕获所有路由

捕获所有路由对于回退路由处理非常有用。

例如，创建一个名为 ~/server/api/foo/[...].ts 的文件将为所有与任何路由处理程序都不匹配的请求注册一个捕获所有路由，例如 /api/foo/bar/baz。

server/api/foo/[...].ts

export default defineEventHandler((event) => {
  // event.context.path to get the route path: '/api/foo/bar/baz'
  // event.context.params._ to get the route segment: 'bar/baz'
  return `Default foo handler`
})

您可以使用 ~/server/api/foo/[...slug].ts 为捕获所有路由设置一个名称，并通过 event.context.params.slug 访问它。

server/api/foo/[...slug].ts

export default defineEventHandler((event) => {
  // event.context.params.slug to get the route segment: 'bar/baz'
  return `Default foo handler`
})

请求体处理

server/api/submit.post.ts

export default defineEventHandler(async (event) => {
  const body = await readBody(event)
  return { body }
})

或者，可以使用带有模式验证器（如 Zod）的 readValidatedBody 来实现运行时和类型安全。

您现在可以使用以下方法通用地调用此 API：

app.vue

<script setup lang="ts">
async function submit() {
  const { body } = await $fetch('/api/submit', {
    method: 'post',
    body: { test: 123 }
  })
}
</script>

我们在文件名中使用 submit.post.ts 只是为了匹配可以接受请求体的 POST 方法的请求。当在 GET 请求中使用 readBody 时，readBody 将抛出一个 405 Method Not Allowed HTTP 错误。

查询参数

示例查询 /api/query?foo=bar&baz=qux

server/api/query.get.ts

export default defineEventHandler((event) => {
  const query = getQuery(event)

  return { a: query.foo, b: query.baz }
})

或者，可以使用带有模式验证器（如 Zod）的 getValidatedQuery 来实现运行时和类型安全。

错误处理

如果没有抛出错误，将返回 200 OK 的状态码。

任何未捕获的错误将返回 500 Internal Server Error HTTP 错误。

要返回其他错误代码，请使用 createError 抛出异常

server/api/validation/[id].ts

export default defineEventHandler((event) => {
  const id = parseInt(event.context.params.id) as number

  if (!Number.isInteger(id)) {
    throw createError({
      statusCode: 400,
      statusMessage: 'ID should be an integer',
    })
  }
  return 'All good'
})

状态码

要返回其他状态码，请使用 setResponseStatus 实用程序。

例如，要返回 202 Accepted

server/api/validation/[id].ts

export default defineEventHandler((event) => {
  setResponseStatus(event, 202)
})

运行时配置

export default defineEventHandler(async (event) => {
  const config = useRuntimeConfig(event)

  const repo = await $fetch('https://api.github.com/repos/nuxt/nuxt', {
    headers: {
      Authorization: `token ${config.githubToken}`
    }
  })

  return repo
})

将 event 作为参数传递给 useRuntimeConfig 是可选的，但建议传递它，以便在服务器路由运行时，运行时配置被环境变量覆盖。

请求 Cookie

server/api/cookies.ts

export default defineEventHandler((event) => {
  const cookies = parseCookies(event)

  return { cookies }
})

转发上下文和标头

默认情况下，当在服务器路由中发出获取请求时，既不会转发传入请求的标头，也不会转发请求上下文。您可以使用 event.$fetch 在服务器路由中发出获取请求时转发请求上下文和标头。

server/api/forward.ts

export default defineEventHandler((event) => {
  return event.$fetch('/api/forwarded')
})

不应转发的标头将不会包含在请求中。这些标头包括，例如： transfer-encoding、connection、keep-alive、upgrade、expect、host、accept

响应后等待 Promise

在处理服务器请求时，您可能需要执行不应阻止客户端响应的异步任务（例如，缓存和日志记录）。您可以使用 event.waitUntil 在后台等待一个 promise，而不会延迟响应。

event.waitUntil 方法接受一个 promise，该 promise 将在处理程序终止之前等待，确保即使服务器会在发送响应后立即终止处理程序，任务也能完成。这与运行时提供程序集成，以利用其本机功能来处理发送响应后的异步操作。

server/api/background-task.ts

const timeConsumingBackgroundTask = async () => {
  await new Promise((resolve) => setTimeout(resolve, 1000))
};

export default eventHandler((event) => {
  // schedule a background task without blocking the response
  event.waitUntil(timeConsumingBackgroundTask())

  // immediately send the response to the client
  return 'done'
});

高级用法

Nitro 配置

您可以使用 nuxt.config 中的 nitro 键直接设置 Nitro 配置。

这是一个高级选项。自定义配置可能会影响生产部署，因为当 Nitro 在 Nuxt 的 semver-minor 版本中升级时，配置界面可能会随着时间的推移而更改。

nuxt.config.ts

export default defineNuxtConfig({
  // https://nitro.unjs.io/config
  nitro: {}
})

在文档 > 指南 > 概念 > 服务器引擎中了解更多信息。

嵌套路由器

server/api/hello/[...slug].ts

import { createRouter, defineEventHandler, useBase } from 'h3'

const router = createRouter()

router.get('/test', defineEventHandler(() => 'Hello World'))

export default useBase('/api/hello', router.handler)

发送流

这是一个实验性功能，可在所有环境中使用。

server/api/foo.get.ts

import fs from 'node:fs'
import { sendStream } from 'h3'

export default defineEventHandler((event) => {
  return sendStream(event, fs.createReadStream('/path/to/file'))
})

发送重定向

server/api/foo.get.ts

export default defineEventHandler(async (event) => {
  await sendRedirect(event, '/path/redirect/to', 302)
})

旧版处理程序或中间件

server/api/legacy.ts

export default fromNodeMiddleware((req, res) => {
  res.end('Legacy handler')
})

可以使用 unjs/h3 实现旧版支持，但建议尽可能避免旧版处理程序。

server/middleware/legacy.ts

export default fromNodeMiddleware((req, res, next) => {
  console.log('Legacy middleware')
  next()
})

永远不要将 next() 回调与 async 或返回 Promise 的旧版中间件组合使用。

服务器存储

Nitro 提供了一个跨平台的存储层。为了配置额外的存储挂载点，您可以使用 nitro.storage 或服务器插件。

添加 Redis 存储的示例

使用 nitro.storage

nuxt.config.ts

export default defineNuxtConfig({
  nitro: {
    storage: {
      redis: {
        driver: 'redis',
        /* redis connector options */
        port: 6379, // Redis port
        host: "127.0.0.1", // Redis host
        username: "", // needs Redis >= 6
        password: "",
        db: 0, // Defaults to 0
        tls: {} // tls/ssl
      }
    }
  }
})

然后在您的 API 处理程序中：

server/api/storage/test.ts

export default defineEventHandler(async (event) => {
  // List all keys with
  const keys = await useStorage('redis').getKeys()

  // Set a key with
  await useStorage('redis').setItem('foo', 'bar')

  // Remove a key with
  await useStorage('redis').removeItem('foo')

  return {}
})

阅读有关 Nitro 存储层的更多信息。

或者，您可以使用服务器插件和运行时配置创建存储挂载点

import redisDriver from 'unstorage/drivers/redis'

export default defineNitroPlugin(() => {
  const storage = useStorage()

  // Dynamically pass in credentials from runtime configuration, or other sources
  const driver = redisDriver({
      base: 'redis',
      host: useRuntimeConfig().redis.host,
      port: useRuntimeConfig().redis.port,
      /* other redis connector options */
    })

  // Mount driver
  storage.mount('redis', driver)
})

public

public/ 目录用于提供您网站的静态资源。

shared

使用 shared/ 目录在 Vue 应用程序和 Nitro 服务器之间共享功能。