SpringBoot3读取配置文件application.properties属性值的几种方式
更新时间：2024年11月04日 09:26:42 作者：WiFiMing
这篇文章主要介绍了SpringBoot3读取配置文件application.properties属性值的几种方式,文中通过代码示例给大家讲解的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
在 Spring Boot 项目中，可以通过以下几种方式读取 application.properties 文件中的配置属性值：
1. 使用 @Value 注解读取单个属性值
@Value 注解可以直接用于注入 application.properties 文件中的属性值。
示例
假设在 application.properties 中定义了以下配置项：
app.name=MyApp app.version=1.0.0
可以在任意 @Component、@Service、@Controller 等注解标注的类中，通过 @Value 注解获取这些值：
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class AppConfig {
@Value("${app.name}")
private String appName;
@Value("${app.version}")
private String appVersion;
public void printConfig() {
System.out.println("App Name: " + appName);
System.out.println("App Version: " + appVersion);
}
}
注意：
${app.name}表示从配置文件中读取app.name属性值。
2. 使用 @ConfigurationProperties 注解读取配置前缀
@ConfigurationProperties 注解允许批量读取具有相同前缀的属性，并将其注入到一个 Java 类中。这种方式适用于管理大量的配置项。
示例
假设在 application.properties 中定义了一组 app 前缀的属性：
app.name=MyApp app.version=1.0.0 app.description=A sample application
可以创建一个配置类，并使用 @ConfigurationProperties 注解将 app 前缀的属性注入其中：
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "app")
public class AppConfigProperties {
private String name;
private String version;
private String description;
// Getter and Setter methods
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getVersion() {
return version;
}
public void setVersion(String version) {
this.version = version;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
}
在其他类中可以通过注入 AppConfigProperties 类来获取配置值：
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class AppService {
private final AppConfigProperties appConfigProperties;
@Autowired
public AppService(AppConfigProperties appConfigProperties) {
this.appConfigProperties = appConfigProperties;
}
public void printAppInfo() {
System.out.println("App Name: " + appConfigProperties.getName());
System.out.println("App Version: " + appConfigProperties.getVersion());
System.out.println("App Description: " + appConfigProperties.getDescription());
}
}
注意：
@ConfigurationProperties注解类必须是一个@Component，并且需要在application.properties中启用属性绑定支持，通常在 Spring Boot 中默认已启用。
3. 使用 Environment 读取属性
Environment 接口提供了动态获取属性值的方式，适合用于在运行时读取配置文件中的属性。
示例
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
@Component
public class EnvironmentConfig {
private final Environment environment;
@Autowired
public EnvironmentConfig(Environment environment) {
this.environment = environment;
}
public void printEnvConfig() {
String appName = environment.getProperty("app.name");
String appVersion = environment.getProperty("app.version");
System.out.println("App Name: " + appName);
System.out.println("App Version: " + appVersion);
}
}
注意：
Environment接口适合在需要动态获取配置或配置项不确定的场景中使用。
4. 使用 @PropertySource 加载自定义配置文件
除了 application.properties，也可以定义自定义配置文件，并使用 @PropertySource 注解加载其中的属性。
示例
- 创建自定义配置文件
custom-config.properties，内容如下：
custom.property1=value1 custom.property2=value2
- 使用
@PropertySource注解加载自定义配置文件：
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
@Configuration
@PropertySource("classpath:custom-config.properties")
public class CustomConfig {
@Value("${custom.property1}")
private String property1;
@Value("${custom.property2}")
private String property2;
public void printCustomConfig() {
System.out.println("Custom Property 1: " + property1);
System.out.println("Custom Property 2: " + property2);
}
}
注意：确保
custom-config.properties文件位于classpath下（如src/main/resources目录）。
总结
以上是 Spring Boot 中读取 application.properties 文件属性值的几种常见方式：
- @Value 注解：直接读取单个属性值。
- @ConfigurationProperties 注解：批量读取具有相同前缀的属性。
- Environment 接口：动态读取属性，适合运行时获取。
- @PropertySource 注解：加载自定义配置文件的属性值。
以上就是SpringBoot3读取配置文件application.properties属性值的几种方式的详细内容，更多关于SpringBoot3读取application.properties属性值的资料请关注脚本之家其它相关文章！
相关文章
Java中FileWriter的用法及wirte()重载方法详解
这篇文章主要介绍了Java中FileWriter的用法及wirte()重载方法详解,FileWriter是Java编程语言中的一个类,用于将字符写入文件,它提供了一种简单而方便的方式来创建、打开和写入文件,通过使用FileWriter,我们可以将字符数据写入文本文件,需要的朋友可以参考下2023-10-10
Spring Cloud Stream消息驱动组件使用方法介绍
Spring Cloud Stream 消息驱动组件帮助我们更快速，更方便，更友好的去构建消息驱动微服务的。当时定时任务和消息驱动的⼀个对比。消息驱动：基于消息机制做一些事情2022-09-09
canal是阿里开源mysql binlog 数据组件，canal-server 才是canal的核心我们前边所讲的canal的功能，实际上讲述的就是canal-server的功能，本文给大家介绍Springboot2.3.x整合Canal的示例代码,需要的朋友可以参考下2022-02-02
今天小编给大家分享Intellij IDEA 阅读源码的 4 个绝技，熟练的运用 IDEA 中各个小技巧，让阅读跟踪源码变得更轻松，本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧2020-04-04
这篇文章主要介绍了springboot向elk写日志实现过程,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-10-10
本篇文章通过实例对 java程序编译时与运行时进行了详解，需要的朋友可以参考下2017-04-04
浅谈java switch如果case后面没有break,会出现什么情况？
这篇文章主要介绍了浅谈java switch如果case后面没有break,会出现什么情况？具有很好的参考价值，希望对大家有所帮助。一起跟随想小编过来看看吧2020-09-09
SpringMVC 提供了强大的数据验证机制，可以方便地验证表单提交的数据，除了自带的验证器之外，SpringMVC 还支持自定义验证器，允许开发者根据业务需求自定义验证规则，本文将介绍如何在 SpringMVC 中使用自定义验证器2023-07-07
这篇文章主要介绍了Spring的@Conditional详解,给想要注入Bean增加限制条件,只有满足限制条件才会被构造并注入到Spring的IOC容器中,通常和@Bean注解一起使用,需要的朋友可以参考下2024-01-01
这篇文章主要介绍了Spring Cloud Eureka基础应用,Eureka Client中内置一个负载均衡器，用来进行基本的负载均衡，下面我们将通过搭建一个简单的Eureka例子来了解Eureka的运作原理，感兴趣的朋友一起看看吧2022-05-05
最新评论