server/ · Nuxt 目錄結構

Nuxt 會自動掃描這些目錄中的檔案，以註冊支援熱模組替換 (HMR) 的 API 和伺服器處理常式。

目錄結構

-| 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 存取。

請注意，目前伺服器路由不支援動態路由的完整功能，如同 pages 一樣。

伺服器中介層

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 的執行階段行為並 Hook 到生命週期事件中。

範例

server/plugins/nitroPlugin.ts

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

在 Nitro 插件中閱讀更多資訊。

伺服器工具程式

伺服器路由由 unjs/h3 提供支援，它附帶一組方便的 helpers。

在可用的 H3 請求 Helpers 中閱讀更多資訊。

您可以在 ~/server/utils 目錄中自行新增更多 helpers。

例如，您可以定義一個自訂處理常式工具程式，它會包裝原始處理常式，並在回傳最終回應之前執行額外操作。

範例

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`
})

Body 處理

server/api/submit.post.ts

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

或者，使用具有 schema 驗證器（例如 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 以符合可以使用請求 body 的 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 }
})

或者，使用具有 schema 驗證器（例如 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 是可選的，但建議傳遞它以取得在伺服器路由的執行時期配置被環境變數覆寫。

請求 Cookies

server/api/cookies.ts

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

  return { cookies }
})

轉發 Context & Headers

預設情況下，當在伺服器路由中發出 fetch 請求時，既不會轉發來自傳入請求的 headers，也不會轉發請求 context。您可以使用 event.$fetch 在伺服器路由中發出 fetch 請求時轉發請求 context 和 headers。

server/api/forward.ts

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

不打算轉發的 Headers 將不會包含在請求中。這些 headers 包括，例如：transfer-encoding、connection、keep-alive、upgrade、expect、host、accept

在回應後等待 Promise

當處理伺服器請求時，您可能需要執行不應阻止對用戶端回應的非同步任務（例如，快取和日誌記錄）。您可以使用 event.waitUntil 在背景等待 promise，而不會延遲回應。

event.waitUntil 方法接受一個 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 伺服器之間共享功能。