跳转到主文档
应用工程
模块工程
Monorepo工程
项目生成器

dev.proxy

  • 类型: string | Object
  • 默认值: null

配置该选项后,开发环境时会启动全局代理,类似 Fiddler, Charles 等 web 代理调试工具,可以用来查看、修改 HTTP/HTTPS 请求、响应、也可以用作代理服务器。

提示

使用该选项需要提前安装 @modern-js/plugin-proxy

值为 Object 时,对象的 key 对应匹配的 pattern,对象的 value 对应匹配的 target

例如:

modern.config.js
export default defineConfig({
dev: {
proxy: {
'https://www.baidu.com': 'https://google.com.hk',
//可以通过 file 协议直接返回静态文件。
'https://example.com/api': 'file://./data.json',
}
}
});

值为 string 时, 可以用来指定单独的代理文件,例如:

modern.config.js
export default defineConfig({
dev: {
proxy: './proxy.js',
},
});
proxy.js
module.exports = {
name: 'my-app',
rules: `
^example.com:8080/api/*** http://localhost:3001/api/$
`,
};

Modern.js 全局代理实现底层基于 whistle, 更多匹配模式请参考: 匹配模式

执行 dev, 提示如下时,即代理服务器启动成功:

  App running at:

Local: http://localhost:8080/
Network: http://192.168.0.1:8080/

ℹ info Starting the proxy server.....
✔ success Proxy Server start on localhost:8899

访问 localhost:8899, 可以在 UI 界面上查看 Network 以及配置代理规则:

proxy ui 界面

注意

https 代理自动安装证书需要获取 root 权限, 请根据提示输入密码即可。密码仅在信任证书时使用,不会泄漏或者用于其他环节