vite3使用指南,小白再也不用担心项目配置问题了

为开发提供极速响应v4.1.0

目前Vite已经更新到v4.1.0的版本了

image

vite的特性

image
  • 💡极速的服务启动,意思就是一个字
  • ⚡️轻量快速的热重载,就是说热更新也很快
  • 🔧丰富的功能,支持的工具集比较多,开箱即用
  • 📦优化的构建 对于生产环境的构建有更好的优化
  • 🔩通用的插件,在开发和构建之间共享 Rollup-superset 插件接口。
  • 完全类型化的API 使用TS,有较好的语法提示和类型支持

使用Vite创建项目

image

使用npm

<pre data-language="go" id="lYMaM" class="ne-codeblock language-go" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">npm create vite@latest</pre>

使用yarn

<pre data-language="bash" id="p4WJ8" class="ne-codeblock language-bash" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">yarn create vite</pre>

使用pnpm

<pre data-language="bash" id="APdU4" class="ne-codeblock language-bash" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">pnpm create vite</pre>

如果使用vite创建Vue项目的话,可以创建带模版的vue项目

<pre data-language="bash" id="bI5QC" class="ne-codeblock language-bash" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959"># npm 6.x
npm create vite@latest my-vue-app --template vue

npm 7+, extra double-dash is needed:

npm create vite@latest my-vue-app -- --template vue

yarn

yarn create vite my-vue-app --template vue

pnpm

pnpm create vite my-vue-app --template vue</pre>

查看 create-vite 以获取每个模板的更多细节:vanilla,vanilla-ts, vue, vue-ts,react,react-ts,react-swc,react-swc-ts,preact,preact-ts,lit,lit-ts,svelte,svelte-ts。

区分开发环境,测试环境和生产环境

image

首先在项目根目录下创建.env文件,Vite 使用 dotenv 从你的 环境目录 中的下列文件加载额外的环境变量

<pre data-language="javascript" id="K85Vx" class="ne-codeblock language-javascript" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">.env # 所有情况下都会加载
.env.local # 所有情况下都会加载,但会被 git 忽略
.env.[mode] # 只在指定模式下加载
.env.[mode].local # 只在指定模式下加载,但会被 git 忽略

.env.development # 开发模式
.env.production # 生产模式
.env.test # 测试模式
</pre>

默认情况下

  • npm run dev 会加载 .env 和 .env.development 内的配置
  • npm run build 会加载 .env 和 .env.production 内的配置
  • mode 可以通过命令行 --mode 选项来重写。

在package.json文件中配置一个test命令

image

环境加载优先级

一份用于指定模式的文件(例如 .env.production)会比通用形式的优先级更高(例如 .env)。

另外,Vite 执行时已经存在的环境变量有最高的优先级,不会被 .env 类文件覆盖。例如当运行 VITE_SOME_KEY=123 vite build 的时候。

.env 类文件会在 Vite 启动一开始时被加载,而改动会在重启服务器后生效

<pre data-language="javascript" id="TEjAO" class="ne-codeblock language-javascript" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">console.log('获取当前目录',process.cwd());
//参数:模式:development||production,入口文件,修改.env变量前缀
const env=loadEnv('development',process.cwd(),'wmq')
console.log(env);</pre>

image

加载的环境变量也会通过 import.meta.env 以字符串形式暴露给客户端源码。

为了防止意外地将一些环境变量泄漏到客户端,只有以 VITE_ 为前缀的变量才会暴露给经过 vite 处理的代码

所以这里如果没配置前缀的话,import.meta.env 就访问不到了

<pre data-language="javascript" id="oDI0e" class="ne-codeblock language-javascript" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">VITE_BASE_API=base/api 这个可以被访问到
wmq_client='aa🤔'。访问不了</pre>

使用envPrefix方法可以更换环境变量的前缀
image

然后在main.js文件中去打印import.mate.env的环境变量,在不同的开发模式下就可以获取到相应的环境变量了

image

开发模式下

image

生产模式下

image

测试模式下

image

通过验证我们可以看出,不管是什么模式下,都可以加载到.env文件中的变量

更改.env的默认地址

我们现在的.env文件都是建立在根目录的,如果.env.XX的文件太多,会显得我们的项目目录很乱,我们能将.env放在一个统一的文件夹内吗?

可以通过envDir配置来改变!参考:共享配置 | Vite 官方中文文档

envDir用于加载 .env 文件的目录。可以是一个绝对路径,也可以是相对于项目根的路径。

  • 类型: string
  • 默认: root

比如,我们在vite.config.js中这样配置

<pre data-language="javascript" id="Ks4H2" class="ne-codeblock language-javascript" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">import { defineConfig } from "vite";
export default defineConfig( {
envDir:"env"
});</pre>

然后,所有的.env.xxx文件就可以放在项目根目录的env文件夹下了。

配置服务端选项

<pre data-language="javascript" id="DW1to" class="ne-codeblock language-javascript" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">export default defineConfig({
server: {
host: 'localhost',// 开放服务器启动的地址,默认时localhost
port: 9000,//项目启动端口
open: true,//项目启动时是否打开浏览器
base:'/',//用于代理 Vite 作为子文件夹时使用。
cors: true,//为开发服务器配置 CORS。默认启用并允许任何源,传递一个 选项对象 来调整行为或设为 false 表示禁用。
headers:{},//指定服务端响应的headers信息
strictPort:true,//设为 true 时若端口已被占用则会直接退出,而不是尝试下一个可用端口。
proxy: {//配置后端代理
// 字符串简写写法
'/foo': 'http://localhost:4567',
// 选项写法
'/api': {
target: 'http://jsonplaceholder.typicode.com',//指向后端地址
changeOrigin: true,//允许跨域
rewrite: (path) => path.replace(/^/api/, '')
},
// 正则表达式写法
'^/fallback/.*': {
target: 'http://jsonplaceholder.typicode.com',
changeOrigin: true,
rewrite: (path) => path.replace(/^/fallback/, '')
},
// 使用 proxy 实例
'/api': {
target: 'http://jsonplaceholder.typicode.com',
changeOrigin: true,
configure: (proxy, options) => {
// proxy 是 'http-proxy' 的实例
}
},
// Proxying websockets or socket.io
'/socket.io': {
target: 'ws://localhost:3000',
ws: true
}
},
}
})
</pre>

server

其中server是比较常用的重要属性,特别是proxy主要是配置代理后端API地址的

  • target
  • changeOrigin
  • rewrite

服务端的选项常用的大概就这些了,期中最常用的就是解决开发过程中的跨域问题了,需要在proxy里面去设置即可,其他的不常用的选项如有用到去查vite官网的[**服务器选项**](https://vitejs.cn/vite3-cn/config/server-options.html)

image

配置CSS

<pre data-language="javascript" id="MMetb" class="ne-codeblock language-javascript" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">export default defineConfig({
//css配置
css: {
// 开发模式为true,生产模式为flase, devSourcemap:true,//源代码映射
devSourcemap:command === 'serve',
// css模块化配置项
modules:{
// 是否开启模块化。模块化or全局化
scopeBehaviour: 'global' | 'local',
// css模块化的路径
globalModulePaths: RegExp[],
// 更改生成的哈希名称,一个字符串模板或者通过函数返回
generateScopedName: string| ((name, filename, css) => string),
// 生成hash名称的前缀
hashPrefix: string,
// 修改生成的配置对象的key的展示形式(驼峰还是中划线形式)
localsConvention:'camelCase'
| 'camelCaseOnly'
| 'dashes'
| 'dashesOnly'
| null
},
// 预处理器配置项
preprocessorOptions: {
less: {
math: "always",
},
scss: {
additionalData: '@import "src/assets/styles/var.scss";'
}
},

postcss:{
  // 一些配置
}

}
})</pre>

css的配置主要是一些css的模块化和预处理器的配置。比如scss,less,postcss等等

模块化属性

  • scopeBehaviour:是否开启模块化,global为全局化,local为模块化
  • globalModulePaths:css模块化的路径
  • generateScopedName:生成的哈希名称,一个字符串模板或者通过函数返回
  • hashPrefix:生成hash名称的前缀
  • localsConvention:生成的配置对象的key的展示形式(驼峰还是中划线形式)

其他的less,scss,postcss属性使用的时候查询官方文档即可

其他的一些常用小配置

image

配置别名

<pre data-language="javascript" id="P0Efc" class="ne-codeblock language-javascript" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">export default defineConfig({
resolve:{
alias:{
'@': resolve(__dirname, 'src')//配置别名
}
}
})</pre>

打包速度的问题

vite在打包中会计算包的大小,但是只是计算不做处理,会长打包时间,所以可以在build中再添加一个配置项关闭打包计算。

启用/禁用 gzip 压缩大小报告。压缩大型输出文件可能会很慢,因此禁用该功能可能会提高大型项目的构建性能。

<pre data-language="c" id="Oxztu" class="ne-codeblock language-c" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">brotliSize: false,//vite2
reportCompressedSize:false //vite3</pre>

gizp压缩

<pre data-language="javascript" id="aVOQC" class="ne-codeblock language-javascript" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">plugins: [vue(),
viteCompression({
//生成压缩包gz
verbose: true,
disable: false,
threshold: 10240,
algorithm: 'gzip',
ext: '.gz',
}),],</pre>

我把打包后的项目用express稍微搭了个后台跑了一下,发现express开启了gzip和没开启gzip,都是一样的。不知道vite是不是默认启动gzip压缩?有了解的小伙伴也可以说一下。

生产环境移除console

<pre data-language="javascript" id="mUOLt" class="ne-codeblock language-javascript" style="border: 1px solid #e8e8e8; border-radius: 2px; background: #f9f9f9; padding: 16px; font-size: 13px; color: #595959">build:{
...
terserOptions: {
compress: {
drop_console: true,
drop_debugger: true
}
}
}</pre>

以上就是vite的一些常用的项目配置了,基本上绝大多数都是在项目中需要经常使用的,而且随着前端技术的不断发展,构建工具也是在不停的更新迭代,作为技术人员也得紧跟技术潮流,也许你现在的项目用的不是vite,但是你不能说你不会,所谓技多不压身嘛,小伙伴们赶紧学起来吧!🚀

image
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,458评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,030评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,879评论 0 358
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,278评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,296评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,019评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,633评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,541评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,068评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,181评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,318评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,991评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,670评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,183评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,302评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,655评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,327评论 2 358

推荐阅读更多精彩内容