AI 助理
备案控制台
开发者社区 物联网 文章 正文

SpringBoot读取配置文件的6种方式，包括：通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息

2024-11-05 98
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： SpringBoot读取配置文件的6种方式，包括：通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息

image.png

@[toc]

概述：本文从读取默认配置文件即自定义配置文件入手，去整理了解几种加载方案的区别

SpringBoot读取配置文件的几种方式

  1. 测试方式1：通过Environment读取配置信息
  2. 测试方式2：通过@Value注解读取配置信息（推荐使用）
  3. 测试方式3：通过@ConfigurationProperties注解读取配置信息
  4. 测试方式4：通过@PropertySource+@Value注解读取配置信息
  5. 测试方式5：通过@PropertySource+@ConfigurationProperties注解读取配置信息
  6. 测试方式6：通过Properties读取配置信息

总结

结论：无论什么场景都推荐使用@Value注解准备错；其他了解即可。

准备工作

配置文件目录
image.png

application.properties

server.port=8080
spring.profiles.active=dev

application-dev.properties

spring.redis.host=localhost
logging.level.root = info

application-prod.properties

spring.redis.port=6379
logging.level.root = warn

my.properties

demo.name=cat

案例说明

1)测试方式1：通过Environment读取配置信息

注意点说明：

注意点1：
Environment是用来读取应用程序运行时的环境变量的类，可以通过key-value的方式读取application.properties和系统环境变量，命令行输入参数，系统属性等.

> Controller

java import com.example.demo.config.ReadProperties; import com.example.demo.config.ReadProperties2; import com.example.demo.config.ReadProperties3; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.core.env.Environment; import org.springframework.core.io.ClassPathResource; import org.springframework.core.io.Resource; import org.springframework.core.io.support.PropertiesLoaderUtils; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; import java.io.IOException; import java.util.HashMap; import java.util.Map; import java.util.Properties; /** * 测试读取配置文件的几种方式： * @Author 211145187 * @Date 2022/7/20 14:02 **/ @RestController public class ReadApplicationProperties { @Autowired private Environment environment; //测试方式1：通过Environment读取配置信息 @GetMapping("/readApplicationProperties1") public Map<String,Object> readApplicationProperties1(){ Map<String,Object> map = new HashMap<>(); map.put("port",environment.getProperty("server.port")); System.out.println("通过Environment读取配置信息:" + environment.getProperty("server.port")); return map; } }

> 结果打印：

image.png

## 2)测试方式2：通过@Value注解读取配置信息（推荐使用）

> Controller

java import com.example.demo.config.ReadProperties; import com.example.demo.config.ReadProperties2; import com.example.demo.config.ReadProperties3; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.core.env.Environment; import org.springframework.core.io.ClassPathResource; import org.springframework.core.io.Resource; import org.springframework.core.io.support.PropertiesLoaderUtils; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; import java.io.IOException; import java.util.HashMap; import java.util.Map; import java.util.Properties; /** * 测试读取配置文件的几种方式： * @Author 211145187 * @Date 2022/7/20 14:02 **/ @RestController public class ReadApplicationProperties { @Value("${server.port}") private Integer serverPort; //测试方式2：通过@Value注解读取配置信息 @GetMapping("/readApplicationProperties2") public void readApplicationProperties2(){ System.out.println("通过@Value注解读取配置信息:" + serverPort); } }

> 结果打印

image.png


## 3)测试方式3：通过@ConfigurationProperties注解读取配置信息
### 注意点说明：
注意点1：
@ConfigurationProperties注解用于指定前缀，下方的属性名称必须和要获取的配置信息名称一致，比如必须叫port，否则获取值为null
使用@ConfigurationProperties首先建立配置文件与对象的映射关系，然后在控制器方法中使用@Autowired注解将对象注入.

注意点2：
配置生效的两种方式：
方式1：配置@Component
方式2：启动类添加@EnableConfigurationProperties(ReadProperties.class)

总结：注解@Component和注解@EnableConfigurationProperties(ReadProperties.class)是等价的，写一个就行。 注意点3：
@ConfigurationProperties也可以和@Value和@Bean一起使用，只不过我没写案例。

注意点4：
@ConfigurationProperties只能加载以application为前缀开头的配置文件，比如application-dev.properties，加载自定义名称配置文件内容无效。

注意点5：

问题：从上面的示例中，我们可以看到在属性绑定中@EnableConfigurationProperties和@Component的效果一样，那么为啥springboot还要使用这个注解呢？

答案：当我们引用第三方jar包时，@Component标注的类是无法注入到spring容器中的，这时我们可以用@EnableConfigurationProperties来代替@Component

> ReadProperties

java import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; /** * 1）注解@ConfigurationProperties中的prefix用于设置前缀 * 2）下方的属性名称必须和要获取的配置信息名称一致，比如必须叫port，否则获取值为null */ @ConfigurationProperties(prefix = "server")//这个注解是用找到类 @Component //生效的两种方式：方式1：配置@Component，方式2：启动类添加@EnableConfigurationProperties(ReadProperties.class) @Data public class ReadProperties { private Integer port; }

> Controller

java import com.example.demo.config.ReadProperties; import com.example.demo.config.ReadProperties2; import com.example.demo.config.ReadProperties3; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.core.env.Environment; import org.springframework.core.io.ClassPathResource; import org.springframework.core.io.Resource; import org.springframework.core.io.support.PropertiesLoaderUtils; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; import java.io.IOException; import java.util.HashMap; import java.util.Map; import java.util.Properties; /** * 测试读取配置文件的几种方式： * @Author 211145187 * @Date 2022/7/20 14:02 **/ @RestController public class ReadApplicationProperties { @Autowired private ReadProperties readProperties; //测试方式3：通过@ConfigurationProperties注解读取配置信息 @GetMapping("/readApplicationProperties3") public void readApplicationProperties3(){ System.out.println("通过@ConfigurationProperties注解读取配置信息:" + readProperties.getPort()); } }

> 结果打印

image.png


## 4)测试方式4：通过@PropertySource+@Value注解读取配置信息
### 注意点说明：
注意点1：
@PropertySource注解加载指定的属性文件（*.properties）到 Spring 的 Environment 中。可以配合 @Value 和@ConfigurationProperties 和@Bean使用。

注意点2：
@PropertySource注解可以配合 @Value 和@ConfigurationProperties 和@Bean一起使用，只不过我没写案例。

注意点3：
使用@PropertySource注解推荐只加载自定义名称的配置文件，不要加载以application为前缀开头的配置文件，比如application-dev.properties，因为重名的key值会被覆盖，这点会在注意点4中着重说明。

注意点4：（最容易出错）

讲解一个大坑

补充说明：application-dev.properties中设置logging.level.root = info，而application-prod.properties中设置logging.level.root = warn

案例说明：application.properties配置文件设置内置spring.profiles.active=dev，用于关联application-dev.properties配置文件，正常代码运行会把application.properties和application-dev.properties配置文件都加载到内存中，但是现在我想创建一个config或者bean，通过@PropertySource注解去注入并打印application-prod.properties中的这个内容：logging.level.root = warn，正确打印logging.level.root的结果应该是warn，因为它是最后加载的，但实际打印结果logging.level.root的值是info，

问题：为什么？为什么打印info，而我想打印的是prod中的值warn

答案：如图1，你看红色框中你感觉prod在info下载加载，你会觉得prod相同的key会覆盖dev中的值，实际答案真不是这样，详情请看如图2这个人的回答。正常来说生产项目中application-dev.properties和application-prod.properties只会允许使用一个，才不会混用。

实际真实项目解决方案是：

  • 第1种方案：启动类中配置环境变量也会通过指定dev还是prod生效，所以该案例只是自己的一个想法，实际没太大作用且实际项目也不会允许同时加载dev和prod配置文件。
  • 第2种方案：为了避免重名key被覆盖，我们会让application.properties和application-dev.properties不会存放相同的key内容，即application.properties有一个key，那么application-dev.properties和application-prod.properties中绝不会有这个相同的key内容。
  • 第3种方案：如果非要使用@PropertySource注解注入一个配置文件，那么一定指向自定义名称配置文件，千万不要指向以application-为前缀的配置文件。
    image.png
如图1

image.png

如图2

注意点5：
配置文件加载的优先级 > @PropertySource注解注入

ReadProperties2

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

/**
 * @Author 211145187
 * @Date 2022/7/20 15:47
 **/
@PropertySource(value = {
   "application.properties"})
@Component
@Data
public class ReadProperties2 {
   
    @Value("${server.port}")
    private Integer port;
}

ReadProperties4

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

/**
 * @Author 211145187
 * @Date 2022/7/20 15:51
 **/
@ConfigurationProperties(prefix = "spring.redis")//这个注解是用找到类    注意：@ConfigurationProperties无法加载自定义配置问价内容，必须和@PropertySource配合使用才能获取
@Component  //生效的两种方式：方式1：配置@Component，方式2：启动类添加@EnableConfigurationProperties(ReadProperties.class)
@PropertySource(value = {
   "classpath:application-prod.properties"})
@Data
public class ReadProperties4 {
   
    private String port;
}

Controller

import com.example.demo.config.ReadProperties;
import com.example.demo.config.ReadProperties2;
import com.example.demo.config.ReadProperties3;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PropertiesLoaderUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

/**
 * 测试读取配置文件的几种方式：
 * @Author 211145187
 * @Date 2022/7/20 14:02
 **/
@RestController
public class ReadApplicationProperties {
   
    @Autowired
    private ReadProperties2 readProperties2;

    //测试方式4：通过@PropertySource+@Value注解读取配置信息
    @GetMapping("/readApplicationProperties4")
    public void readApplicationProperties4(){
   
        System.out.println("通过@PropertySource注解读取配置信息:" + readProperties2.getPort());
    }
}

结果打印

image.png

5)测试方式5：通过@PropertySource+@ConfigurationProperties注解读取配置信息

ReadProperties3

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

/**
 * @Author 211145187
 * @Date 2022/7/20 15:51
 **/
@ConfigurationProperties(prefix = "demo")//这个注解是用找到类    注意：@ConfigurationProperties无法加载自定义配置问价内容，必须和@PropertySource配合使用才能获取
@Component  //生效的两种方式：方式1：配置@Component，方式2：启动类添加@EnableConfigurationProperties(ReadProperties.class)
@PropertySource(value = {
   "classpath:my.properties"})
@Data
public class ReadProperties3 {
   
    private String name;
}

Controller

import com.example.demo.config.ReadProperties;
import com.example.demo.config.ReadProperties2;
import com.example.demo.config.ReadProperties3;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PropertiesLoaderUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

/**
 * 测试读取配置文件的几种方式：
 * @Author 211145187
 * @Date 2022/7/20 14:02
 **/
@RestController
public class ReadApplicationProperties {
   
    @Autowired
    private ReadProperties3 readProperties3;

    //测试方式5：通过@PropertySource+@ConfigurationProperties注解读取配置信息
    @GetMapping("/readApplicationProperties5")
    public void readApplicationProperties5(){
   
        System.out.println("通过@PropertySource+@ConfigurationProperties注解读取配置信息:" + readProperties3);
    }
}

结果打印

image.png

6)测试方式6：通过Properties读取配置信息

Controller

import com.example.demo.config.ReadProperties;
import com.example.demo.config.ReadProperties2;
import com.example.demo.config.ReadProperties3;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PropertiesLoaderUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

/**
 * 测试读取配置文件的几种方式：
 * @Author 211145187
 * @Date 2022/7/20 14:02
 **/
@RestController
public class ReadApplicationProperties {
   
    //测试方式6：通过Properties读取配置信息
    @GetMapping("/readApplicationProperties6")
    public void readApplicationProperties6() throws IOException {
   
        Resource resource = new ClassPathResource("application-prod.properties");
        Properties properties = PropertiesLoaderUtils.loadProperties(resource);
        String root = properties.getProperty("logging.level.root");
        System.out.println("通过xProperties读取配置信息:" + root);
    }
}

结果打印

image.png

文章标签：
Java
Spring
容器
关键词：
Spring Boot配置文件配置
Spring Boot配置文件@value
Spring Boot@value
Spring Boot@configurationproperties配置
Spring Boot environment配置
刘大猫.
目录
相关文章
喜欢猪猪
|
1月前
|
Java 开发者 微服务
手写模拟Spring Boot自动配置功能
【11月更文挑战第19天】随着微服务架构的兴起，Spring Boot作为一种快速开发框架，因其简化了Spring应用的初始搭建和开发过程，受到了广大开发者的青睐。自动配置作为Spring Boot的核心特性之一，大大减少了手动配置的工作量，提高了开发效率。
喜欢猪猪
50 0
智物科技库
|
4天前
|
NoSQL Java Redis
Spring Boot 自动配置机制：从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解，根据类路径中的依赖和条件注解自动配置所需的 Bean，大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例，帮助开发者更好地理解和利用这一强大特性。
智物科技库
41 14
聚优云惠
|
26天前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
聚优云惠
42 1
SpringBoot入门(7)- 配置热部署devtools工具
聚优云惠
|
1月前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
聚优云惠
43 2
SpringBoot入门(7)- 配置热部署devtools工具
蓝易云
|
28天前
|
存储 前端开发 JavaScript
springboot中路径默认配置与重定向/转发所存在的域对象
Spring Boot 提供了简便的路径默认配置和强大的重定向/转发机制，通过合理使用这些功能，可以实现灵活的请求处理和数据传递。理解并掌握不同域对象的生命周期和使用场景，是构建高效、健壮 Web 应用的关键。通过上述详细介绍和示例，相信读者能够更好地应用这些知识，优化自己的 Spring Boot 应用。
蓝易云
30 3
刘大猫.
|
1月前
|
Java 数据库连接
SpringBoot配置多数据源实战
第四届光学与机器视觉国际学术会议(ICOMV 2025) 2025 4th International Conference on Optics and Machine Vision
刘大猫.
59 8
蓝易云
|
1月前
|
Java 数据库连接 数据库
springboot启动配置文件-bootstrap.yml常用基本配置
以上是一些常用的基本配置项，在实际应用中可能会根据需求有所变化。通过合理配置 `bootstrap.yml`文件，可以确保应用程序在启动阶段加载正确的配置，并顺利启动运行。
蓝易云
120 2
一壶明月
|
SQL 关系型数据库 MySQL
SpringBoot自定义配置注入的方式：自定义配置文件注入，从mysql读取配置进行注入
SpringBoot自定义配置注入的方式：自定义配置文件注入，从mysql读取配置进行注入
一壶明月
316 0
yuanzhengme
|
7月前
|
Java 数据库连接 Maven
SpringBoot【付诸实践 01】SpringBoot自定义starter保姆级教程（说明+源码+配置+测试）
SpringBoot【付诸实践 01】SpringBoot自定义starter保姆级教程（说明+源码+配置+测试）
yuanzhengme
76 1
极客李华
|
7月前
|
Java 数据库连接 Spring
面试题：springboot的自定义配置有哪些
面试题：springboot的自定义配置有哪些
极客李华
51 0

物联网

热门文章

最新文章

  • 1
    阿里云联合思普瑞上线平安社区服务平台 提供物联网一站式管理
  • 2
    PostgreSQL "物联网"应用 - 1 实时流式数据处理案例(万亿每天)
  • 3
    吃『派』那些事儿——阿里云物联网平台树莓派实战集锦
  • 4
    塑云科技：性能突破，基于KafKa+OTS+MaxCompute 完成了一次物联网系统技术重构
  • 5
    庆科：从安全设计上突破，云上物联网操作系统进化之路
  • 6
    AliOS Things开发：让你的开发板支持AliOS Studio烧录
  • 7
    uDevice Center - IoT在线开发板/设备平台
  • 8
    一个简单算法可以帮助物联网,金融 用户 节约98%的数据存储成本 (PostgreSQL,Greenplum帮你做到)
  • 9
    高性能时序数据库 HiTSDB 启动公测，为物联网而生的数据库！
  • 10
    旋转门数据压缩算法在PostgreSQL中的实现 - 流式压缩在物联网、监控、传感器等场景的应用
  • 1
    「Mac畅玩鸿蒙与硬件46」UI互动应用篇23 - 自定义天气预报组件
    59
  • 2
    docker基础篇：安装tomcat
    91
  • 3
    「Mac畅玩鸿蒙与硬件45」UI互动应用篇22 - 评分统计工具
    103
  • 4
    「Mac畅玩鸿蒙与硬件44」UI互动应用篇21 - 随机励志语录生成器
    57
  • 5
    docker高级篇（大厂进阶）：安装mysql主从复制
    47
  • 6
    三分钟轻松搞定固定资产盘点--首码RFID资产盘点小助手
    26
  • 7
    docker高级篇（大厂进阶）：安装redis集群
    51
  • 8
    《docker高级篇（大厂进阶）：4.Docker网络》包括：是什么、常用基本命令、能干嘛、网络模式、docker平台架构图解
    91
  • 9
    本地部署MES生产管理系统，贝锐花生壳快速实现安全远程访问
    54
  • 10
    《docker高级篇（大厂进阶）：5.Docker-compose容器编排》包括是什么能干嘛去哪下、Compose核心概念、Compose使用三个步骤、Compose常用命令、Compose编排微服务
    61

    • 相关课程

    更多
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Springboot项目云开发快速迁移

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册

    • 相关实验场景

    更多
  • YML配置文件的常用属性
  • 从零搭建Spring Boot的Hello World
    • 下一篇
    DataWorks