Configuración de Ambientes con Archivos .env en Node.js

Curso de NestJS: Programación Modular, Documentación con Swagger y Deploy

Contenido del curso

Módulos de NestJS

Configuración de entornos

Documentación

Deploy

Próximos pasos

17
Inyección de Dependencias en APIs con Heroku
01:04 min

Tomar examen

Cursos Empresas Blog Live Conf Eventos Precios

0:007:20

Configuración de Ambientes con Archivos .env en Node.js

Curso de NestJS: Programación Modular, Documentación con Swagger y Deploy

Clase 10 de 17

Clase 10 / 17

Recursos

Una aplicación profesional suele tener más de un ambiente. Ambiente local, ambiente de desarrollo, ambiente de pruebas, producción, entre otros, dependiendo la necesidad del equipo y de la organización. Veamos cómo puedes administrar N cantidad de ambientes en NestJS.

Configuración dinámica del entorno

Configuremos la aplicación para intercambiar fácilmente entre diversos ambientes, cada uno con su propia configuración.

1. Archivo principal para manejo de ambientes

Crea un archivo llamado enviroments.ts (o el nombre que prefieras) que contendrá un objeto con una propiedad por cada ambiente que tenga tu aplicación.

// src/enviroments.ts
export const enviroments = {
  dev: '.env',
  test: '.test.env',
  prod: '.prod.env',
};

2. Configuración por ambiente

Crea un archivo .env por cada ambiente que necesites. Recuerda que todos los archivos finalizados en .env no deben guardarse en GIT.

// .test.env
DATABASE_NAME=my_db_test
API_KEY=12345

// .prod.env
DATABASE_NAME=my_db_prod
API_KEY=67890

3. Importando variables de entorno

Importa en el módulo principal de tu aplicación el archivo principal para manejo de ambientes y, a través de una única variable de entorno llamada NODE_ENV, elegirás qué configuración usar.

NODE_ENV es una variable de entorno propia de NodeJS y del framework Express que se encuentra preseteada en tu aplicación.

import { enviroments } from './enviroments'; // 👈

@Module({
  imports: [
    ConfigModule.forRoot({
      envFilePath: enviroments[process.env.NODE_ENV] || '.env', // 👈
      isGlobal: true,
    }),
  ],
})
export class AppModule {}

4. Inicio de la aplicación

Finalmente, para iniciar tu aplicación basta con el comando NODE_ENV=test npm run start:dev o NODE_ENV=prod npm run start:dev para configurar la variable de entorno principal NODE_ENV y escoger qué configuración utilizar.

5. Utilizando las variables de entorno

Puedes utilizar las variables de entorno en tu aplicación de dos maneras. Con el objeto global de NodeJS llamado process:

process.env.DATABASE_NAME
process.env.API_KEY

O puedes usar estas variables a través del servicio ConfigService proveniente de @nestjs/config.

import { ConfigService } from '@nestjs/config';

@Injectable()
export class AppService {

  constructor(private config: ConfigService) {}
  
  getEnvs(): string {
    const apiKey = this.config.get<string>('API_KEY');
    const name = this.config.get('DATABASE_NAME');
    return `Envs: ${apiKey} ${name}`;
  }
}

De este modo, configura de la mejor manera que necesites para tu aplicación el manejo de múltiples ambientes, cada uno con su propia configuración.

Cuadro de código para la configuración de ambientes

// .stag.env
DATABASE_NAME=my_db_stag
API_KEY=333

// .prod.env
DATABASE_NAME=my_db_prod
API_KEY=999

// src/enviroments.ts
export const enviroments = {
  dev: '.env',
  stag: '.stag.env',
  prod: '.prod.env',
};

// src/app.module.ts
...

import { enviroments } from './enviroments'; // 👈

@Module({
  imports: [
    ConfigModule.forRoot({
      envFilePath: enviroments[process.env.NODE_ENV] || '.env', // 👈
      isGlobal: true,
    }),
    ...
  ],
  ...
})
export class AppModule {}

// src/app.service.ts
import { ConfigService } from '@nestjs/config'; // 👈

@Injectable()
export class AppService {
  constructor(
    @Inject('TASKS') private tasks: any[],
    private config: ConfigService,  // 👈
  ) {}
  getHello(): string {
    const apiKey = this.config.get<string>('API_KEY');  // 👈
    const name = this.config.get('DATABASE_NAME');  // 👈
    return `Hello World! ${apiKey} ${name}`;
  }
}

Rin with NODE_ENV // 👈 NODE_ENV=prod npm run start:dev NODE_ENV=stag npm run start:dev

Contribución creada por: Kevin Fiorentino.

Ángel David Roque Ayala

Hace 5 años

Apuntes

Crear archivos env para los distintos ambientes

Ya que configuramos el archivo env que contiene el valor de las variables de entorno para el servidor de desarrollo debemos crear los archivos .env para el servidor de pruebas y produccion.

// .stag.env
DATABASE_NAME=my_db_stag
API_KEY=333

// .prod.env
DATABASE_NAME=my_db_prod
API_KEY=999

¿Cómo elegir dinámicamente el archivo env?

Nuestro código debe elegir automáticamente que archivo .env debe tomar según en el servidor en el que se este ejecutando. Para ello debemos crear un objeto en donde listaremos todos los ambientes que existen y los ligaremos con su archivo correspondiente.

// src/enviroments.ts
export const enviroments = {
  dev: '.env',
  stag: '.stag.env',
  prod: '.prod.env',
};

Ahora solo debemos agregar la linea mágica para que el archivo .env correspondiente se inyecte en el código.

// src/app.module.ts
...

import { enviroments } from './enviroments'; // 👈

@Module({
  imports: [
    ConfigModule.forRoot({
      envFilePath: enviroments[process.env.NODE_ENV] || '.env', // 👈
      isGlobal: true,
    }),
    ...
  ],
  ...
})
export class AppModule {}

Llamar a las variables de entorno

Listo, ahora solo debemos preocuparnos por obtener las variables de entorno.

// src/app.service.ts
import { ConfigService } from '@nestjs/config'; // 👈

@Injectable()
export class AppService {
  constructor(
    @Inject('TASKS') private tasks: any[],
    private config: ConfigService,  // 👈
  ) {}
  getHello(): string {
    const apiKey = this.config.get<string>('API_KEY');  // 👈
    const name = this.config.get('DATABASE_NAME');  // 👈
    return `Hello World! ${apiKey} ${name}`;
  }
}

Especificar ambiente

Podemos indicar en que ambiente se esta trabajando usando las siguientes lineas.

NODE_ENV=prod npm run start:dev
NODE_ENV=stag npm run start:dev

Si estas usando el powershell de windos

$env:NODE_ENV="prod"; npm run start:dev
$env:NODE_ENV="stag"; npm run start:dev
$env:NODE_ENV="dev"; npm run start:dev

Comentarios (26)26 comentarios

Joel Campos

Nicolas Molina

Profesor

Jorge Estrada Frasés

Juan Ignacio Zunino

Hace 3 años

Marcelo Fernández

Mariano Tribuj

Gilbert Ardila

Miguel Angel Reyes Moreno

Renato Renzo Luna Herrera

Pablo Antipan Quiñenao

Robinson De La Cruz

Hace 4 años

Emmanuel Gutierrez

Ricardo Enrique Vargas Peraza

Jonnathan Ramiro Juma Jara

Gerardo Pacheco Bautista

Hace un año

John Erikc Alexander Obando Ramirez

Hace 2 años

Eduardo Rodriguez Cisneros

Elio Rivas

Marcel Marin

Kenneth Leonel Cruz Ordoñez

Sebastián Gonzalez Quintero

Erick Saravia

Irving Caamal

Módulos de NestJS

Programación Modular y Deployment en Nest GS

Encapsulación de Lógica en Módulos con NestJS

Programación Modular en NestJS: Controladores y Entidades

Interacción entre Módulos en NestJS: Servicios y Controladores

Inyección de Dependencias en Arquitectura de Software

Tipos de Providers en NestJS: Use Class y Use Value

useFactory

Uso de Módulos Globales en NestJS para Inyecciones Compartidas

Configuración de entornos

Configuración y uso de variables de entorno en NestJS

Configuración de Ambientes con Archivos .env en Node.js

Tipado seguro en TypeScript para configuración de aplicaciones

Validación de Variables de Entorno con Joi en Node.js

Documentación

Documentación automática de APIs con NestJS y Swagger

Documentación de API con NestJS y Swagger

Deploy

Deployment de Aplicaciones Node.js en Heroku

Deployment de Aplicaciones en Heroku: Configuración y Solución de Errores

Próximos pasos

Inyección de Dependencias en APIs con Heroku

Configuración de Ambientes con Archivos .env en Node.js

Progreso del curso

Módulos de NestJS

Configuración de entornos

Documentación

Deploy

Próximos pasos

Recursos

Recursos