vue.js

关注公众号 jb51net

关闭
首页 > 网络编程 > JavaScript > javascript类库 > vue.js > Vue3 Vite 环境变量

Vue3+Vite 环境变量和模式配置详解(推荐)

作者：Microi风闲

在Vue 3中,你可以通过 import.meta.env 访问环境变量,这些变量可以在你的应用代码中使用,但它们通常用于配置不应该硬编码在代码中的值,这篇文章主要介绍了Vue3+Vite 环境变量和模式配置详解,需要的朋友可以参考下

前言📋

在Vue 3中，你可以通过 import.meta.env 访问环境变量。这些变量可以在你的应用代码中使用，但它们通常用于配置不应该硬编码在代码中的值。

你可以在项目根目录下的 .env 文件中设置环境变量，或者为不同的环境设置特定的 .env 文件，如 .env.development 和 .env.production 。

提示：以下是本篇文章正文内容，下面案例可供参考

一、环境变量®️

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

1.1 生产环境替换

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

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

二、.env 文件📑

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

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

2.1 环境加载优先级

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

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

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

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

🎯注意：为了防止意外地将一些环境变量泄漏到客户端，只有以 VITE_ 为前缀的变量才会暴露给经过 vite 处理的代码。例如下面这些环境变量：

VITE_SOME_KEY=123
DB_PASSWORD=foobar

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

console.log(import.meta.env.VITE_SOME_KEY) // 123
console.log(import.meta.env.DB_PASSWORD) // undefined

安全注意事项：

如果你想自定义 env 变量的前缀，请参阅 envPrefix。

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

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

三、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"]
}

四、模式🎭

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

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

# .env.production
VITE_APP_TITLE=My App

在你的应用中，你可以使用 import.meta.env.VITE_APP_TITLE 渲染标题。

然而，重要的是要理解 模式 是一个更广泛的概念，而不仅仅是开发和生产。一个典型的例子是，你可能希望有一个 “staging” (预发布|预上线) 模式，它应该具有类似于生产的行为，但环境变量与生产环境略有不同。

你可以通过传递 --mode 选项标志来覆盖命令使用的默认模式。例如，如果你想为我们假设的 staging 模式构建应用：

vite build --mode staging

为了使应用实现预期行为，我们还需要一个 .env.staging 文件：

# .env.staging
NODE_ENV = production
VITE_APP_TITLE = My App (staging)

现在，你的 staging 应用应该具有类似于生产的行为，但显示的标题与生产环境不同。

五、常见配置示例

5.1 开发环境配置

.env.development 文件，使用 npm run server 时默认会加载此配置文件

NODE_ENV = "development"  //开发环境标志
VUE_APP_BASE_API = "/xxx_admin_test"  //API基础路径变量，此时为http://localhost:8080/xxx_admin_test
VUE_APP_DOMAIN = "http://localhost:8080"  //域名
VUE_APP_REDIRECT_URL = ""  //ADFS重定向URL，用于OAuth或单点登录流程中用户认证完成后重定向到这个URL来获得token
VUE_APP_CLIENT_ID = "xxxxxxxxxxxxxxx"  //OAuth客户端ID，用于OAuth授权
BASE_URL = ""  //路由基础路径，一般为空，表示应用的跟路径

5.2 生产环境配置

.env.production文件，使用 npm run build 时默认会加载此配置文件

NODE_ENV = "production"
VUE_APP_BASE_API = "/xxx_admin"
VUE_APP_DOMAIN = "http://xxx.xxx"
VUE_APP_REDIRECT_URL = "http://xxx.xxx/getToken"
VUE_APP_CLIENT_ID = "xxxxxxxxxxxxxxx"
BASE_URL = ""

5.3 测试环境配置

NODE_ENV = "test"
VUE_APP_BASE_API = "/xxx_admin_test"
VUE_APP_DOMAIN = "http://xxx.xxxx/xxx_test/"
VUE_APP_REDIRECT_URL = "http://xxx.xxxx/xxx_test/getToken"
VUE_APP_CLIENT_ID = "xxxxxxxxxxxxxxx"
BASE_URL = "/xxx_test"

5.4 其它环境配置

其他环境：.env.自定义名称文件，如云环境.env.cloud，内部测试环境.env.bata

六、编写启动命令

注意：除了 .env 文件会自动被加载外，其他环境需要手动的添加加载指令。

添加加载指令:

{
    "name": "xxx",
    "version": "0.1.0",
    "orivate": true,
    "scripts": {
        "serve": "vue-cli-service serve",  //启动项目，使用npm run serve指令自动加载.env和.env.development配置文件，所以不用写 --mode
        "build": "bie-cli-service build",  //生产环境打包，使用npm run build指令时，会自动加载.env和.env.production配置文件
        "lint": "vue-cli-service lint",
        "build:dev": "bie-cli-service build --mode developmemt",  //使用npm run build:dev指令运行时，会加载.env.developmemt配置文件
        "build:test": "bie-cli-service build --mode test",  //测试环境打包
        "build:cloud": "bie-cli-service build --mode cloud",  //云环境打包
    }
}

七、 获取环境变量

7.1 在 js 中访问环境变量

process.env.xxx 访问 .env 文件中的 xxx 变量。

7.2 在 vue 组件中访问环境变量

{{ $env.xxx }} ，通过 Vue.js 的 $env 对象访问环境变量的所有值

<template>
    <div>
        <p>API Endpoint: {{ $env.VUE_APP_API_ENDPOINT }}</p>
        <p>Log Level: {{ $env.VUE_APP_LOG_LEVEL }}</p>
    </div>
</template>

7.3 在路由中使用环境变量

路由配置中 base 参数：base: process.env.BASE_URL

import { createRouter, createWebHistory } from "vue-router";
import Home from "./views/Home.vue";
const routes = [
    { 
        //静态路由
        path: '/', 
        name: 'Home', 
        component: Home,
        meta: { title: "HOME" },
    }, {
        //动态路由
        path: '/user/:id',
        name: 'User',
        component: User,
        meta: { title: "USER" },
    }, {
        //嵌套路由
        path: '/dashboard',
        component: Dashboard,
        children: [
        {
            path: '',           //路由为`/dashboard`
            component: Overview,
            meta: { title: "DB" },
        }, {
            path: 'profile',    //路由为`/dashboard/profile`
            component: Profile,
            meta: { requiresAuth: true },
        }, {
            path: 'settings',   //路由为`/dashboard/settings`
            component: Settings,
            meta: { requiresAuth: false },
        } ]
    }
]
const router = createRouter({
    history: createWebHistory(),
    routes，
    base: process.env.BASE_URL,
})
export default router;

到此这篇关于Vue3+Vite 环境变量和模式配置详解的文章就介绍到这了,更多相关Vue3 Vite 环境变量内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文