在 Bun 中使用 TanStack Start

TanStack Start 是一个由 TanStack Router 提供支持的全栈框架。它支持全文档 SSR、流式传输、服务器函数、打包等，由 TanStack Router 和 Vite 提供支持。

创建新的 TanStack Start 应用

使用交互式 CLI 创建一个新的 TanStack Start 应用。

bun create @tanstack/start@latest my-tanstack-app

启动开发服务器

切换到项目目录并使用 Bun 运行开发服务器。

cd my-tanstack-app
bun --bun run dev

这将使用 Bun 启动 Vite 开发服务器。

更新 package.json 中的脚本

修改 package.json 中的 scripts 字段，在 Vite CLI 命令前加上 bun --bun 前缀。这确保 Bun 为 dev、build 和 preview 等常见任务执行 Vite CLI。

json

{
  "scripts": {
    "dev": "bun --bun vite dev", 
    "build": "bun --bun vite build", 
    "serve": "bun --bun vite preview"
  }
}

托管

要托管你的 TanStack Start 应用，你可以使用 Nitro 或自定义 Bun 服务器进行生产部署。

Nitro

将 Nitro 添加到你的项目

将 Nitro 添加到你的项目。此工具允许你将 TanStack Start 应用部署到不同的平台。

bun add nitro

更新你的 `vite.config.ts` 文件

更新你的 vite.config.ts 文件，包含 TanStack Start 与 Bun 所需的插件。

// 其他导入...
import { nitro } from "nitro/vite"; 

const config = defineConfig({
  plugins: [
    tanstackStart(),
    nitro({ preset: "bun" }), 
    // 其他插件...
  ],
});

export default config;

NOTE

`bun` 预设是可选的，但它专门为 Bun 运行时配置构建输出。

更新启动命令

确保 package.json 文件中存在 build 和 start 脚本：

json

  {
    "scripts": {
      "build": "bun --bun vite build", 
      // .output 文件在你运行 `bun run build` 时由 Nitro 创建。
      // 部署到 Vercel 时不需要。
      "start": "bun run .output/server/index.mjs"
    }
  }

NOTE

部署到 Vercel 时，你**不**需要自定义 `start` 脚本。

部署你的应用

查看我们的指南之一，将你的应用部署到托管提供商。

NOTE

部署到 Vercel 时，你可以将 `"bunVersion": "1.x"` 添加到你的 `vercel.json` 文件，或者将其添加到 `vite.config.ts` 文件中的 `nitro` 配置：

警告

部署到 Vercel 时，不要使用 bun Nitro 预设。

export default defineConfig({
  plugins: [
    tanstackStart(),
    nitro({
      preset: "bun", 
      vercel: { 
        functions: { 
          runtime: "bun1.x", 
        }, 
    }, 
    }),
  ],
});

自定义服务器

NOTE

此自定义服务器实现基于 [TanStack 的 Bun 模板](https://github.com/TanStack/router/blob/main/examples/react/start-bun/server.ts)。它提供对静态资源服务的细粒度控制，包括可配置的内存管理，将小文件预加载到内存中以快速服务，同时按需服务大文件。当你在生产部署中需要精确控制资源使用情况和资源加载行为时，这种方法很有用。

创建生产服务器

在项目根目录中创建一个 server.ts 文件，包含以下自定义服务器实现：

/**
* 使用 Bun 的 TanStack Start 生产服务器
*
* 一个用于 TanStack Start 应用的高性能生产服务器，
* 实现了具有可配置内存管理的智能静态资源加载。
*
* 特性：
* - 混合加载策略（预加载小文件，按需服务大文件）
* - 具有包含/排除模式的可配置文件过滤
* - 内存高效的响应生成
* - 生产就绪的缓存头
*
* 环境变量：
*
* PORT (number)
*   - 服务器端口号
*   - 默认值：3000
*
* ASSET_PRELOAD_MAX_SIZE (number)
*   - 预加载到内存中的最大文件大小（字节）
*   - 大于此文件将从磁盘按需服务
*   - 默认值：5242880 (5MB)
*   - 示例：ASSET_PRELOAD_MAX_SIZE=5242880 (5MB)
*
* ASSET_PRELOAD_INCLUDE_PATTERNS (string)
*   - 要包含的文件的全局模式逗号分隔列表
*   - 如果指定，只有匹配的文件才有资格预加载
*   - 模式仅与文件名匹配，而不是完整路径
*   - 示例：ASSET_PRELOAD_INCLUDE_PATTERNS="*.js,*.css,*.woff2"
*
* ASSET_PRELOAD_EXCLUDE_PATTERNS (string)
*   - 要排除的文件的全局模式逗号分隔列表
*   - 在包含模式之后应用
*   - 模式仅与文件名匹配，而不是完整路径
*   - 示例：ASSET_PRELOAD_EXCLUDE_PATTERNS="*.map,*.txt"
*
* ASSET_PRELOAD_VERBOSE_LOGGING (boolean)
*   - 启用已加载和跳过文件的详细日志
*   - 默认值：false
*   - 设置为 "true" 启用详细输出
*
* ASSET_PRELOAD_ENABLE_ETAG (boolean)
*   - 为预加载资源启用 ETag 生成
*   - 默认值：true
*   - 设置为 "false" 禁用 ETag 支持
*
* ASSET_PRELOAD_ENABLE_GZIP (boolean)
*   - 为符合条件的资源启用 Gzip 压缩
*   - 默认值：true
*   - 设置为 "false" 禁用 Gzip 压缩
*
* ASSET_PRELOAD_GZIP_MIN_SIZE (number)
*   - Gzip 压缩所需的最小文件大小（字节）
*   - 小于此值的文件将不会被压缩
*   - 默认值：1024 (1KB)
*
* ASSET_PRELOAD_GZIP_MIME_TYPES (string)
*   - 符合 Gzip 压缩条件的 MIME 类型逗号分隔列表
*   - 支持以 "/" 结尾的类型部分匹配
*   - 默认值：text/,application/javascript,application/json,application/xml,image/svg+xml
*
* 用法：
*   bun run server.ts
*/

import path from 'node:path'

// 配置
const SERVER_PORT = Number(process.env.PORT ?? 3000)
const CLIENT_DIRECTORY = './dist/client'
const SERVER_ENTRY_POINT = './dist/server/server.js'

// 用于专业输出的日志工具
const log = {
  info: (message: string) => {
    console.log(`[INFO] ${message}`)
  },
  success: (message: string) => {
    console.log(`[SUCCESS] ${message}`)
  },
  warning: (message: string) => {
    console.log(`[WARNING] ${message}`)
  },
  error: (message: string) => {
    console.log(`[ERROR] ${message}`)
  },
  header: (message: string) => {
    console.log(`\n${message}\n`)
  },
}

// 从环境变量加载预加载配置
const MAX_PRELOAD_BYTES = Number(
  process.env.ASSET_PRELOAD_MAX_SIZE ?? 5 * 1024 * 1024, // 默认 5MB
)

// 解析逗号分隔的包含模式（无默认值）
const INCLUDE_PATTERNS = (process.env.ASSET_PRELOAD_INCLUDE_PATTERNS ?? '')
  .split(',')
  .map((s) => s.trim())
  .filter(Boolean)
  .map((pattern: string) => convertGlobToRegExp(pattern))

// 解析逗号分隔的排除模式（无默认值）
const EXCLUDE_PATTERNS = (process.env.ASSET_PRELOAD_EXCLUDE_PATTERNS ?? '')
  .split(',')
  .map((s) => s.trim())
  .filter(Boolean)
  .map((pattern: string) => convertGlobToRegExp(pattern))

// 详细日志标志
const VERBOSE = process.env.ASSET_PRELOAD_VERBOSE_LOGGING === 'true'

// 可选 ETag 功能
const ENABLE_ETAG = (process.env.ASSET_PRELOAD_ENABLE_ETAG ?? 'true') === 'true'

// 可选 Gzip 功能
const ENABLE_GZIP = (process.env.ASSET_PRELOAD_ENABLE_GZIP ?? 'true') === 'true'
const GZIP_MIN_BYTES = Number(process.env.ASSET_PRELOAD_GZIP_MIN_SIZE ?? 1024) // 1KB
const GZIP_TYPES = (
  process.env.ASSET_PRELOAD_GZIP_MIME_TYPES ??
  'text/,application/javascript,application/json,application/xml,image/svg+xml'
)
  .split(',')
  .map((v) => v.trim())
  .filter(Boolean)

/**
* 将简单的全局模式转换为正则表达式
* 支持 * 通配符匹配任何字符
*/
function convertGlobToRegExp(globPattern: string): RegExp {
  // 转义正则特殊字符（* 除外），然后将 * 替换为 .*
  const escapedPattern = globPattern
    .replace(/[-/\\^$+?.()|[\]{}]/g, '\\$&')
    .replace(/\*/g, '.*')
  return new RegExp(`^${escapedPattern}$`, 'i')
}

/**
* 计算给定数据缓冲区的 ETag
*/
function computeEtag(data: Uint8Array): string {
  const hash = Bun.hash(data)
  return `W/"${hash.toString(16)}-${data.byteLength.toString()}"`
}

/**
* 预加载静态资源的元数据
*/
interface AssetMetadata {
  route: string
  size: number
  type: string
}

/**
* 具有 ETag 和 Gzip 支持的内存资源
*/
interface InMemoryAsset {
  raw: Uint8Array
  gz?: Uint8Array
  etag?: string
  type: string
  immutable: boolean
  size: number
}

/**
* 静态资源预加载过程的结果
*/
interface PreloadResult {
  routes: Record<string, (req: Request) => Response | Promise<Response>>
  loaded: AssetMetadata[]
  skipped: AssetMetadata[]
}

/**
* 根据配置的模式检查文件是否有资格预加载
*/
function isFileEligibleForPreloading(relativePath: string): boolean {
  const fileName = relativePath.split(/[/\\]/).pop() ?? relativePath

  // 如果指定了包含模式，文件必须至少匹配一个
  if (INCLUDE_PATTERNS.length > 0) {
    if (!INCLUDE_PATTERNS.some((pattern) => pattern.test(fileName))) {
      return false
    }
  }

  // 如果指定了排除模式，文件不得匹配任何模式
  if (EXCLUDE_PATTERNS.some((pattern) => pattern.test(fileName))) {
    return false
  }

  return true
}

/**
* 检查 MIME 类型是否可压缩
*/
function isMimeTypeCompressible(mimeType: string): boolean {
  return GZIP_TYPES.some((type) =>
    type.endsWith('/') ? mimeType.startsWith(type) : mimeType === type,
  )
}

/**
* 根据大小和 MIME 类型有条件地压缩数据
*/
function compressDataIfAppropriate(
  data: Uint8Array,
  mimeType: string,
): Uint8Array | undefined {
  if (!ENABLE_GZIP) return undefined
  if (data.byteLength < GZIP_MIN_BYTES) return undefined
  if (!isMimeTypeCompressible(mimeType)) return undefined
  try {
    return Bun.gzipSync(data.buffer as ArrayBuffer)
  } catch {
    return undefined
  }
}

/**
* 创建具有 ETag 和 Gzip 支持的响应处理函数
*/
function createResponseHandler(
  asset: InMemoryAsset,
): (req: Request) => Response {
  return (req: Request) => {
    const headers: Record<string, string> = {
      'Content-Type': asset.type,
      'Cache-Control': asset.immutable
        ? 'public, max-age=31536000, immutable'
        : 'public, max-age=3600',
    }

    if (ENABLE_ETAG && asset.etag) {
      const ifNone = req.headers.get('if-none-match')
      if (ifNone && ifNone === asset.etag) {
        return new Response(null, {
          status: 304,
          headers: { ETag: asset.etag },
        })
      }
      headers.ETag = asset.etag
    }

    if (
      ENABLE_GZIP &&
      asset.gz &&
      req.headers.get('accept-encoding')?.includes('gzip')
    ) {
      headers['Content-Encoding'] = 'gzip'
      headers['Content-Length'] = String(asset.gz.byteLength)
      const gzCopy = new Uint8Array(asset.gz)
      return new Response(gzCopy, { status: 200, headers })
    }

    headers['Content-Length'] = String(asset.raw.byteLength)
    const rawCopy = new Uint8Array(asset.raw)
    return new Response(rawCopy, { status: 200, headers })
  }
}

/**
* 从包含模式创建复合全局模式
*/
function createCompositeGlobPattern(): Bun.Glob {
  const raw = (process.env.ASSET_PRELOAD_INCLUDE_PATTERNS ?? '')
    .split(',')
    .map((s) => s.trim())
    .filter(Boolean)
  if (raw.length === 0) return new Bun.Glob('**/*')
  if (raw.length === 1) return new Bun.Glob(raw[0])
  return new Bun.Glob(`{${raw.join(',')}}`)
}

/**
* 使用智能预加载策略初始化静态路由
* 小文件加载到内存中，大文件按需服务
*/
async function initializeStaticRoutes(
  clientDirectory: string,
): Promise<PreloadResult> {
  const routes: Record<string, (req: Request) => Response | Promise<Response>> =
    {}
  const loaded: AssetMetadata[] = []
  const skipped: AssetMetadata[] = []

  log.info(`正在从 ${clientDirectory} 加载静态资源...`)
  if (VERBOSE) {
    console.log(
      `最大预加载大小：${(MAX_PRELOAD_BYTES / 1024 / 1024).toFixed(2)} MB`,
    )
    if (INCLUDE_PATTERNS.length > 0) {
      console.log(
        `包含模式：${process.env.ASSET_PRELOAD_INCLUDE_PATTERNS ?? ''}`,
      )
    }
    if (EXCLUDE_PATTERNS.length > 0) {
      console.log(
        `排除模式：${process.env.ASSET_PRELOAD_EXCLUDE_PATTERNS ?? ''}`,
      )
    }
  }

  let totalPreloadedBytes = 0

  try {
    const glob = createCompositeGlobPattern()
    for await (const relativePath of glob.scan({ cwd: clientDirectory })) {
      const filepath = path.join(clientDirectory, relativePath)
      const route = `/${relativePath.split(path.sep).join(path.posix.sep)}`

      try {
        // 获取文件元数据
        const file = Bun.file(filepath)

        // 如果文件不存在或为空则跳过
        if (!(await file.exists()) || file.size === 0) {
          continue
        }

        const metadata: AssetMetadata = {
          route,
          size: file.size,
          type: file.type || 'application/octet-stream',
        }

        // 确定是否应该预加载文件
        const matchesPattern = isFileEligibleForPreloading(relativePath)
        const withinSizeLimit = file.size <= MAX_PRELOAD_BYTES

        if (matchesPattern && withinSizeLimit) {
          // 将小文件预加载到内存中，支持 ETag 和 Gzip
          const bytes = new Uint8Array(await file.arrayBuffer())
          const gz = compressDataIfAppropriate(bytes, metadata.type)
          const etag = ENABLE_ETAG ? computeEtag(bytes) : undefined
          const asset: InMemoryAsset = {
            raw: bytes,
            gz,
            etag,
            type: metadata.type,
            immutable: true,
            size: bytes.byteLength,
          }
          routes[route] = createResponseHandler(asset)

          loaded.push({ ...metadata, size: bytes.byteLength })
          totalPreloadedBytes += bytes.byteLength
        } else {
          // 按需服务大文件或过滤的文件
          routes[route] = () => {
            const fileOnDemand = Bun.file(filepath)
            return new Response(fileOnDemand, {
              headers: {
                'Content-Type': metadata.type,
                'Cache-Control': 'public, max-age=3600',
              },
            })
          }

          skipped.push(metadata)
        }
      } catch (error: unknown) {
        if (error instanceof Error && error.name !== 'EISDIR') {
          log.error(`加载 ${filepath} 失败：${error.message}`)
        }
      }
    }

    // 仅在启用详细模式时显示详细的文件概述
    if (VERBOSE && (loaded.length > 0 || skipped.length > 0)) {
      const allFiles = [...loaded, ...skipped].sort((a, b) =>
        a.route.localeCompare(b.route),
      )

      // 计算最大路径长度以对齐
      const maxPathLength = Math.min(
        Math.max(...allFiles.map((f) => f.route.length)),
        60,
      )

      // 格式化文件大小（KB 和实际 gzip 大小）
      const formatFileSize = (bytes: number, gzBytes?: number) => {
        const kb = bytes / 1024
        const sizeStr = kb < 100 ? kb.toFixed(2) : kb.toFixed(1)

        if (gzBytes !== undefined) {
          const gzKb = gzBytes / 1024
          const gzStr = gzKb < 100 ? gzKb.toFixed(2) : gzKb.toFixed(1)
          return {
            size: sizeStr,
            gzip: gzStr,
          }
        }

        // 如果没有实际 gzip 数据，粗略 gzip 估计（通常 30-70% 压缩）
        const gzipKb = kb * 0.35
        return {
          size: sizeStr,
          gzip: gzipKb < 100 ? gzipKb.toFixed(2) : gzipKb.toFixed(1),
        }
      }

      if (loaded.length > 0) {
        console.log('\n📁 预加载到内存中：')
        console.log(
          '路径                                          │    大小 │ Gzip 大小',
        )
        loaded
          .sort((a, b) => a.route.localeCompare(b.route))
          .forEach((file) => {
            const { size, gzip } = formatFileSize(file.size)
            const paddedPath = file.route.padEnd(maxPathLength)
            const sizeStr = `${size.padStart(7)} kB`
            const gzipStr = `${gzip.padStart(7)} kB`
            console.log(`${paddedPath} │ ${sizeStr} │  ${gzipStr}`)
          })
      }

      if (skipped.length > 0) {
        console.log('\n💾 按需服务：')
        console.log(
          '路径                                          │    大小 │ Gzip 大小',
        )
        skipped
          .sort((a, b) => a.route.localeCompare(b.route))
          .forEach((file) => {
            const { size, gzip } = formatFileSize(file.size)
            const paddedPath = file.route.padEnd(maxPathLength)
            const sizeStr = `${size.padStart(7)} kB`
            const gzipStr = `${gzip.padStart(7)} kB`
            console.log(`${paddedPath} │ ${sizeStr} │  ${gzipStr}`)
          })
      }
    }

    // 如果启用则显示详细详细信息
    if (VERBOSE) {
      if (loaded.length > 0 || skipped.length > 0) {
        const allFiles = [...loaded, ...skipped].sort((a, b) =>
          a.route.localeCompare(b.route),
        )
        console.log('\n📊 详细文件信息：')
        console.log(
          '状态         │ 路径                            │ MIME 类型                     │ 原因',
        )
        allFiles.forEach((file) => {
          const isPreloaded = loaded.includes(file)
          const status = isPreloaded ? 'MEMORY' : 'ON-DEMAND'
          const reason =
            !isPreloaded && file.size > MAX_PRELOAD_BYTES
              ? '太大'
              : !isPreloaded
                ? '已过滤'
                : '已预加载'
          const route =
            file.route.length > 30
              ? file.route.substring(0, 27) + '...'
              : file.route
          console.log(
            `${status.padEnd(12)} │ ${route.padEnd(30)} │ ${file.type.padEnd(28)} │ ${reason.padEnd(10)}`,
          )
        })
      } else {
        console.log('\n📊 未找到要显示的文件')
      }
    }

    // 在文件列表后记录摘要
    console.log() // 空行分隔
    if (loaded.length > 0) {
      log.success(
        `已预加载 ${String(loaded.length)} 个文件（${(totalPreloadedBytes / 1024 / 1024).toFixed(2)} MB）到内存中`,
      )
    } else {
      log.info('没有文件预加载到内存中')
    }

    if (skipped.length > 0) {
      const tooLarge = skipped.filter((f) => f.size > MAX_PRELOAD_BYTES).length
      const filtered = skipped.length - tooLarge
      log.info(
        `${String(skipped.length)} 个文件将按需服务（${String(tooLarge)} 太大，${String(filtered)} 已过滤）`,
      )
    }
  } catch (error) {
    log.error(
      `从 ${clientDirectory} 加载静态文件失败：${String(error)}`,
    )
  }

  return { routes, loaded, skipped }
}

/**
* 初始化服务器
*/
async function initializeServer() {
  log.header('正在启动生产服务器')

  // 加载 TanStack Start 服务器处理程序
  let handler: { fetch: (request: Request) => Response | Promise<Response> }
  try {
    const serverModule = (await import(SERVER_ENTRY_POINT)) as {
      default: { fetch: (request: Request) => Response | Promise<Response> }
    }
    handler = serverModule.default
    log.success('TanStack Start 应用处理程序已初始化')
  } catch (error) {
    log.error(`加载服务器处理程序失败：${String(error)}`)
    process.exit(1)
  }

  // 使用智能预加载构建静态路由
  const { routes } = await initializeStaticRoutes(CLIENT_DIRECTORY)

  // 创建 Bun 服务器
  const server = Bun.serve({
    port: SERVER_PORT,

    routes: {
      // 提供静态资源（预加载或按需）
      ...routes,

      // 所有其他路由回退到 TanStack Start 处理程序
      '/*': (req: Request) => {
        try {
          return handler.fetch(req)
        } catch (error) {
          log.error(`服务器处理程序错误：${String(error)}`)
          return new Response('Internal Server Error', { status: 500 })
        }
      },
    },

    // 全局错误处理程序
    error(error) {
      log.error(
        `未捕获的服务器错误：${error instanceof Error ? error.message : String(error)}`,
      )
      return new Response('Internal Server Error', { status: 500 })
    },
  })

  log.success(`服务器正在监听 http://localhost:${String(server.port)}`)
}

// 初始化服务器
initializeServer().catch((error: unknown) => {
  log.error(`启动服务器失败：${String(error)}`)
  process.exit(1)
})

更新 package.json 脚本

添加一个 start 脚本来运行自定义服务器：

json

{
  "scripts": {
    "build": "bun --bun vite build",
    "start": "bun run server.ts"
  }
}

构建和运行

构建你的应用并启动服务器：

bun run build
bun run start

服务器将默认在端口 3000 上启动（可通过 PORT 环境变量配置）。

模板

→ 查看 TanStack Start 官方文档获取有关托管的更多信息。

创建新的 TanStack Start 应用 ​

启动开发服务器 ​

更新 package.json 中的脚本 ​

托管 ​

Nitro ​

将 Nitro 添加到你的项目 ​

更新你的 vite.config.ts 文件 ​

更新启动命令 ​

部署你的应用 ​

自定义服务器 ​

创建生产服务器 ​

更新 package.json 脚本 ​

构建和运行 ​

模板 ​

创建新的 TanStack Start 应用

启动开发服务器

更新 package.json 中的脚本

托管

Nitro

将 Nitro 添加到你的项目

更新你的 `vite.config.ts` 文件

更新启动命令

部署你的应用

自定义服务器

创建生产服务器

更新 package.json 脚本

构建和运行

模板