Vue3 Vite3 多環境配置 - 基於 vite 創建 vue3 全家桶項目(續篇)

来源:https://www.cnblogs.com/youyacoder/archive/2022/10/06/16758042.html
-Advertisement-
Play Games

在項目或產品的迭代過程中,通常會有多套環境,常見的有: dev:開發環境 sit:集成測試環境 uat:用戶接收測試環境 pre:預生產環境 prod:生產環境 環境之間配置可能存在差異,如介面地址、全局參數等。在基於 vue-cli (webpack) 的項目中只需要添加 .env.xxx 文件, ...


在項目或產品的迭代過程中,通常會有多套環境,常見的有:

  • dev:開發環境
  • sit:集成測試環境
  • uat:用戶接收測試環境
  • pre:預生產環境
  • prod:生產環境

環境之間配置可能存在差異,如介面地址、全局參數等。在基於 vue-cli (webpack) 的項目中只需要添加 .env.xxx 文件,然後在 package.jsonscripts 啟動或打包命令中指定 mode 參數即可,獲取環境變數時使用 process.env.xxxvite 使用方式類似,但獲取環境變數使用 import.meta.env

1 環境變數和模式

上面提到,vite 中使用 import.meta.env 的方式來獲取環境變數。在 main.ts 中添加如下代碼進行測試:

const env = import.meta.env
console.log(env)

1.1 development

首先執行 yarn dev 啟動服務,在瀏覽器控制台輸出 env 的值:

image-20221006002025067

可以看出 import.mata.env 中預設包括五個內置環境變數:

MODE:應用的運行模式。由於我們是通過 yarn dev 啟動服務,而 yarn dev 本質是執行 vite 啟動,未顯式執行 mode,故 MODE 的值為 development

BASE_URL:部署應用時的基本 URL,在 vite 的配置文件 vite.config.ts 中的 base 屬性指定;

PROD:是否是生產環境(即是否通過 vite build 構建)

DEV:是否是開發環境(即是否通過 vite 啟動服務運行)

SSR:是否是服務端渲染模式。

1.2 production

首先執行 yarn build 打包(本質上是執行 vite build),打包完成後通過 yarn preview 對打包結果進行預覽。訪問預覽地址,在瀏覽器控制塔輸出如下:

image-20221006002902362

可以看出模式為 production,非開發模式,是生產模式。

1.3 指定模式

修改 package.json 中的 scripts 命令,分別為開發和打包指定三種模式:dev、uat、prod。指定模式只需要在命令後通過參數 --mode 指定即可。

"scripts": {
  "dev": "yarn dev:dev",
  "dev:dev": "vite --mode dev",
  "dev:uat": "vite --mode uat",
  "dev:prod": "vite --mode prod",
  "build:dev": "vue-tsc --noEmit && vite build --mode dev",
  "build:uat": "vue-tsc --noEmit && vite build --mode uat",
  "build:prod": "vue-tsc --noEmit && vite build --mode prod",
  "preview": "vite preview"
},

執行 yarn dev:dev,瀏覽器輸出 MODE: dev

執行 yarn dev:uat,瀏覽器輸出 MODE: uat

執行 yarn dev:prod,瀏覽器輸出 MODE: prod

接下來依次通過 build:xxx 先打包後再通過 preview 預覽打包,結果與上面一致,瀏覽器輸出的 MODE 與命令中 --mode 指定的值一致。

2 環境文件(.env)

Vite 使用 dotenv環境文件目錄 中載入環境文件,預設情況下,環境文件目錄為項目的根目錄,即把環境文件放在項目根目錄下。在 vite 中,可以通過配置 envDir 屬性指定環境文件目錄。

2.1 指定環境文件目錄

在項目根目錄下創建目錄 env,用於存放所有的環境文件。

vite.config.ts 中添加 envDir 屬性指定環境文件目錄為 env

...
export default defineConfig({
  ...
  envDir: path.resolve(__dirname, './env')
})

2.2 添加環境文件

環境文件命名如下:

.env                # 所有情況下都會載入
.env.local          # 所有情況下都會載入,但會被 git 忽略
.env.[mode]         # 只在指定模式下載入
.env.[mode].local   # 只在指定模式下載入,但會被 git 忽略

不同環境的變數可以定義在 .env.[mode] 文件中,如 .env.dev.env.prod 等,如果 .env 文件和 .env.[mode] 中有相同的 key,後者定義的值會覆蓋前者。

這裡咱們以三個環境為例編寫 demo,分別是:

  • 開發環境,mode 為 dev,文件名為 .env.dev
  • 測試環境,mode 為 uat,文件名為 .env.uat
  • 生產環境,mode 為 prod,文件名為 .env.prod

在上面指定的環境文件目錄 env 下創建上面三個文件,以及所有情況下都會載入的 .env 文件。四個文件內容如下:

.env 文件

VITE_BASE_API=/api
VITE_APP_NAME='demo app'
DEMO_STR=hello

.env.dev 文件

VITE_BASE_API=/dev-api

.env.uat 文件

VITE_BASE_API=/uat-api

.env.prod 文件

VITE_BASE_API=/prod-api

四個文件都定義了變數 VITE_BASE_API.env 中還額外定義了 VITE_APP_NAMEDEMO_STR 兩個變數。

使用 yarn dev:dev 啟動服務,或者先使用 yarn build:dev 打包,再通過 yarn preview 預覽打包結果,瀏覽器中都會輸出 VITE_BASE_APIVITE_APP_NAME 的值。VITE_BASE_API 值為 .env.dev 中定義的 /dev-apiVITE_APP_NAME 值為 .env 中定義的 demo app,但是 .env 中定義的 DEMO_STR 不會輸出。由此可以看出:

  1. 無論是哪種模式,.env 文件都會被載入;
  2. 如果 .env.[mode].env 中有相同的 key,對應模式的環境文件中的值會覆蓋 .env 對應 key 的值;
  3. 環境變數需要以 VITE_ 開頭才會暴露到 import.meta.env 中。

有興趣的朋友可以再添加 .env.dev.local 文件進行測試,.env.[mode].local 優先順序最高。

3 TypeScript 提示

我使用的 IDE 是 WebStorm,之前在 main.ts 中將 import.meta.env 賦值給變數 env

const env = import.meta.env

輸入 env.,WebStorm會有下圖中的提示:

image-20221006110746181

但是沒有提示我們添加的環境變數。可以添加 env.d.ts 解決。在 src 目錄下創建文件 env.d.ts,文件內容如下:

/// <reference types="vite/client" />

interface ImportMetaEnv {
  readonly VITE_BASE_API: string;
  readonly VITE_APP_NAME: string;
}

// eslint-disable-next-line no-unused-vars
interface ImportMeta {
  readonly env: ImportMetaEnv
}

在 ImportMetaEnv 中添加上環境文件中定義的變數即可。

此時再次在 main.ts 中輸入 env.,IDEA便可以有正確的代碼提示,並且可以獲取該變數的類型:

image-20221006111522409

4 補充說明

在基於 vue-cli(webpack) 的項目中獲取環境變數是通過 process.env.xxx 的方式,如果不進行配置,在瀏覽器中會報錯,提示 process is undefine。於是我按照網上的方式,在 vite.config.ts 中首先通過 vite 提供的 loadEnv 函數載入環境變數,然後在導出對象中添加 define 屬性,在 define 中將 loadEnv 返回的結果賦值給 process.env,如下:

define: {
  'process.env': loadEnv(env.mode, process.cwd(), '')
}

通過這種方式,在開發模式下(vite 啟動服務),可以正常獲取到環境變數,甚至環境變數不要求以 VITE_ 開頭。但是使用 vite build 打包一直失敗,在使用了 process.env 提示 parse error,到現在也不知道怎麼處理。如果知道怎麼處理的伙伴歡迎留言。

不過個人更推薦按照官方的方式,使用 import.meta.env

文中 demo 在 github 上搜索 vue3-vite-archetype 獲取,main 分支可以直接 yarn dev 啟動運行; template 分支是 yyg-cli 執行 yyg create 創建項目時拉取的模板。你也可以先執行 npm install -g yyg-cli 安裝 yyg-cli 腳手架工具,然後通過 yyg create xxx 創建項目,創建後的項目包含了 vue3 vite 的全部demo。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 上一章講到如何將程式寫入到ESP8266 WiFi模塊中,實現物聯網終端對硬體的控制。本章將通過fubuki-iot實現自定義硬體控制。同時給出一個替代百度API的方案。 硬體準備 (無) 自定義語義模型 在第一章的“提醒事項”的例子中,fubuki-iot就展現了語義模型的功能。它將命中語義模型的 ...
  • 原文:Libgdx游戲開發(2)——接水滴游戲實現 - Stars-One的雜貨小窩 本文使用Kotlin語言開發 通過本文的學習可以初步瞭解以下基礎知識的使用: Basic file access Clearing the screen Drawing images Using a camera ...
  • 一、後臺管理系統配置 1 在該表對應的models類裡面添加一個Meta類 class Meta: verbose_name_plural = '用戶表' # 指定該表在admin後臺的名字為: 用戶表 # verbose_name = '用戶表' # 末尾還是會自動加s 2 null=True,b ...
  • 我們看到下麵的示例圖是 在右鍵文件夾上查看菜單,帶有兩級的菜單選項。 文件夾 空白處 需要使用管理員許可權運行 因為右鍵菜單需要註冊表信息,打開註冊表需要管理員許可權UAC,所以在執行命令過程中需要使用管理員許可權來執行命令 import sys import winreg as reg import o ...
  • 我的博客 這個教程只適合windows,linux不適用,不過話說回來了,linux都是自帶python的,所以已經預置好了,只要打python就行了,根本不用加環境變數 言歸正傳 寫了好長時間的python,最近發現個很基礎的問題,就是很多同學已經安裝python了,但是不知道怎麼運行,找了教程, ...
  • 一、SpringMVC簡介 1、什麼是MVC MVC是一種軟體架構的思想,將軟體按照模型、視圖、控制器來劃分 **M:**Model,模型層,指工程中的JavaBean,作用是處理數據 JavaBean分為兩類: 一類稱為實體類Bean:專門存儲業務數據的,如Student、User等 一類稱為業務 ...
  • 本文講述了朴素貝葉斯的原理,概率的計算方式,給出代碼的詳細解釋,並最後給出代碼的運行過程的總結,然後又用了兩個實例來講述朴素貝葉斯代碼的計算過程 ...
  • 前言 相信接觸過併發系統的小伙伴們基本都使用過線程池,或多或少調整過對應的參數。以 Java 中的經典模型來說,能夠配置核心線程數、最大線程數、隊列容量等等參數。 public ThreadPoolExecutor(int corePoolSize, int maximumPoolSize, lon ...
一周排行
    -Advertisement-
    Play Games
  • 1、預覽地址:http://139.155.137.144:9012 2、qq群:801913255 一、前言 隨著網路的發展,企業對於信息系統數據的保密工作愈發重視,不同身份、角色對於數據的訪問許可權都應該大相徑庭。 列如 1、不同登錄人員對一個數據列表的可見度是不一樣的,如數據列、數據行、數據按鈕 ...
  • 前言 上一篇文章寫瞭如何使用RabbitMQ做個簡單的發送郵件項目,然後評論也是比較多,也是準備去學習一下如何確保RabbitMQ的消息可靠性,但是由於時間原因,先來說說設計模式中的簡單工廠模式吧! 在瞭解簡單工廠模式之前,我們要知道C#是一款面向對象的高級程式語言。它有3大特性,封裝、繼承、多態。 ...
  • Nodify學習 一:介紹與使用 - 可樂_加冰 - 博客園 (cnblogs.com) Nodify學習 二:添加節點 - 可樂_加冰 - 博客園 (cnblogs.com) 介紹 Nodify是一個WPF基於節點的編輯器控制項,其中包含一系列節點、連接和連接器組件,旨在簡化構建基於節點的工具的過程 ...
  • 創建一個webapi項目做測試使用。 創建新控制器,搭建一個基礎框架,包括獲取當天日期、wiki的請求地址等 創建一個Http請求幫助類以及方法,用於獲取指定URL的信息 使用http請求訪問指定url,先運行一下,看看返回的內容。內容如圖右邊所示,實際上是一個Json數據。我們主要解析 大事記 部 ...
  • 最近在不少自媒體上看到有關.NET與C#的資訊與評價,感覺大家對.NET與C#還是不太瞭解,尤其是對2016年6月發佈的跨平臺.NET Core 1.0,更是知之甚少。在考慮一番之後,還是決定寫點東西總結一下,也回顧一下.NET的發展歷史。 首先,你沒看錯,.NET是跨平臺的,可以在Windows、 ...
  • Nodify學習 一:介紹與使用 - 可樂_加冰 - 博客園 (cnblogs.com) Nodify學習 二:添加節點 - 可樂_加冰 - 博客園 (cnblogs.com) 添加節點(nodes) 通過上一篇我們已經創建好了編輯器實例現在我們為編輯器添加一個節點 添加model和viewmode ...
  • 前言 資料庫併發,數據審計和軟刪除一直是數據持久化方面的經典問題。早些時候,這些工作需要手寫複雜的SQL或者通過存儲過程和觸發器實現。手寫複雜SQL對軟體可維護性構成了相當大的挑戰,隨著SQL字數的變多,用到的嵌套和複雜語法增加,可讀性和可維護性的難度是幾何級暴漲。因此如何在實現功能的同時控制這些S ...
  • 類型檢查和轉換:當你需要檢查對象是否為特定類型,並且希望在同一時間內將其轉換為那個類型時,模式匹配提供了一種更簡潔的方式來完成這一任務,避免了使用傳統的as和is操作符後還需要進行額外的null檢查。 複雜條件邏輯:在處理複雜的條件邏輯時,特別是涉及到多個條件和類型的情況下,使用模式匹配可以使代碼更 ...
  • 在日常開發中,我們經常需要和文件打交道,特別是桌面開發,有時候就會需要載入大批量的文件,而且可能還會存在部分文件缺失的情況,那麼如何才能快速的判斷文件是否存在呢?如果處理不當的,且文件數量比較多的時候,可能會造成卡頓等情況,進而影響程式的使用體驗。今天就以一個簡單的小例子,簡述兩種不同的判斷文件是否... ...
  • 前言 資料庫併發,數據審計和軟刪除一直是數據持久化方面的經典問題。早些時候,這些工作需要手寫複雜的SQL或者通過存儲過程和觸發器實現。手寫複雜SQL對軟體可維護性構成了相當大的挑戰,隨著SQL字數的變多,用到的嵌套和複雜語法增加,可讀性和可維護性的難度是幾何級暴漲。因此如何在實現功能的同時控制這些S ...