SpringBoot项目加载配置文件的6种方式小结

更新时间：2023年09月18日 11:17:41 作者：Roue治愈者ヅ聶

这篇文章给大家总结了六种SpringBoot项目加载配置文件的方式,通过@value注入,通过@ConfigurationProperties注入,通过框架自带对象Environment实现属性动态注入,通过@PropertySource注解,yml外部文件,Java原生态方式注入这六种,需要的朋友可以参考下

1、通过@value注入

满足条件：

1、该类首先要被SpringBoot框架管理，属于SpringBoot框架的Bean。

2、application.properties（或者application.yml）配置文件中存在该配置名。（如果不存在可以加冒号，框架会赋值默认值，也可以在冒号后面自定义默认值。例如：test.domain:)。配置文件中不包含该配置，注解中也没加冒号，项目启动就会报错。

3、被static和finely修饰的属性配置该注解不会生效。

@Component
public class BaseConfig {
    @Value("${test.domain:}")
    private String domamin;
    @Value("${test.api:}")
    private String api;
}

2、通过@ConfigurationProperties注入

1、该类首先要被SpringBoot框架管理，属于SpringBoot框架的Bean。

2、@ConfigurationProperties进行指定配置文件中key的前缀。进行自动装配属性。适用于批量绑定，批量注入属性值。相比@value更省事。

 #application.yml配置文件
es:
  post:9200
  host:localhost
  name:es

@Data
@Component
@ConfigurationProperties(prefix="es")
public class ESProperties {
    private String host;
    private String name;
    private int port;
}

3、通过框架自带对象Environment实现属性动态注入

#application.yml配置文件
es:
  post:9200
  host:localhost
  name:es

方式一：容器自动注入SpringBoot框架自带的类Environment进行实现动态配置属性值注入。

import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
@Component
public class EsProperties {
    private String host;
    private String name;
    private int post;
    @Resource
    private Environment environment;
    public String getHost() {
        return environment.getProperty("es.host");
    }
    public String getName() {
        return environment.getProperty("es.name");
    }
    public int getPost() {
        String post = environment.getProperty("es.post");
        return Integer.parseInt(post);
    }
}

方式二：自己实现EnvironmentAware接口进行重写方法进行注入Environment。好处可以和spring boot框架的解耦性更低一点。

import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
@Component
public class EsProperties implements EnvironmentAware {
    private String host;
    private String name;
    private int post;
    private Environment environment;
    public String getHost() {
        return environment.getProperty("es.host");
    }
    public String getName() {
        return environment.getProperty("es.name");
    }
    public int getPost() {
        String post = environment.getProperty("es.post");
        return Integer.parseInt(post);
    }
    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }
}

4、通过@PropertySource注解实现外部配置文件注入属性值

#es.properties配置文件
es.post=9200
es.host=localhost
es.name=es

1、通过@PropertySource注解实现导入外部配置文件。

2、配合@value注解实现属性注入或者@ConfigurationProperties注解实现批量注入。

3、该方式只能获取 .properties 的配置文件不能获取 .yml 的配置文件。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
@Component
@PropertySource(value = "classpath:es.properties",encoding = "utf-8")
public class EsProperties {
    @Value("${es.host}")
    private String host;
    @Value("${es.name}")
    private String name;
    @Value("${es.post}")
    private int post;
}

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
@Component
@PropertySource(value = "classpath:es.properties",encoding = "utf-8")
@ConfigurationProperties(prefix = "es")
public class EsProperties {
    private String host;
    private String name;
    private int post;
}

5、yml 外部配置文件动态注入

第4中方式只能实现 .properties 文件的，该方式是实现 .yml 文件的。

1、自定义配置类，实例化PropertySourcesPlaceholderConfigurer类，使用该类进行属性值的注入。

2、实例化完PropertySourcesPlaceholderConfigurer类之后，就可以配合@value注解实现属性注入或者@ConfigurationProperties注解实现批量注入。

import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.core.io.ClassPathResource;
import java.util.Objects;
@Configuration
public class MyYmlConfig {
    @Bean
    public static PropertySourcesPlaceholderConfigurer yamlConfigurer(){
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
        yaml.setResources(new ClassPathResource("es.yml"));
        configurer.setProperties(Objects.requireNonNull(yaml.getObject()));
        return configurer;
    }
}

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class EsProperties {
    @Value("${es.host}")
    private String host;
    @Value("${es.name}")
    private String name;
    @Value("${es.post}")
    private int post;
}

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "es")
public class EsProperties {
    private String host;
    private String name;
    private int post;
}

6、Java原生态方式注入属性值

#es.properties配置文件
es.post=9200
es.host=localhost
es.name=es

import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.Properties;
@Component
public class EsProperties {
    private String host;
    private String name;
    private int post;
    @Bean
    public void init(){
        Properties props = new Properties();
        InputStreamReader inputStreamReader = new InputStreamReader(
                this.getClass().getClassLoader().getResourceAsStream("es.properties"), StandardCharsets.UTF_8);
        try {
            props.load(inputStreamReader);
        } catch (IOException e) {
            System.out.println(e.getMessage());
        }
        this.host = props.getProperty("es.host");
        this.name = props.getProperty("es.name");
        this.post = Integer.parseInt(props.getProperty("es.post"));
    }
}

以上就是SpringBoot项目加载配置文件的6种方式小结的详细内容，更多关于SpringBoot加载配置文件的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Hibernate实现many-to-many的映射关系
今天小编就为大家分享一篇关于Hibernate实现many-to-many的映射关系，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2019-03-03
SpringBoot异步调用方法并接收返回值
这篇文章主要为大家详细介绍了SpringBoot异步调用方法并接收返回值，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-09-09
springBoot项目中的static和templates文件夹的使用
本文主要介绍了springBoot项目中的static和templates文件夹的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2024-07-07
Springmvc restful配置遇到的小坑
本文是小编给大家带了的Springmvc restful配置遇到的小小坑，小编给大家带来了问题原因及解决办法，非常不错，具有参考借鉴价值，感兴趣的朋友一起看下吧
2016-07-07
zuul集成Sentinel,完成对path映射的限流操作
这篇文章主要介绍了zuul集成Sentinel,完成对path映射的限流操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
解决idea中maven项目打包成jar报错:没有主清单属性的问题
这篇文章主要给大家分享了idea中maven项目打包成jar,报错没有主清单属性解决方法,文中有详细的解决方法,如果又遇到同样问题的朋友可以参考一下本文
2023-09-09
JMX监控的具体使用
JMX最常见的场景是监控Java程序的基本信息和运行情况,本文主要介绍了JMX监控的具体使用,具有一定的参考价值,感兴趣的可以了解一下
2024-02-02
Java中的内部类使用详情
说起内部类这个词，想必很多人都不陌生，但是又会觉得不熟悉。原因是平时编写代码时可能用到的场景不多，用得最多的是在有事件监听的情况下，并且即使用到也很少去总结内部类的用法。今天我们就来一探究竟
2022-03-03
Maven工程pom中如何定义jdk版本
这篇文章主要介绍了Maven工程pom中如何定义jdk版本，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
java调用百度的接口获取起-止位置的距离
本文主要介绍了java调用百度的接口获取起-止位置的距离，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-04-04