Einrichten und Testen einer .env-Datei in Node

Richten Sie eine .env-Datei ein und testen Sie sie.

Diese Geschichte wurde ursprünglich hier veröffentlicht .

Das Paket dotenv ermöglicht das Laden einer .envDatei in ein Node.js-Projekt, das als zentraler Ort zum Verwalten von Umgebungsvariablen dient. Dieser Einzeldateiansatz macht das Aktualisieren und Verwalten von Umgebungsvariablen einfach.

Wenn Sie noch nicht mit Umgebungsvariablen vertraut sind, lesen Sie zuerst diesen Artikel Umgebungsvariablen in Node.js

Einrichten und Lesen einer .env-Datei

Die gebräuchlichste Lösung in der Node.js-Welt ist das dotenv-Paket zum Verwalten von Umgebungsvariablen. Sie können im Stammverzeichnis der Anwendung eine .env-Datei erstellen, die Schlüssel/Wert-Paare enthält, die die erforderlichen Umgebungsvariablen für Ihr Projekt definieren. Diese .env-Datei wird dann von der dotenv-Bibliothek gelesen und an process.env. Bitte übertragen Sie Ihre .env-Datei nicht .

Lassen Sie uns aktualisieren .gitignore, eine .envDatei erstellen und in 7 Schritten lesen:

  1. Aktualisieren Sie Ihre .gitignoreDatei.
  2. # Ignore .env files
    .env
    

    git add .gitignore
    git commit -m "Adding .env to .gitignore"
    

    npm i dotenv
    

    touch .env
    

    # API connection
    API_HOST=HOST-PLACEHOLDER-URL
    API_KEY=TOP-SECRET
    

require('dotenv').config();

console.log(process.env.API_HOST);

node index.js

Erstellen Sie optional ein config.js-Modul

Für Anwendungen mit vielen Konfigurationsoptionen wird empfohlen, ein separates Konfigurationsmodul zu erstellen. Dieses Modul muss in die Versionskontrolle übernommen werden.

Ein config.js-Modul könnte so aussehen:

const dotenv = require('dotenv');
dotenv.config();

module.exports = {
  version: '1.2.3,
  canonical_url: process.env.APPLICATION_ROOT,
  api: {
    host: process.env.API_HOST,
    key: process.env.API_KEY,
    secret: process.env.API_SECRET,
  },
  plugins: [
    'plugin-one',
    'plugin.two'
  ]
};

Dies hat auch den Vorteil, dass Sie Konfigurationen überall dort importieren können, wo sie benötigt werden, und die Destrukturierung verwenden, um nur die benötigten Werte herauszuziehen, die wir benötigen. Dies macht den Code viel sauberer.

Dokumentieren Sie Ihre Anwendung mit einem Beispiel für eine .env-Datei

Die .envDatei sollte umgebungsspezifisch sein und nicht in die Versionskontrolle eingecheckt werden. Es empfiehlt sich, die .envDatei mit einem Beispiel zu dokumentieren . Diese .env.exampleDatei dokumentiert die obligatorischen Variablen für die Anwendung und kann der Versionskontrolle übergeben werden. Dies bietet eine nützliche Referenz und beschleunigt den Onboarding-Prozess für neue Teammitglieder, da die Zeit, die Codebasis zu durchsuchen, um herauszufinden, was eingerichtet werden muss, reduziert wird.

A .env.examplekönnte so aussehen:

# Environment variables.

# Base URL of the API server to use. No trailing slash.
API_HOST=https://example.com
# API access credentials.
API_KEY=key
API_SECRET=secret

# Enable debug mode (true) or disable it (false).
DEBUG=false

Die dotenv-Bibliothek ändert niemals Umgebungsvariablen, die bereits festgelegt wurden. Wenn in Ihrer Umgebung bereits eine Variable festgelegt wurde und die Variable in der .env-Datei damit kollidiert, wird die Variable in der .env-Datei übersprungen.

TL;DR

  • .envFür eine saubere Trennung von umgebungsspezifischen Konfigurationen wird eine Datei benötigt.
  • Das Paket dotenv wird verwendet, um zur Laufzeit eine .env-Datei zu lesen, die Umgebungsvariablen enthält, und sie an das process.envObjekt anzuhängen .
  • Das Erstellen eines Beispiels für eine .envDatei zum Dokumentieren der obligatorischen Variablen beschleunigt die Projekteinrichtungszeit.
  • Übergeben Sie niemals eine .envDatei der Versionskontrolle.

Wenn Sie mehr über Node erfahren möchten, schauen Sie sich diese Node-Tutorials an .

Referenzen (und vielen Dank):

Node.js , Node.js-Dokumente HeyNode , dotenv

Suggested posts

Meine am häufigsten verwendeten Codierungsressourcen

Meine am häufigsten verwendeten Codierungsressourcen

Diese Woche erhielt ich eine E-Mail von einem Mitglied der täglichen E-Mail-Liste. Sie wollten wissen: Welche Ressourcen besuchen Sie täglich, wöchentlich und monatlich? Tolle Frage! Ich versuche gerne, einige Einblicke in meinen Arbeitsablauf und die wichtigsten Ressourcen, die ich verwende, mit Ihnen zu teilen.

Lit-Bibliotheksreihe – 1: Ein tiefer Einblick in die lit-html-Bibliothek

Lit-Bibliotheksreihe – 1: Ein tiefer Einblick in die lit-html-Bibliothek

Der Zweck dieser Blogreihe besteht darin, tief in die Lit-Bibliothek einzutauchen und ein umfassendes Verständnis ihrer einzigartigen Funktionen zu erlangen und zu erfahren, wie sie sich von anderen Bibliotheken und Frameworks auf dem Markt unterscheidet. Die Reihe ist in drei Teile gegliedert und behandelt Themen wie 1.

Related posts

Informationen zu Domänennamen finden

Ein Auszug aus Small, Sharp Software Tools von Brian P. Hogan

Informationen zu Domänennamen finden

Wenn Sie eine Anfrage an facebook.com stellen, sucht Ihr Computer nach dem Domänennamen, um diesen in eine IP-Adresse zu übersetzen, damit Ihr Computer diese Verbindung herstellen kann.

Die langsame Erosion: Enthüllung der Art und Weise, wie Menschen in ihrer Karriere verkümmern

Die langsame Erosion: Enthüllung der Art und Weise, wie Menschen in ihrer Karriere verkümmern

In der heutigen schnelllebigen und wettbewerbsintensiven Welt spielt die Karriere eine wichtige Rolle für das persönliche Wachstum, die finanzielle Stabilität und die allgemeine Lebenszufriedenheit. Viele Menschen befinden sich jedoch in einem unerbittlichen Kreislauf aus Stagnation und Unzufriedenheit, der ihr Berufsleben allmählich verkümmert.

Das erste Buch zum Thema „High“ für Kinder

Das erste Buch zum Thema „High“ für Kinder

(Warnung – das ist Satire, die fröhlich subversiv sein soll – definitiv nichts für Kinder) Sie haben gesehen, wie Ihre Eltern sich in der Küche versteckten und diese stinkenden Zigaretten rauchten. Sie sagen es dir.

Schaffung einer sicheren Arbeitsumgebung

Schaffung einer sicheren Arbeitsumgebung

„Er wird mich beschützen, wenn ich in Gefahr bin. Er wird mich in seinem Zelt verstecken.