Introdução ao Spring Dotenv

Definição

Spring Dotenv facilita a manipulação de variáveis de ambiente por meio da integração entre o Spring e a biblioteca dotenv-java.

A declaração das variáveis de ambiente é feita a partir de um arquivo .env.

Configuração

  1. Criar o arquivo .env e definir as variáveis de ambiente:

    KEY=VALUE
  2. Adicioná-lo ao .gitignore:

    # .gitignore 
    .env
  3. Adicionar Spring Dotenv como dependência (Maven):

    <dependency>
      <groupId>me.paulschwarz</groupId>
      <artifactId>spring-dotenv</artifactId>
      <version>2.5.4</version>
    </dependency>

Sintaxe

Em um arquivo de configuração do Spring, utiliza a seguinte sintaxe para obter o valor de uma variável de ambiente:

  • Arquivo .env:

    PROJECT_NAME=Spring Dotenv
  • Arquivo de configuração Spring:

    project.name = ${env.PROJECT_NAME}
    project:
      name: ${env.PROJECT_NAME}