為什麼應該始終向環境變數添加類型安全性？

一點背景

如果您已經編碼了一段時間，您就會知道環境變數的重要性及其所扮演的角色，以及找出由於專案中未設定該死的環境變數而導致的錯誤的痛苦，哈哈！

今年早些時候，我在一家以產品為基礎的新創公司擔任全端開發人員實習生。隨著專案的成長，環境變數的數量也隨之增加。而且，每個人都在不同的分支上開發不同的功能，所以我們不知道是否有人在他們的分支中引入了一些新的環境變量，這些變量後來被合併到主分支中。當我嘗試部署我的分支時，這產生了問題，我知道一個新的環境變數已新增到專案中。

然後，後來我接觸到了 T3 堆棧，它有一個出色的解決方案，可以為環境變數添加類型安全性。我什至不知道存在這樣的解決方案。在你最意想不到的時候學習新事物總是感覺很好。 T3 堆疊使用 zod 和 @t3-oss/env-nextjs 套件為我非常喜歡的應用程式添加類型安全性。之後，我承諾無論如何都要保證我的環境變數的類型安全。

如果您正在開始一個新項目，或者已經在團隊中工作，我強烈建議您為您的環境添加類型安全。僅添加此內容將節省您解決程式碼庫中問題的精力。

以下是如何將其新增至您的專案。非常簡單。

佐德是什麼？

Zod 是一個輕量級、快速的模式宣告和驗證函式庫。架構可以是從簡單字串、數字到複雜物件類型的任何內容。

基本用法

import {z} from 'zod';

const myBoolean = z.boolean();

myBoolean.parse('true'); // throws error
myBoolean.parse(true) // valid

建立嵌套物件模式

import { z } from 'zod';

const userSchema = z.object({
    name: z.string(),
    age: z.number(),
    address: z.object({
        house_no: z.string(),
        locality: z.string(),
        city: z.string(),
        state: z.string(),
    })
});

您可以建立簡單的物件架構或建立巢狀物件架構。

什麼是 t3-oss/env-nextjs？

它只是一個幫助我們為環境變數添加類型安全性的套件

讓我們建立類型安全的環境變數

在專案的根目錄中建立一個 env.js 檔案。

import {createEnv} from "@t3-oss/env-nextjs"; import {z} from "zod";

export const env = createEnv({
  /*
   * Serverside Environment variables, not available on the client.
   * Will throw if you access these variables on the client.
   */
  server: {
    DB_URI: z.string().url(),
  },
  /*
   * Environment variables available on the client (and server).
   *
   * You'll get type errors if these are not prefixed with NEXT_PUBLIC_.
   */
  client: {
    NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: z.string().min(1),
  },
  /*
   * Due to how Next.js bundles environment variables on Edge and Client,
   * we need to manually destructure them to make sure all are included in bundle.
   *
   * You'll get type errors if not all variables from `server` & `client` are included here.
   */
  runtimeEnv: {
    DB_URI: process.env.DATABASE_URL,
    NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY:
      process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY,
  },
});

用法

import {env} from '@/env';

const CLERK_PUBLISHABLE_KEY = env.NEXT_PUBLISHABLE_KEY;

如果將遊標停留在 NEXT_PUBLISHABLE_KEY 上方，您可以看到該值輸入為字串，這表示我們的環境變數現在已輸入。

我們新增了類型安全的環境變量，但這不會在每次建置時運行。我們必須將新建立的檔案匯入到 next.config.js 檔案中。您可以使用 unjs/jiti 套件來實作。

首先，從 npm 安裝 jiti pacakge。

import { fileURLToPath } from "node:url";
import createJiti from "jiti";
const jiti = createJiti(fileURLToPath(import.meta.url));

jiti("./app/env");

使用 import.meta.url 時，它提供您目前正在使用的檔案的 URL。但是，它包含您可能不想要的 file:/// 前綴。若要刪除該前綴，您可以使用 node:url 模組中的 fileURLToPath 函數。

例如：

import {fileURLToPath} from 'node:url';

// Convert the file URL to a path
const filename = fileURLToPath(import.meta.url);

現在，如果您沒有所需的環境變量，您將看到這樣的錯誤 -

如何為 Node.js 專案中的環境變數新增類型安全性？

import dotenv from "dotenv";
import { z } from "zod";

dotenv.config();

const schema = z.object({
  MONGO_URI: z.string(),
  PORT: z.coerce.number(),
  JWT_SECRET: z.string(),
  NODE_ENV: z
    .enum(["development", "production", "test"])
    .default("development"),
});

const parsed = schema.safeParse(process.env);

if (!parsed.success) {
  console.error(
    "❌ Invalid environment variables:",
    JSON.stringify(parsed.error.format(), null, 4)
  );
  process.exit(1);
}

export default parsed.data;

在 Node.js 專案中，我們將簡單地建立一個 zod 模式並根據 process.env 解析它，以檢查是否設定了所有 env 變數。

用法

import express from "express";
import env from "./env";

const app = express();
const PORT = env.PORT || 5000; // PORT is type safe here....

app.listen(PORT, () => {
console.log("Connected to server on PORT ${PORT}");
connectDB();
});

這就是為環境變數添加類型安全的方法。我希望您在本教程中學到一些新東西。

快樂編碼！ ！ ？

以上是為什麼應該始終向環境變數添加類型安全性？的詳細內容。更多資訊請關注PHP中文網其他相關文章！