vite技术揭秘--环境变量

目录

环境变量

生产环境替换

自定义环境变量

.env 文件

 环境加载优先级

 自定义环境变量

模式

TypeScript 的智能提示

在node环境里使用环境变量


 

前言

    我们开发中不可避免的要根据环境变量来做一些逻辑分支,在vite中有两种实现方式,即define和.env文件

环境变量

Vite 在一个特殊的 import.meta.env 对象上暴露环境变量。这里有一些在所有情况下都可以使用的内建变量:

import.meta.env.MODE: {string} 应用运行的模式。import.meta.env.BASE_URL: {string} 部署应用时的基本 URL。他由base 配置项决定。import.meta.env.PROD: {boolean} 应用是否运行在生产环境。import.meta.env.DEV: {boolean} 应用是否运行在开发环境 (永远与 import.meta.env.PROD相反)。import.meta.env.SSR: {boolean} 应用是否运行在 server 上。

生产环境替换


在生产环境中,这些环境变量会在构建时被静态替换,因此,在引用它们时请使用完全静态的字符串。动态的 key 将无法生效。例如,动态 key 取值 import.meta.env[key] 是无效的。

它还将替换出现在 JavaScript 和 Vue 模板中的字符串。这本应是非常少见的,但也可能是不小心为之的。在这种情况下你可能会看到类似 Missing Semicolon 或 Unexpected token 等错误,例如当"process.env.NODE_ENV" 被替换为 "“development”: "。有一些方法可以避免这个问题:

对于 JavaScript 字符串,你可以使用 unicode 零宽度空格来分割这个字符串,例如: 'import.meta\u200b.env.MODE'。

对于 Vue 模板或其他编译到 JavaScript 字符串的 HTML,你可以使用 标签,例如:import.meta.env.MODE。

自定义环境变量

.env 文件

Vite 使用 dotenv 从你的 环境目录 中的下列文件加载额外的环境变量:

.env                # 所有情况下都会加载
.env.local          # 所有情况下都会加载,但会被 git 忽略
.env.[mode]         # 只在指定模式下加载
.env.[mode].local   # 只在指定模式下加载,但会被 git 忽略

注意事项

.env.*.local 文件应是本地的,可以包含敏感变量。你应该将 .local 添加到你的 .gitignore 中,以避免它们被 git 检入。

由于任何暴露给 Vite 源码的变量最终都将出现在客户端包中,VITE_* 变量应该不包含任何敏感信息。

在真正项目的开发中,我们并不会直接去用.env文件,而是会新建.env.development文件和.env.production文件:

  • .env.development文件:开发环境下会读取文件里面定义的数据
  • .env.production文件:生产环境下会读取文件里面定义的数据

 环境加载优先级

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

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

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

 自定义环境变量

例如,我们现在在项目的根目录下,新建一个 .env 文件。 加载的环境变量也会通过 import.meta.env 以字符串形式暴露给客户端源码。 为了防止意外地将一些环境变量泄漏到客户端,Vite规定:只有以 VITE_ 为前缀的变量才会暴露给经过 vite 处理的代码。例如下面这些环境变量:

VITE_SOME_KEY=123
DB_PASSWORD=foobar
只有 VITE_SOME_KEY 会被暴露为 import.meta.env.VITE_SOME_KEY 提供给客户端源码,而 DB_PASSWORD 则不会。

模式

默认情况下,开发服务器 (dev 命令) 运行在 development (开发) 模式,而 build 命令则运行在 production (生产) 模式。

这意味着当执行 vite build 时,它会自动加载 .env.production 中可能存在的环境变量:.env.production


VITE_TITLE=test
在你的应用中,你可以使用 import.meta.env.VITE_TITLE 渲染标题。

在某些情况下,若想在 vite build 时运行不同的模式来渲染不同的标题,你可以通过传递 --mode 选项标志来覆盖命令使用的默认模式。

我们现在在项目的根目录下,新建一个 .env.test 文件,内容如下:


# .env.test
VITE_TITLE=test

 package.json里 新增配置

 然后我们在 npm run dev 的时候给他指定运行模式是test,最后运行得到下面的结果

TypeScript 的智能提示

默认情况下,Vite 在 vite/client.d.ts 中为 import.meta.env 提供了类型定义。随着在 .env[mode] 文件中自定义了越来越多的环境变量,你可能想要在代码中获取这些以 VITE_ 为前缀的用户自定义环境变量的 TypeScript 智能提示。

要想做到这一点,你可以在 src 目录下创建一个 env.d.ts 文件,接着按下面这样增加 ImportMetaEnv 的定义:

/// <reference types="vite/client" />interface ImportMetaEnv {readonly VITE_APP_TITLE: string// 更多环境变量...
}interface ImportMeta {readonly env: ImportMetaEnv
}


如果你的代码依赖于浏览器环境的类型,比如 DOM 和 WebWorker,你可以在 tsconfig.json 中修改 lib 字段来获取类型支持。

{"lib": ["WebWorker"]
}

在node环境里使用环境变量

你以为这就完了吗?并没有。

当我们在 vite.config 里面想打印一下看看结构的话,就会发现,看不到。

那么要如何正确使用呢?需要用的 loadEnv

// vite.config.ts
import { defineConfig, loadEnv } from 'vite'
import vue from '@vitejs/plugin-vue'
//引入svg需要用到插件
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
import path from 'path'
import { viteMockServe } from 'vite-plugin-mock'export default defineConfig(({ command, mode }) => {//获取各种环境下的对应的变量let env = loadEnv(mode, process.cwd())console.log(env, '------')return {plugins: [vue(),viteMockServe({localEnabled: command === 'serve', //保证开发阶段可以使用mock接口}),// 注册svg图标createSvgIconsPlugin({// Specify the icon folder to be cachediconDirs: [path.resolve(process.cwd(), 'src/assets/icons')],// Specify symbolId formatsymbolId: 'icon-[dir]-[name]',}),],resolve: {alias: {'@': path.resolve('./src'), // 相对路径别名配置,使用 @ 代替 src},},//scss全局变量一个配置css: {preprocessorOptions: {scss: {javascriptEnabled: true,additionalData: '@import "./src/style/variable.scss";',},},},//代理跨域server: {proxy: {[env.VITE_APP_BASE_API]: {//获取数据的服务器地址设置target: env.VITE_SERVE,//需要代理跨域changeOrigin: true,//路径重写rewrite: (path) => path.replace(/^\/api/, ''),},},},}
})

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://xiahunao.cn/news/351131.html

如若内容造成侵权/违法违规/事实不符,请联系瞎胡闹网进行投诉反馈,一经查实,立即删除!

相关文章

Python接口自动化之yaml配置文件

Python自动化测试&#xff1a;7天练完这60个实战项目&#xff0c;年薪过35w。 软件测试技术分享总结 在自动化过程中&#xff0c;需要使用配置文件储存数据&#xff0c;比如数据库信息、账号信息、域名等。 其中&#xff0c;yaml文件是一种配置文件类型&#xff0c;相比较in…

基于大模型构建本地知识库

基于大模型构建本地知识库 图文概述一、知识库构建1.文本加载和读取2.文本分割3.文本向量化英文排行版中文SOTA 二、向量搜索1.向量存储2.用户问题向量化3.知识库中搜索和问题最相似的topK个向量 三、大模型理解四、问题 图文概述 一、知识库构建 1.文本加载和读取 支持的格式…

Jenkins重启报错解决

在Jenkins上安装了一些插件后&#xff0c;需要重启Jenkins&#xff0c;由于忘了当初是怎么重启的&#xff0c;所以就问了GPT&#xff0c;下面是它的回答&#xff1a; 我想着&#xff0c;jenkins运行的好好的&#xff0c;还看什么状态&#xff0c;直接restart&#xff0c;然后……

智能出行更安全,亚马逊云科技携手木卫四助汽车客户安全合规出海

木卫四&#xff08;北京&#xff09;科技有限公司在汽车网络安全领域拥有独特专业知识&#xff0c;其融合人工智能算法的安全检测引擎可以不依赖车辆中安装的代理软件&#xff0c;只需几周即可快速部署实施&#xff0c;是汽车网络安全领域的技术领先者。 在亚马逊云科技初创团…

经典的设计模式——UML类图的一些规范

文章目录 一、类的表示二、接口的表示三、继承的表示四、接口实现的表示五、关联关系六、聚合关系七、合成关系八、依赖关系 一、类的表示 矩形框第一层表示名称&#xff0c;如果是抽象类&#xff0c;则用斜 体表示 第二层是属性 第三层是方法 号表示公有&#xff0c;-表示私有…

基于粒子群优化算法的电动汽车充放电V2G研究(Matlab代码实现)

&#x1f4a5;&#x1f4a5;&#x1f49e;&#x1f49e;欢迎来到本博客❤️❤️&#x1f4a5;&#x1f4a5; &#x1f3c6;博主优势&#xff1a;&#x1f31e;&#x1f31e;&#x1f31e;博客内容尽量做到思维缜密&#xff0c;逻辑清晰&#xff0c;为了方便读者。 ⛳️座右铭&a…

chat聊天系统消息消费时遇到的问题及优化思路(二)

1、前言 考虑下面几个条件下如何提升kafka的消费速度 消息要求严格有序&#xff0c;如chat聊天消息业务处理速度慢&#xff0c;如处理一条数据需要100ms分片不合理&#xff0c;如有的分区很闲&#xff0c;有的分区消息数量积压 2、解决方案 1、顺序问题 关于消息消费时存在…

docker卷--docker volumes 使用学习

一、在Docker中管理数据 1.1、Docker 保存容器数据的方法 Docker 卷&#xff08;Docker Volumes&#xff09;&#xff1a;可以将数据保存在 Docker 卷中&#xff0c;这样可以在容器和宿主机之间共享数据&#xff0c;并保证容器中的数据不会因为容器被删除而丢失。Docker 卷可以…

Halcon得出三角形内切圆

Halcon得出三角形内切圆 news2023/5/27 7:14: 目录 一、得出三角形的三个角点二、用类似尺规作图法得出三角形圆心 1、以三角形三角点画出圆形轮廓2、求出三角形轮廓与圆形轮廓之间的交点3、获得角平分线&#xff0c;三边角平分线交点为圆心三、求出圆心到边最短距离即半径 …

mathtype一步将word自带的公式编辑器的公式换成mathtype类型

之前不知道mathtype这个强大公式编辑器的存在&#xff0c;一直用word自带的公式编辑器敲的公式&#xff0c;写论文时害怕公式被查重&#xff0c;因此借助mathtype将公式转换一下。 点击转换公式 把对应的勾选上 点击转换&#xff0c;等待一些时长&#xff0c;便&#x1f197;…

word2010公式编辑器 格式设置

2010好像也只能调用公式3.0来实现&#xff1a;插入-对象-microsoft 公式 3.0-样式 然后设置斜体&#xff08;按下图修改&#xff09; 我的2003的&#xff0c;双击你的公式进入公式编辑器&#xff0c;选中要改的在样式其它中修改&#xff0c;或者先在定义中事先定义好格式。

计算机word的函数怎么用,Word公式编辑器怎么使用,教您怎么使用

word是我们经常使用的文字处理器应用程序由于其功能强大深受用户喜爱已经成为了办公软件中不可或缺的一员word公式编辑器在哪&#xff0c;一些用户需要在用word的时候用到一些数学公式&#xff0c;问朋友word里怎么编辑公式&#xff0c;都说的模棱两可&#xff0c;为此小编整理…

Word中的公式编辑器

这里推荐一款AxMath&#xff0c;我们来看看它集成在word中的标签&#xff1a; 这个是超级好用的哦。 下载 双击安装安装包AxMath 安装 打开word&#xff0c;就可以看到菜单栏上会多了一个“AxMath”的选项卡&#xff0c;点击“行内公式“即可编辑公式。 AxMath还支持公式对…

word中插入常用几种公式编辑器

公式编辑器对于写毕业论文和发表文章是十分重要的&#xff0c;常用的公式编辑器有以下几种&#xff1a; 1.word中自带的公式编辑器&#xff0c;像2016版本的word&#xff0c;公式编辑器就有很多功能 2.AxMath AxMath是一款新生公式编辑器&#xff0c;但其公式编辑功能毫不逊色于…

计算机查重公式编辑器,知网查重文字公式编辑器吗

知网查重文字公式编辑器吗&#xff1f;答案是肯定的。知网查重公式算重复的&#xff0c;这意味着word里公式会查重&#xff0c;更会查重wps公式了&#xff0c;所以不管你是用word自带公式编辑器&#xff0c;还是说文字公式编辑器都会查重到。那么&#xff0c;知网查重文字公式编…

Word自带公式编辑器卡死的解决办法

Word自带公式编辑器卡死的解决办法 容易出现卡死的情况是输入完公式后回车。有教程说是因为默认打印机设置的是远程&#xff0c;更改默认打印机为本地的即可。如图&#xff0c;很多人设置这个就可以解决了。 但是该方法对我无效&#xff01;详细的看了一下和word运行的还有福昕…

word 自带公式编辑器中公式等号对齐方法

注意&#xff1a;这种方法只能对带括号的公式有用&#xff0c;比如下面的括号&#xff1b;且行数是根据 Enter 换行自动填补的&#xff0c;不是矩阵设定的 &#xff01; 我们在写论文时经常遇到公式不对齐问题&#xff0c;影响美观&#xff0c;下面详细介绍一下 word 自带公式…

word自带的公式编辑器——用法技巧总结

Word提供了像Latex一样书写公式的特性&#xff08;虽然我也不知道&#xff0c;姑且算吧&#xff09;。详情可见 https://support.office.com/en-us/article/Linear-format-equations-using-UnicodeMath-and-LaTeX-in-Word-2e00618d-b1fd-49d8-8cb4-8d17f25754f8?uien-US&…

如何在Word中打开公式编辑器

MathType是一款受大众喜爱的功能强大的数学、物理公式编辑器&#xff0c;而Word作为常用的文字处理软件&#xff0c;所以要掌握在其中插入公式的技巧。虽然有自带的公式编辑器&#xff0c;但是不全面&#xff0c;建议使用专业的MathType软件&#xff0c;并且Word文档支持很多种…

word公式编辑器复制粘贴未响应_Word公式编辑器使用中的常见问题的解决办法(图文教程)...

关于公式编辑器的使用在很多书刊和杂志上都有介绍&#xff0c;但在日常使用过程中&#xff0c;还有一些问题经常出现&#xff0c;比如说&#xff1a;输入数学公式后行距不等、不能更改公式的颜色、打印时经常出现乱码等。针对上面提到的各种问题&#xff0c;我们来看一下具体的…