详解在vue开发中如何利用.env文件

 更新时间:2023年10月20日 08:30:16   作者:Minfai  
我们在 vue 项目的目录中经常看到 env 开头的文件,在文件内声明一些变量,这些变量就是一些配置变量,在不同环境下可使用的变量,本文我们将给大家介绍在vue开发中如何利用.env文件,需要的朋友可以参考下

前言

我们在 vue 项目的目录中经常看到 env 开头的文件,在文件内声明一些变量,这些变量就是一些配置变量,在不同环境下可使用的变量。

# 页面标题
VITE_APP_TITLE = 管理系统

# 开发环境配置
VITE_APP_ENV = 'development'

# 管理系统/开发环境
VITE_APP_BASE_API = '/'

环境

项目的运行不止在我们敲代码的时候,还在正式使用时等等,在这些情况我们区分为有本地环境、测试环境、预生产、生产环境等等。

在这不同环境下,代码运行的情况肯定是不一样的,这个时候就需要 env 文件,来控制其中变化的情况,实现差异性配置。

env 命名

通常 env 文件命名如下:

  • .env 所有环境(开发、测试、生成等)均会加载并合并该文件。
  • .env.development 开发环境
  • .env.production 生产环境

其中.env、.env.development、.env.production 文件的命名为固定格式,不能改变,否则读取不到文件。

文件读取

package.json vue 中所需要的的依赖会根据该文件来安装。

  • scripts:支持的脚本
  • dependencies: 生产环境依赖包列表
  • devDependencies: 开发环境、测试环境依赖包列表

而在 package.json 文件中 有 scripts字段用来定义脚本命令, Vue 会根据启动命令自动加载对应的环境配置文件。其中的属性是用来运行 npm run 命令的,属性名可以随意更改;而属性的值,才是真正运行的命令,是固定的。

"scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build --mode development",
    "build:pro": "vue-cli-service build --mode production",
    "build:test": "vue-cli-service build --mode test",
  },

配置环境变量

该文件注释用 # 号开头,定义变量直接是 属性 = 值。

# 页面标题
VITE_APP_TITLE = 管理系统

# 环境配置
VITE_APP_ENV = 'development'

# api 基础路径
VITE_APP_BASE_API = '/dev-api'
// 或
VUE_APP_BASE_API = '/dev-api'

使用

我们知道了在不同环境下使用相应 env 文件中的变量,那么想要在项目中使用该变量要怎么做呢?

在项目中,如果我使用的是 vite ,要想在项目中使用变量的开头就需要是 VITE_,而不是 VITE_ 开头的变量就不能被获取到。

// 在 vite 程序中获取
console.log(import.meta.env.VITE_APP_BASE_API); // /dev-api
// 在 vue2 项目中获取
console.log(process.env.VUE_APP_BASE_API); // /dev-api

在 vite 中对于不支持 import.meta.env来获取变量,我们可以使用 Vite 导出的 loadEnv 函数来加载指定的 .env 文件

import { defineConfig, loadEnv } from 'vite'

export default defineConfig(({ command, mode }) => {
  // 根据当前工作目录中的 `mode` 加载 .env 文件
  // 如果当前环境是开发环境,则 mode 为 development
  // 设置第三个参数为 '' 来加载所有环境变量,而不管是否有 `VITE_` 前缀。
  const env = loadEnv(mode, process.cwd(), '')
  const { VITE_APP_BASE_API } = env // VITE_APP_BASE_API = /dev-api
  return {
    // vite 配置
    define: {
      __APP_ENV__: JSON.stringify(env.APP_ENV),
    },
  }
})

总结

  • 默认情况下 .env 文件要放在和 package.json 同一目录下才可以被加载,除非在配置文件中更改加载目录。
  • 不同的环境会加载不同的 .env 文件。
  • 要想使用环境变量,变量的开头有固定要求,在 vite 项目中以 VITE_ 开头,在 vue2 项目中以 VUE_APP 开头。

到此这篇关于详解在vue开发中如何利用.env文件的文章就介绍到这了,更多相关vue利用.env文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • vue封装一个弹幕组件详解

    vue封装一个弹幕组件详解

    这篇文章主要介绍了vue封装一个弹幕组件详解,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙可以参考一下
    2022-08-08
  • vue3中实现文本显示省略号和tooltips提示框的方式详解

    vue3中实现文本显示省略号和tooltips提示框的方式详解

    在 B 端业务中,我们经常会遇到文本内容超出容器区域需显示省略号的需求,当鼠标移入文本时,会出现 Tooltip 显示完整内容,最近,我也遇到了这样的场景,接下来给大家介绍vue3中实现文本显示省略号和tooltips提示框的方式,需要的朋友可以参考下
    2024-04-04
  • Vue实现单行删除与批量删除

    Vue实现单行删除与批量删除

    这篇文章主要介绍了Vue实现单行删除与批量删除,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-04-04
  • Vue获取初始化数据是放在created还是mounted解读

    Vue获取初始化数据是放在created还是mounted解读

    这篇文章主要介绍了Vue获取初始化数据是放在created还是mounted的问题解读,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • Vue使用video标签实现视频播放

    Vue使用video标签实现视频播放

    这篇文章主要为大家详细介绍了Vue使用video标签实现视频播放,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • vue项目使用lodash节流防抖函数问题解决方案

    vue项目使用lodash节流防抖函数问题解决方案

    在lodash函数工具库中,防抖 _.debounce 和节流 _.throttle 函数在一些频繁触发的事件中比较常用,这篇文章主要介绍了vue项目使用lodash节流防抖函数问题与解决,需要的朋友可以参考下
    2023-10-10
  • vue实现token登录验证的完整实例

    vue实现token登录验证的完整实例

    最近公司新启动了个项目,用的是vue框架在做,下面这篇文章主要给大家介绍了关于vue实现token登录验证的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-04-04
  • 解决vue 格式化银行卡(信用卡)每4位一个符号隔断的问题

    解决vue 格式化银行卡(信用卡)每4位一个符号隔断的问题

    这篇文章主要介绍了vue 格式化银行卡(信用卡)每4位一个符号隔断的问题,本文给大家分享了解决方法,需要的朋友可以参考下
    2018-09-09
  • vue移动端微信授权登录插件封装的实例

    vue移动端微信授权登录插件封装的实例

    今天小编就为大家分享一篇vue移动端微信授权登录插件封装的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-08-08
  • Pinia介绍及工作原理解析

    Pinia介绍及工作原理解析

    这篇文章主要为大家介绍了Pinia介绍及工作原理解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-03-03

最新评论