Comment définir des variables d'environnement dans Node.js

Les logiciels modernes exigent flexibilité, évolutivité et sécurité robuste. Les variables environnementales jouent un rôle essentiel dans la réalisation de cet équilibre. Ce guide explore diverses méthodes de définition et de gestion des variables d'environnement dans les applications Node.js, en mettant l'accent sur les meilleures pratiques en matière de sécurité et de maintenabilité. Nous couvrirons tout, de la validation du démarrage à la prévention de l'exposition des données sensibles. Que vous soyez un développeur chevronné ou nouveau sur Node.js, ces informations sont essentielles pour créer des applications sécurisées et adaptables.

Que sont les variables d'environnement ?

Les variables d'environnement sont des paires clé-valeur stockées en dehors de la base de code de votre application, généralement dans les fichiers de configuration ou les paramètres système. Ils contiennent des données sensibles telles que des clés API et des informations d'identification de base de données, empêchant le codage en dur et améliorant la sécurité. Cette approche simplifie la gestion dans différents environnements (développement, tests, production).

Dans Node.js, les variables d'environnement permettent une configuration dynamique des applications sans modification du code. La même base de code peut interagir avec différentes bases de données ou API en fonction de l'environnement, améliorant ainsi la sécurité, simplifiant le déploiement et améliorant l'adaptabilité.

Contrairement aux variables JavaScript standard, les variables d'environnement ne sont pas définies dans le code. Ils sont accessibles via process.env et existent indépendamment, influençant potentiellement plusieurs applications sur le système.

Accès aux variables d'environnement dans Node.js

Node.js utilise l'objet process.env pour accéder et gérer les variables d'environnement. Pour récupérer la valeur d'une variable, utilisez process.env.VARIABLE_NAME. Par exemple, process.env.API_KEY récupère la valeur associée à API_KEY. Bien qu'il soit techniquement possible de définir des variables d'environnement dans le code, cela est généralement déconseillé ; cela annule les avantages de l'utilisation de variables d'environnement en premier lieu.

Voici comment API_KEY peut être utilisé dans une API Express :

const express = require('express');
const app = express();

// Access API key from environment variables
const apiKey = process.env.API_KEY;

if (!apiKey) {
  console.error('Error: API key is not defined.');
  process.exit(1);
}

app.get('/', (req, res) => {
  res.send('API key successfully loaded.');
});

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

Définition des variables d'environnement dans Node.js

Explorons maintenant différentes méthodes de définition des variables d'environnement :

1. Utilisation de dotenv : Le package dotenv simplifie la gestion des variables d'environnement en les séparant de votre code. Définir des paires clé-valeur dans un .env fichier :

<code>PORT=3000
DB_USERNAME=dbuser</code>

Importez-le et utilisez-le comme ceci :

import * as dotenv from 'dotenv';
dotenv.config();

console.log(process.env.PORT); // Output: 3000
console.log(process.env.DB_USERNAME); // Output: dbuser

Vous pouvez spécifier des chemins de fichiers .env alternatifs en utilisant dotenv.config({ path: './path/to/another.env' }). Bien qu'utiles pour le développement, envisagez d'autres méthodes de production.

2. Paramètre au niveau du système : Sur les systèmes de type Unix (Linux, macOS), ajoutez des variables à votre fichier de configuration shell (par exemple, ~/.bashrc, ~/.zshrc). Cela affecte tous les processus de cette session shell. Par exemple :

const express = require('express');
const app = express();

// Access API key from environment variables
const apiKey = process.env.API_KEY;

if (!apiKey) {
  console.error('Error: API key is not defined.');
  process.exit(1);
}

app.get('/', (req, res) => {
  res.send('API key successfully loaded.');
});

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

Redémarrez votre terminal ou exécutez source ~/.bashrc pour appliquer les modifications. Pour un accès à l’ensemble du système (processus système), utilisez /etc/environment.

3. Lancer le script : Créez un script qui définit des variables, puis exécute votre application Node.js (par exemple, launch.sh) :

<code>PORT=3000
DB_USERNAME=dbuser</code>

Rendez-le exécutable (chmod x launch.sh) et exécutez-le (./launch.sh).

4. PM2 (Process Manager 2) : PM2 permet de définir des variables d'environnement lors du démarrage de l'application :

import * as dotenv from 'dotenv';
dotenv.config();

console.log(process.env.PORT); // Output: 3000
console.log(process.env.DB_USERNAME); // Output: dbuser

Ou utilisez un fichier ecosystem.config.js pour les configurations spécifiques à l'environnement.

5. Docker : Dans Docker, définissez les variables dans le Dockerfile en utilisant ENV:

# ~/.bashrc
export PORT=3000
export DB_USERNAME=myuser

Remplacez les valeurs par défaut lors de l'exécution du conteneur à l'aide de -e PORT=5173 ou dans un fichier docker-compose.yml.

Bonnes pratiques d'utilisation des variables d'environnement

Suivez ces bonnes pratiques pour des applications sécurisées et maintenables :

• Noms descriptifs et documentation : Utilisez des noms clairs et descriptifs et documentez leur objectif dans le README de votre projet.

• Validation du démarrage : Validez les variables d'environnement au démarrage de l'application pour vous assurer qu'elles sont correctement définies. Gérez les variables manquantes avec élégance (valeurs par défaut ou gestion des erreurs).

• .env Exclusion de fichiers : Excluez les fichiers .env du contrôle de version (Git) à l'aide de .gitignore.

• Envisagez un KMS (Key Management System) : Pour une sécurité renforcée, notamment avec les données très sensibles, utilisez un KMS pour chiffrer et stocker vos variables d'environnement.

• Valeurs par défaut : Fournissez des valeurs par défaut pour les variables d'environnement non critiques afin de garantir la fonctionnalité de l'application même si des variables sont manquantes.

• Ne jamais exposer dans le frontend : N'exposez jamais les variables d'environnement sensibles directement au code côté client.

Utilisation par le commis des variables d'environnement

Les SDK Clerk utilisent des variables d'environnement pour la configuration et l'association d'applications dans le tableau de bord Clerk. Cela permet des requêtes back-end sécurisées et une validation front-end à l’aide d’Express. Par exemple :

#!/bin/bash
export PORT=3000
export DB_USERNAME=myuser
node app.js

Conclusion

La gestion sécurisée des variables d'environnement est primordiale. En suivant ces bonnes pratiques, vous améliorerez considérablement la sécurité et la maintenabilité de vos applications Node.js, en vous assurant qu'elles sont prêtes pour le déploiement en production.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!