开发服务器配置
开发服务器配置项主要用于配置Vite自带的开发服务器,其中也包括了最常用的反向代理配置。开发服务器配置都集中在server
下,在进行配置的时候需要注意。
常用的开发服务器配置主要有以下这些。
配置键 | 默认值 | 配置内容 |
---|---|---|
host | 127.0.0.1 | 指定服务器需要进行监听的IP地址。 |
port | 3000 | 指定服务需要进行监听的端口。 如果端口被占用,那么Vite将会自动尝试下一个可用的端口。 |
https | 是否启用TLS+HTTP/2。 | |
open | 是否自动在浏览器中打开应用。 | |
proxy | 自定义反向代理规则。 | |
cors | 设置开发服务器的CORS。 | |
watch | 设置传递给chokidar 的文件系统监听配置。在WSL 2上运行Vite时,需要设置其中的 usePolling 配置。 | |
origin | 用于定义开发调试阶段生成资产的origin。 |
Vite中为配置反向代理服务定义了一个专门的类型:ProxyOptions
,这个类型中常用的配置项主要有以下这些。
配置键 | 类型 | 配置内容 |
---|---|---|
target | ProxyTarget? | 配置代理转向目标。 |
forward | ProxyTargetUrl? | 配置代理转向URL。 |
agent | any? | 配置代理使用的Agent。 |
ws | boolean? | 配置是否支持代理WebSocket。 |
prependPath | boolean? | 配置是否使用前追加路径的方式拼接代理路径。 |
ignorePath | boolean? | 配置是否忽略指定的代理路径。 |
changeOrigin | boolean? | 是否更改Host的Origin头。 |
auth | string? | 代理目标所要求使用的基本认证信息。 |
hostRewrite | string? | 重写主机名称。 |
autoRewrite | boolean? | 设置是否自动重写主机域名及端口。 |
rewrite | (string) => string | 具体访问路径重写定义。 |
cookieDomain-Rewrite | false | string | {[string]: string} | 如何重写Cookie域。 |
cookiePath-Rewrite | false | string | {[string]: string} | 如何重写Cookie路径。 |
headers | {[string]: string} | 代理过程中需要附加的额外头信息。 |
proxyTimeout | number? | 代理超时时间。 |
timeout | number? | 访问请求超时时间。 |
followRedirects | boolean? | 是否其他的重定向。 |