首页
/ 在h3中实现静态资源服务与SPA路由回退方案

在h3中实现静态资源服务与SPA路由回退方案

2025-06-16 22:44:36作者:劳婵绚Shirley

h3是一个轻量级的Node.js HTTP框架,它提供了简洁的API来处理HTTP请求。本文将介绍如何使用h3框架实现静态资源服务,并针对单页应用(SPA)实现路由回退到index.html的功能。

静态资源服务基础实现

h3框架提供了serveStatic中间件来处理静态文件服务。基本实现如下:

import { createApp, defineEventHandler, serveStatic } from "h3";
import { stat, readFile } from "node:fs/promises";
import { join } from "pathe";

const app = createApp();
const publicDir = "public";

app.use(
  defineEventHandler((event) => {
    return serveStatic(event, {
      getContents: (id) => readFile(join(publicDir, id)),
      getMeta: async (id) => {
        const stats = await stat(join(publicDir, id)).catch(() => {});
        
        if (!stats || !stats.isFile()) {
          return;
        }

        return {
          size: stats.size,
          mtime: stats.mtimeMs,
        };
      },
    });
  }),
);

这段代码创建了一个基本的静态文件服务器,它会:

  1. 从指定的public目录读取文件
  2. 检查文件是否存在及是否为有效文件
  3. 返回文件内容和元数据

实现SPA路由回退

对于单页应用(SPA),当用户直接访问某个路由或刷新页面时,我们需要确保服务器能回退到index.html,让前端路由接管后续处理。以下是改进后的实现:

app.use(
  defineEventHandler(async (event) => {
    const result = await serveStatic(event, {
      fallthrough: true,  // 关键参数,允许中间件继续执行
      getContents: (id) => readFile(join(publicDir, id)),
      getMeta: async (id) => {
        const stats = await stat(join(publicDir, id)).catch(() => {});
        
        if (!stats || !stats.isFile()) {
          return;
        }

        return {
          size: stats.size,
          mtime: stats.mtimeMs,
        };
      },
    });

    if (result === false) {
      // 当静态文件未找到时,返回index.html
      return readFile(join(publicDir, "index.html"), "utf8");
    }
  }),
);

关键改进点:

  1. 添加了fallthrough: true选项,使得当静态文件不存在时不会直接返回404
  2. 检查serveStatic的返回值,如果是false则返回index.html
  3. 使用异步处理确保流程正确

实现原理分析

这种实现方式利用了h3中间件的特性:

  1. serveStatic会尝试匹配请求路径对应的静态文件
  2. fallthrough为true且文件不存在时,返回false而非直接响应
  3. 我们可以根据返回值决定后续处理逻辑
  4. 对于不存在的路由,返回index.html让前端路由处理

性能考虑

在实际生产环境中,还需要考虑以下优化点:

  1. 添加缓存控制头,提高静态资源加载性能
  2. 对index.html文件设置较短的缓存时间或不缓存
  3. 考虑使用ETag或Last-Modified进行条件请求处理
  4. 对于大型项目,可能需要引入更专业的静态文件服务中间件

这种实现方式特别适合现代前端框架(如Vue、React等)构建的单页应用部署场景,确保了前端路由能正常工作,同时保持了静态资源的高效服务。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K