Vite中本地开发服务器的中间件机制怎么用server.configureServer钩子函数拦截并自定义Mock数据接口

落晨大大_2677

落晨大大_2677

2026-07-23

527人浏览

原创

configureserver 钩子用于配置开发服务器实例,需通过 server.app.use() 注册 koa 中间件来拦截请求并实现 mock;它不直接处理 http 请求,仅提供配置时机。

vite中本地开发服务器的中间件机制怎么用server.configureserver钩子函数拦截并自定义mock数据接口

在 Vite 中,server.configureServer 钩子不是用来直接拦截请求的中间件入口,它主要用于配置开发服务器实例(如 koa app),真正的请求拦截和 Mock 应该通过 configureServer 拿到 server 实例后,往其内部的 app(Koa 应用)中注册自定义中间件来实现。

理解 configureServer 的作用时机与能力

configureServer 是一个 Vite 插件钩子,在开发服务器启动前被调用,接收一个 server 对象。这个对象包含:

  • server.app:底层 Koa 实例,可直接 use 中间件
  • server.middlewares:已注册的中间件栈(只读,不建议直接 push)
  • server.config:Vite 配置

⚠️ 注意:configureServer 本身不接收请求,也不返回响应,它只是“配置机会”。要拦截 HTTP 请求,必须往 server.app 上挂中间件。

在 configureServer 中注册路由级 Mock 中间件

推荐方式:使用 server.app.use() 添加 Koa 中间件,并用 ctx.path 或 ctx.url 匹配接口路径,手动设置响应。

  • 匹配前缀如 /api/ 的请求,返回 JSON 数据
  • 支持 GET/POST 等方法判断(ctx.method)
  • 可解析请求体(需配合 koa-body 或手动读取 ctx.req)

示例(vite.config.ts):

Vite
Vite

为开发、生产构建和库打包配置并优化 Vite。

下载
export default defineConfig({
  plugins: [{
    name: 'mock-server',
    configureServer(server) {
      server.app.use(async (ctx, next) => {
        // 只处理 /api 开头且未被其他中间件响应过的请求
        if (ctx.path.startsWith('/api/') && !ctx.body) {
          const url = new URL(ctx.request.url, 'http://localhost');
          const path = url.pathname;

          if (path === '/api/user') {
            ctx.status = 200;
            ctx.set('Content-Type', 'application/json');
            ctx.body = { code: 0, data: { id: 1, name: '张三' } };
            return;
          }

          if (path === '/api/list' && ctx.method === 'POST') {
            let body = '';
            ctx.req.on('data', chunk => body += chunk);
            await new Promise(resolve => ctx.req.on('end', resolve));
            ctx.status = 200;
            ctx.body = { code: 0, msg: '提交成功', data: JSON.parse(body) };
            return;
          }
        }
        await next(); // 继续后续中间件(如静态文件、SPA fallback)
      });
    }
  }]
});

更工程化的 Mock 方案:结合 mockjs 或 msx

纯手写响应易维护性差。可引入 mockjs 生成随机数据,或用 msw(需搭配浏览器端拦截);但若坚持服务端 Mock,推荐结构化管理:

  • 新建 mock/ 目录,按模块拆分 JSON 或函数文件(如 user.ts 导出 handler)
  • 在中间件中动态 import 或 require 对应 mock 文件
  • 利用路径映射自动加载,例如 /api/users → mock/users.ts

这样既保持逻辑分离,又便于后期替换为真实接口或切换环境。

注意事项与常见陷阱

实际使用时容易踩坑:

  • 顺序很重要:你的中间件越早 use,越可能捕获请求;但不要放在 static 中间件之前,否则会拦截 HTML/JS/CSS 请求
  • 避免重复响应:务必检查 !ctx.body 或 ctx.respond === false,防止多次设置 body 报错
  • 跨域问题:本地开发默认同源,无需额外配置 CORS;如需测试跨域行为,可手动加 ctx.set('Access-Control-Allow-Origin', '*')
  • HMR 不重启 server:修改 configureServer 代码不会触发 server 重载,需手动重启 vite 进程

不复杂但容易忽略细节,关键是把 Mock 当作标准 Koa 中间件来写,而不是试图“劫持”某个钩子函数本身。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4506

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1129

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4424

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1796

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3245

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4213

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2720

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

868

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程