Como acessar um valor definido no arquivo application.properties no Spring Boot

Quero acessar os valores fornecidos em application.properties, por exemplo:

logging.level.org.springframework.web: DEBUG
logging.level.org.hibernate: ERROR
logging.file=${HOME}/application.log

userBucket.path=${HOME}/bucket

Quero acessar userBucket.pathmeu programa principal em um aplicativo Spring Boot.

Você pode usar a @Valueanotação e acessar a propriedade em qualquer bean Spring que estiver usando

@Value("${userBucket.path}")
private String userBucketPath;

A seção Configuração Externalizada dos documentos da Inicialização em Spring explica todos os detalhes que você pode precisar.

Outra maneira é injetar org.springframework.core.env.Environmentno seu feijão.

@Autowired
private Environment env;
....

public void method() {
    .....  
    String path = env.getProperty("userBucket.path");
    .....
}

@ConfigurationPropertiespode ser usado para mapear valores de .properties( .ymltambém suportado) para um POJO.

Considere o seguinte arquivo de exemplo.

.properties

cust.data.employee.name=Sachin
cust.data.employee.dept=Cricket

Employee.java

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@ConfigurationProperties(prefix = "cust.data.employee")
@Configuration("employeeProperties")
public class Employee {

    private String name;
    private String dept;

    //Getters and Setters go here
}

Agora, o valor das propriedades pode ser acessado através da ligação automática da employeePropertiesseguinte maneira.

@Autowired
private Employee employeeProperties;

public void method() {

   String employeeName = employeeProperties.getName();
   String employeeDept = employeeProperties.getDept();

}

Atualmente, conheço as três maneiras a seguir:

1. A @Valueanotação

    @Value("${<property.name>}")
    private static final <datatype> PROPERTY_NAME;

• Na minha experiência, existem algumas situações em que você não consegue obter o valor ou ele está definido como null. Por exemplo, quando você tenta defini-lo em um preConstruct()método ou init()método. Isso acontece porque a injeção de valor ocorre depois que a classe é totalmente construída. É por isso que é melhor usar a 3ª opção.

2. A @PropertySourceanotação

<pre>@PropertySource("classpath:application.properties")

//env is an Environment variable
env.getProperty(configKey);</pre>

• PropertySoucedefine valores do arquivo de origem da propriedade em uma Environmentvariável (na sua classe) quando a classe é carregada. Então você é capaz de buscar facilmente um posfácio.
  • Acessível através da variável de ambiente do sistema.

3. A @ConfigurationPropertiesanotação.

• Isso é usado principalmente em projetos Spring para carregar propriedades de configuração.

• Inicializa uma entidade com base nos dados da propriedade.

  • @ConfigurationProperties identifica o arquivo de propriedades a ser carregado.
  • @Configuration cria um bean com base nas variáveis ​​do arquivo de configuração.

  @ConfigurationProperties (prefixo = "usuário")
  @Configuration ("UserData")
  usuário da classe {
    // Propriedade e seu getter / setter
  }
  
  @Autowired
  private UserData userData;
  
  userData.getPropertyName ();

Você pode fazê-lo dessa maneira também ....

@Component
@PropertySource("classpath:application.properties")
public class ConfigProperties {

    @Autowired
    private Environment env;

    public String getConfigValue(String configKey){
        return env.getProperty(configKey);
    }
}

Onde quer que você queira ler a partir de application.properties, basta passar a chave para o método getConfigValue.

@Autowired
ConfigProperties configProp;

// Read server.port from app.prop
String portNumber = configProp.getConfigValue("server.port"); 

Você pode usar o @Valuepara carregar variáveis ​​do application.propertiesse você usar esse valor em um único local, mas se precisar de uma maneira mais centralizada de carregar essas variáveis, @ConfigurationPropertiesé uma abordagem melhor.

Além disso, você pode carregar variáveis ​​e convertê-las automaticamente se precisar de tipos de dados diferentes para executar suas validações e lógica de negócios.

application.properties
custom-app.enable-mocks = false

@Value("${custom-app.enable-mocks}")
private boolean enableMocks;

Siga esses passos. 1: - crie sua classe de configuração como abaixo, você pode ver

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.beans.factory.annotation.Value;

@Configuration
public class YourConfiguration{

    // passing the key which you set in application.properties
    @Value("${userBucket.path}")
    private String userBucket;

   // getting the value from that key which you set in application.properties
    @Bean
    public String getUserBucketPath() {
        return userBucket;
    }
}

2: - quando você tem uma classe de configuração, injete a variável na configuração em que você precisa.

@Component
public class YourService {

    @Autowired
    private String getUserBucketPath;

    // now you have a value in getUserBucketPath varibale automatically.
}

1.Injecting a property with the @Value annotation is straightforward:
@Value( "${jdbc.url}" )
private String jdbcUrl;

2. we can obtain the value of a property using the Environment API

@Autowired
private Environment env;
...
dataSource.setUrl(env.getProperty("jdbc.url"));

Um aplicativo pode ler 3 tipos de valor no arquivo application.properties.

application.properties

     my.name=kelly

my.dbConnection ={connection_srting:'http://localhost:...',username:'benz',password:'pwd'}

arquivo de classe

@Value("${my.name}")
private String name;

@Value("#{${my.dbConnection}}")
private Map<String,String> dbValues;

Se você não tiver uma propriedade em application.properties, poderá usar o valor padrão

        @Value("${your_name : default value}")
         private String msg; 

O Spring-boot nos permite vários métodos para fornecer configurações externalizadas, você pode tentar usar arquivos application.yml ou yaml em vez do arquivo de propriedades e fornecer diferentes arquivos de propriedades configurados de acordo com diferentes ambientes.

Podemos separar as propriedades de cada ambiente em arquivos yml separados em perfis de mola separados.Em seguida, durante a implantação, você pode usar:

java -jar -Drun.profiles=SpringProfileName

para especificar qual perfil de primavera usar. Observe que os arquivos yml devem ter nomes como

application-{environmentName}.yml

para que sejam capturados automaticamente pelo springboot.

Referência: https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-profile-specific-properties

Para ler do arquivo application.yml ou property:

A maneira mais fácil de ler um valor do arquivo de propriedades ou do yml é usar a anotação spring @value.Spring carrega automaticamente todos os valores do yml para o ambiente do spring, para que possamos usar diretamente esses valores do ambiente, como:

@Component
public class MySampleBean {

@Value("${name}")
private String sampleName;

// ...

}

Ou outro método que o Spring fornece para ler feijões fortemente tipados é o seguinte:

YML

ymca:
    remote-address: 192.168.1.1
    security:
        username: admin

POJO correspondente para ler o yml:

@ConfigurationProperties("ymca")
public class YmcaProperties {
    private InetAddress remoteAddress;
    private final Security security = new Security();
    public boolean isEnabled() { ... }
    public void setEnabled(boolean enabled) { ... }
    public InetAddress getRemoteAddress() { ... }
    public void setRemoteAddress(InetAddress remoteAddress) { ... }
    public Security getSecurity() { ... }
    public static class Security {
        private String username;
        private String password;
        public String getUsername() { ... }
        public void setUsername(String username) { ... }
        public String getPassword() { ... }
        public void setPassword(String password) { ... }
    }
}

O método acima funciona bem com arquivos yml.

Referência: https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html

Para mim, nenhuma das opções acima funcionou diretamente para mim. O que eu fiz é o seguinte:

Além da resposta do @Rodrigo Villalba Zayas, adicionei
implements InitializingBeanà classe
e implementei o método

@Override
public void afterPropertiesSet() {
    String path = env.getProperty("userBucket.path");
}

Então isso vai parecer

import org.springframework.core.env.Environment;
public class xyz implements InitializingBean {

    @Autowired
    private Environment env;
    private String path;

    ....

    @Override
    public void afterPropertiesSet() {
        path = env.getProperty("userBucket.path");
    }

    public void method() {
        System.out.println("Path: " + path);
    }
}

As melhores maneiras de obter valores de propriedade estão usando.

1. Usando anotação de valor

@Value("${property.key}")
private String propertyKeyVariable;

2. Usando o bean Enviornment

@Autowired
private Environment env;

public String getValue() {
    return env.getProperty("property.key");
}

public void display(){
  System.out.println("# Value : "+getValue);
}

O melhor é usar a @Valueanotação que atribuirá valor automaticamente ao seu objeto private Environment en. Isso reduzirá seu código e será fácil filtrar seus arquivos.

Há duas vias,

1. você pode usar diretamente @Valuena sua classe

    @Value("#{'${application yml field name}'}")
    public String ymlField;

OU

1. Para torná-lo limpo, você pode limpar a @Configurationclasse onde você pode adicionar todos os seus@value

@Configuration
public class AppConfig {

    @Value("#{'${application yml field name}'}")
    public String ymlField;
}