SpringBoot日常：加载配置

爱被打了一巴掌 2024-02-17 08:55 8阅读 0赞

#### 文章目录 ####

*   *  前言
     *  一、Environment
     *  二、@Value 注解
     *  三、@ConfigurationProperties 注解
     *  四、@PropertySources 注解
     *  五、YamlPropertiesFactoryBean 加载 YAML 文件
     *  六、JAVA原生读取

### 前言 ###

我们日常开发免不了要获取配置文件数据，我们常常会犹豫用哪些方式，本章内容总结了六种常见的获取配置的方式

<table> 
 <thead> 
  <tr> 
   <th>方式</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Environment对象</td> 
   <td>Environment 是 springboot 核心的环境配置接口，它提供了简单的方法来访问应用程序属性，包括系统属性、操作系统环境变量、命令行参数、和应用程序配置文件中定义的属性等等,使用 Environment 方式来获取配置属性值非常简单，只要注入Environment类调用其方法getProperty(属性key)即可</td> 
  </tr> 
  <tr> 
   <td>@Value</td> 
   <td>@Value注解是Spring框架提供的用于注入配置属性值的注解，它可用于类的成员变量、方法参数和构造函数参数上， 在应用程序启动时，使用 @Value 注解的 Bean 会被实例化。所有使用了 @Value 注解的 Bean 会被加入到 PropertySourcesPlaceholderConfigurer 的后置处理器集合中。当后置处理器开始执行时，它会读取 Bean 中所有 @Value 注解所标注的值，并通过反射将解析后的属性值赋值给标有 @Value 注解的成员变量、方法参数和构造函数参数。</td> 
  </tr> 
  <tr> 
   <td>@ConfigurationProperties</td> 
   <td>SpringBoot 提供的一种更加便捷来处理配置文件中的属性值的方式，可以通过自动绑定和类型转换等机制，将指定前缀的属性集合自动绑定到一个Bean对象上。</td> 
  </tr> 
  <tr> 
   <td>@PropertySources</td> 
   <td>@PropertySources 注解的实现原理相对简单，应用程序启动时扫描所有被该注解标注的类，获取到注解中指定自定义配置文件的路径，将指定路径下的配置文件内容加载到 Environment 中，这样可以通过 @Value 注解或 Environment.getProperty() 方法来获取其中定义的属性值了。默认只限读取properties文件内容，想加载yaml文件内容，可以自定义factory适配器，指定factory具体的使用</td> 
  </tr> 
  <tr> 
   <td>YamlPropertiesFactoryBean对象</td> 
   <td>只限读取yaml文件，通过 @Value 注解或 Environment.getProperty() 方法来配合着获取其中定义的属性值。</td> 
  </tr> 
  <tr> 
   <td>JAVA原生</td> 
   <td>通过java.util.Properties去加载配置文件中的属性，</td> 
  </tr> 
 </tbody> 
</table>

### 一、Environment ###

注入Environment类调用其方法getProperty(属性key)即可。在 src/main/resources/ 目录下默认有个配置文件application.yml，内容如下

# application1.yml内容
    server:
      port: 8014
    myconfig:
      name: 张三
      age: 20

//接口层引用配置
    @RestController
    public class CenterController {
        
    
        @Resource
        private Environment env;
    
        @GetMapping(value = "/testProperty")
        public void testProperty() {
        
            String var1 = env.getProperty("myconfig.age");
            System.out.println("Environment获取的配置内容："+ var1);
        }
    }

![在这里插入图片描述][22a5070e8d6a40d9a78eae4a6e418682.png]

### 二、@Value 注解 ###

在 src/main/resources/ 目录下默认有个配置文件application.yml，内容如下

# application1.yml内容
    server:
      port: 8014
    myconfig:
      name: 张三
      age: 20

//接口层引用配置
    @RestController
    public class CenterController {
        
    
        @Value("${myconfig.name}")
        private String name;
    
        @GetMapping(value = "/testProperty1")
        public void testProperty1() {
        
            System.out.println("@value获取的配置内容："+ name);
        }
    }

![在这里插入图片描述][d1a624ec5a6145f585732a31edc7f03a.png]

### 三、@ConfigurationProperties 注解 ###

在 src/main/resources/ 目录下默认有个配置文件application.yml，内容如下

# application1.yml内容
    server:
      port: 8014
    myconfig:
      name: 张三
      age: 20

//配置文件
    @Data
    @Configuration
    @ConfigurationProperties(prefix = "myconfig")
    public class PropertyTest {
        
        private String name;
        private String age;
    }
    
    //接口层引用配置
    @RestController
    public class CenterController {
        
    
        @Resource
        private PropertyTest propertyTest;
    
        @GetMapping(value = "/testProperty2")
        public void testProperty2() {
        
            System.out.println("@ConfigurationProperties注解获取的配置内容："+JSON.toJSONString(propertyTest));
        }
    }

![在这里插入图片描述][8d25f32d33fc4d17bf204dffc12a4965.png]

### 四、@PropertySources 注解 ###

在 src/main/resources/ 目录下创建自定义配置文件application1.yml和application2.yml，具体内容如下所示

# application1.yml内容
    myconfig:
      name: 张三

# application2.yml内容
    myconfig:
      age: 20

//配置文件
    @Data
    @Configuration
    @PropertySources({
        
            @PropertySource(value = "classpath:application1.yml", encoding = "utf-8"),
            @PropertySource(value = "classpath:application2.yml",encoding = "utf-8")
    })
    public class PropertySourcesConf {
        
    
        @Value("${myconfig.name}")
        private String name;
    
        @Value("${myconfig.age}")
        private String age;
    }
    
    //接口层引用配置
    @RestController
    public class CenterController {
        
    
        @Resource
        private PropertyTest propertyTest;
    
        @GetMapping(value = "/testProperty3")
        public void testProperty3() {
        
            System.out.println("@PropertySources注解获取的配置内容："+JSON.toJSONString(propertySourcesConf.getName()));
            System.out.println("@PropertySources注解获取的配置内容："+JSON.toJSONString(propertySourcesConf.getAge()));
        }
    }

![在这里插入图片描述][9f7536f29544434197b29a86624cdf55.png]

### 五、YamlPropertiesFactoryBean 加载 YAML 文件 ###

在 src/main/resources/ 目录下创建自定义配置文件application3.yml，具体内容如下所示

myconfig:
      account: 13800138000

@Configuration
    public class MyYamlConfig {
        
    
        @Bean
        public static PropertySourcesPlaceholderConfigurer yamlConfigurer() {
        
            PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
            YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
            yaml.setResources(new ClassPathResource("application3.yml"));
            configurer.setProperties(Objects.requireNonNull(yaml.getObject()));
            return configurer;
        }
    }
    
    //接口层引用配置
    @RestController
    public class CenterController {
        
    
        @Value("${myconfig.account}")
        private String account;
    
        @GetMapping(value = "/testProperty4")
        public void testProperty4() {
        
            System.out.println("YamlPropertiesFactoryBean获取的配置内容："+ account);
        }
    }

![在这里插入图片描述][3e909b4a43f04afd8f8b956d40c9e564.png]

### 六、JAVA原生读取 ###

在 src/main/resources/ 目录下创建自定义配置文件application3.yml，具体内容如下所示

myconfig:
      account: 13800138000

//接口层引用配置
    @RestController
    public class CenterController {
        
    
        @GetMapping(value = "/testProperty5")
        public void testProperty5() {
        
            Properties props = new Properties();
            try {
        
                InputStreamReader inputStreamReader = new InputStreamReader(
                        this.getClass().getClassLoader().getResourceAsStream("application3.yml"),
                        StandardCharsets.UTF_8);
                props.load(inputStreamReader);
            } catch (IOException e1) {
        
                System.out.println(e1);
            }
            System.out.println("原生获取" + props.getProperty("account"));
        }
    }

![在这里插入图片描述][dbb3726c9ff045edad9953d0ee9187a5.png]

[22a5070e8d6a40d9a78eae4a6e418682.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/7bb69badbcd544c9977b321673f86f75.png
[d1a624ec5a6145f585732a31edc7f03a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/fe1a92a5931f458095647910a00f58b0.png
[8d25f32d33fc4d17bf204dffc12a4965.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/f4310f6c77d149aebad25d5bdfc82804.png
[9f7536f29544434197b29a86624cdf55.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/0bff1c66b01a4ae190e3696c9d2d37dc.png
[3e909b4a43f04afd8f8b956d40c9e564.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/57fbe8bc1647486f9e905c031a748d9f.png
[dbb3726c9ff045edad9953d0ee9187a5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/19e81a917846484abcb7266e0ed25b27.png