SpringBoot加载配置6种方式分析

更新时间：2023年10月30日 11:46:34 作者：京东零售马宏伟

这篇文章主要介绍了SpringBoot加载配置6种方式分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

引言

从配置文件中获取属性应该是SpringBoot开发中最为常用的功能之一，但就是这么常用的功能，仍然有很多开发者抓狂～今天带大家简单回顾一下这六种的使用方式：

	说明
Environment对象	Environment 是 springboot 核心的环境配置接口，它提供了简单的方法来访问应用程序属性，包括系统属性、操作系统环境变量、命令行参数、和应用程序配置文件中定义的属性等等,使用 Environment 方式来获取配置属性值非常简单，只要注入Environment类调用其方法getProperty(属性key)即可
@Value	@Value注解是Spring框架提供的用于注入配置属性值的注解，它可用于类的成员变量、方法参数和构造函数参数上，在应用程序启动时，使用 @Value 注解的 Bean 会被实例化。所有使用了 @Value 注解的 Bean 会被加入到 PropertySourcesPlaceholderConfigurer 的后置处理器集合中。当后置处理器开始执行时，它会读取 Bean 中所有 @Value 注解所标注的值，并通过反射将解析后的属性值赋值给标有 @Value 注解的成员变量、方法参数和构造函数参数。重要！！！ ⚠️注意 ①在使用 @Value 注解时需要确保注入的属性值已经加载到 Spring 容器中，否则会导致注入失败； ②建议引用变量的时候给定一个默认值，避免启动报“缺失配置”的错误； ③通过依赖注入的方式获取对象中属性值，切记不要使用new的方式来创建对象获取其属性。
@ConfigurationProperties	SpringBoot 提供的一种更加便捷来处理配置文件中的属性值的方式，可以通过自动绑定和类型转换等机制，将指定前缀的属性集合自动绑定到一个Bean对象上。
@PropertySources	@PropertySources 注解的实现原理相对简单，应用程序启动时扫描所有被该注解标注的类，获取到注解中指定自定义配置文件的路径，将指定路径下的配置文件内容加载到 Environment 中，这样可以通过 @Value 注解或 Environment.getProperty() 方法来获取其中定义的属性值了。默认只限读取properties文件内容，想加载yaml文件内容，可以自定义factory适配器，指定factory具体的使用
YamlPropertiesFactoryBean对象	只限读取yaml文件，通过 @Value 注解或 Environment.getProperty() 方法来配合着获取其中定义的属性值。
JAVA原生	通过java.util.Properties去加载配置文件中的属性。

一、Environment

注入Environment类调用其方法getProperty(属性key)即可

@Slf4j
@SpringBootTest
public class EnvironmentTest {
    @Resource
    private Environment env;
    @Test
    public void var1Test() {
        String var1 = env.getProperty("env.var1");
        log.info("Environment获取的配置内容：{}", var1);
    }
}

二、@Value 注解

只要在变量上加注解 @Value("${env.var1}")就可以了，@Value 注解会自动将配置文件中的env.var1属性值注入到var1字段中。

@Slf4j
@SpringBootTest
public class EnvVariablesTest {
    @Value("${env.var1}")
    private String var1;
    @Test
    public void var1Test(){
        log.info("配置文件属性: {}",var1);
    }
}

三、@ConfigurationProperties 注解

在 application.yml 配置文件中添加配置项：

env:
  var1: 变量值1
  var2: 变量值2

创建一个 MyConf 类用于承载所有前缀为env的配置属性。

@Data
@Configuration
@ConfigurationProperties(prefix = "env")
public class MyConf {
    private String var1;
    private String var2;
}

在需要使用var1、var2属性值的地方，将 MyConf 对象注入到依赖对象中即可。

@Slf4j
@SpringBootTest
public class ConfTest {
    @Resource
    private MyConf myConf;
    @Test
    public void myConfTest() {
        log.info("@ConfigurationProperties注解获取的配置内容：{}", JSON.toJSONString(myConf));
    }
}

四、@PropertySources 注解

在 src/main/resources/ 目录下创建自定义配置文件 important.properties，增加两个属性。

env.var1=变量值1
env.var2=变量值2

在需要使用自定义配置文件的类上添加 @PropertySources 注解，注解 value属性中指定自定义配置文件的路径，可以指定多个路径，用逗号隔开。

@Data
@Configuration
@PropertySources({
        @PropertySource(value = "classpath:important.properties", encoding = "utf-8"),
        @PropertySource(value = "classpath:important.properties",encoding = "utf-8")
})
public class PropertySourcesConf {
    @Value("${env.var1}")
    private String var1;
    @Value("${env.var2}")
    private String var2;
}

五、YamlPropertiesFactoryBean 加载 YAML 文件

@Configuration
public class MyYamlConfig {
    @Bean
    public static PropertySourcesPlaceholderConfigurer yamlConfigurer() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
        yaml.setResources(new ClassPathResource("test.yml"));
        configurer.setProperties(Objects.requireNonNull(yaml.getObject()));
        return configurer;
    }
}

可以通过 @Value 注解或 Environment.getProperty() 方法来获取其中定义的属性值。

@Slf4j
@SpringBootTest
public class YamlTest {
    @Value("${env.var3}")
    private String var3;
    @Test
    public void  myYamlTest() {
        log.info("Yaml获取配置内容：{}", var3);
    }
}

六、JAVA原生读取

@Slf4j
@SpringBootTest
public class CustomTest {
    @Test
    public void customTest() {
        Properties props = new Properties();
        try {
            InputStreamReader inputStreamReader = new InputStreamReader(
                    this.getClass().getClassLoader().getResourceAsStream("test.properties"),
                    StandardCharsets.UTF_8);
            props.load(inputStreamReader);
        } catch (IOException e1) {
            System.out.println(e1);
        }
        log.info("Properties Name：" + props.getProperty("env.appName"));
    }
}

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

您可能感兴趣的文章:

Java中的StringBuilder()常见方法详解
StringBuilder是一个可变的字符序列，此类提供一个与 StringBuffer 兼容的 API，但不保证同步，这篇文章主要介绍了StringBuilder()常见方法,需要的朋友可以参考下
2023-09-09
SpringBoot项目网页加载出现Whitelabel Error Page的解决
这篇文章主要介绍了SpringBoot项目网页加载出现Whitelabel Error Page的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-11-11
Java数组的初始化方法详解
在Java程序开发中,数组是一个非常常用的数据类型,数组的初始化是使用数组来存储和处理数据的关键步骤之一,但是,关于Java数组的初始化,经常会让人感到迷惑,本文将详细介绍Java数组的初始化方法,帮助读者从此告别关于Java数组初始化的困惑
2023-11-11
一文详解Spring Security的基本用法
Spring Security是一个功能强大且高度可定制的身份验证和访问控制框架, 提供了完善的认证机制和方法级的授权功能。本文将通过一个简单的案例了解一下Spring Security的基本用法，需要的可以参考一下
2022-05-05
java中final与finally的使用介绍
本篇文章介绍了，在java中final与finally的使用。需要的朋友参考下
2013-04-04
MyBatis中PageHelper不生效的解决方案
这篇文章主要介绍了MyBatis中PageHelper不生效的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
SpringBoot项目创建单元测试的流程步骤
在日常开发的过程中,对自己的代码进行单元测试是个非常重要的过程,一方面可以最小范围的针对一个方法进行测试,提高测试的简便性以及测试的成本,本篇文章主要是为了总结一下如何优雅的在Springboot项目中使用单元测试去测试功能,需要的朋友可以参考下
2024-11-11
Java如何将大文件切割成小文件
这篇文章主要为大家详细介绍了Java如何将大文件切割成小文件，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-05-05
Spring实战之FileSystemResource加载资源文件示例
这篇文章主要介绍了Spring实战之FileSystemResource加载资源文件,结合实例形式分析了spring FileSystemResource加载xml资源文件的具体实现步骤与相关操作技巧,需要的朋友可以参考下
2019-12-12
Java 集合框架掌握 Map 和 Set 的使用(内含哈希表源码解读及面试常考题)
这篇文章主要介绍了Java 集合框架掌握 Map 和 Set 的使用并含有内含哈希表源码解读及面试常考题， Map 和 Set 是一种适合动态查找的集合容器或者数据结构下面文章详细介绍，具有一定的参考价值，需要的小伙伴可以参考一下
2021-12-12