详解在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-router之什么是嵌套路由

    讲解vue-router之什么是嵌套路由

    这篇文章主要介绍了讲解vue-router之什么是嵌套路由,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • vue3集成bpmn.js详细代码示例

    vue3集成bpmn.js详细代码示例

    bpmn.js是一个BPMN2.0渲染工具包和web建模器,使得画流程图的功能在前端来完成,这篇文章主要给大家介绍了关于vue3集成bpmn.js的相关资料,文中通过代码示例介绍的非常详细,需要的朋友可以参考下
    2024-01-01
  • vue-router之路由钩子函数应用小结

    vue-router之路由钩子函数应用小结

    vue-router提供的导航钩子主要用来拦截导航,让它完成跳转或取消,本文主要介绍了vue-router之路由钩子函数应用小结,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • Element Cascader 级联选择器的使用示例

    Element Cascader 级联选择器的使用示例

    这篇文章主要介绍了Element Cascader 级联选择器的使用示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Vue隐藏显示、只读实例代码

    Vue隐藏显示、只读实例代码

    本文通过实例代码给大家介绍了Vue隐藏显示、只读功能,代码简单易懂,非常不错,具有一定的参考借鉴价值,需要的朋友参考下吧
    2018-07-07
  • 解读element-ui使用el-upload,before-upload函数不好使的问题

    解读element-ui使用el-upload,before-upload函数不好使的问题

    这篇文章主要介绍了解读element-ui使用el-upload,before-upload函数不好使的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • 解决报错ValidationError: Progress Plugin Invalid Options问题

    解决报错ValidationError: Progress Plugin Invalid&

    这篇文章主要介绍了解决报错ValidationError: Progress Plugin Invalid Options问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • vue实现登录拦截

    vue实现登录拦截

    这篇文章主要介绍了vue实现登录拦截,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-06-06
  • Spring boot 和Vue开发中CORS跨域问题解决

    Spring boot 和Vue开发中CORS跨域问题解决

    这篇文章主要介绍了Spring boot 和Vue开发中CORS跨域问题解决,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-09-09
  • uni-app 使用编辑器创建vue3 项目并且运行的操作方法

    uni-app 使用编辑器创建vue3 项目并且运行的操作方法

    这篇文章主要介绍了uni-app 使用编辑器创建vue3 项目并且运行的操作方法,目前uniapp 创建的vue3支持 vue3.0 -- 3.2版本 也就是说setup语法糖也是支持的,需要的朋友可以参考下
    2023-01-01

最新评论