SpringBoot3读取配置文件application.properties属性值的几种方式

更新时间：2024年11月04日 09:26:42 作者：WiFiMing

这篇文章主要介绍了SpringBoot3读取配置文件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属性值的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

SpringBoot2自动装配原理解析
这篇文章主要介绍了SpringBoot2自动装配原理解析，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2022-03-03
Java简单冒泡排序示例解析
这篇文章主要介绍了Java简单冒泡排序示例解析，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-08-08
MyBatis Dynamic SQL 入门指南
本文主要介绍了MyBatis Dynamic SQL 入门指南,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2026-02-02
切换多个Java版本的解决方案
文章主要介绍了在实际开发中需要切换Java版本的原因,以及三种常见的Java版本管理工具：jenv、SDKMAN!和自定义脚本,每种工具都有其特点和适用场景,帮助开发者在不同Java版本之间进行快速切换和管理,需要的朋友可以参考下
2025-12-12
详解ZXing-core生成二维码的方法并解析
本文给大家介绍ZXing-core生成二维码的方法并解析，主要用到goggle发布的jar来实现二维码功能，对此文感兴趣的朋友一起学习吧
2016-05-05
Java流程控制之循环结构for,增强for循环
这篇文章主要介绍了Java流程控制之循环结构for,增强for循环，for循环是编程语言中一种循环语句，而循环语句由循环体及循环的判定条件两部分组成，其表达式为：for（单次表达式;条件表达式;末尾循环体）{中间循环体；}，下面我们俩看看文章内容的详细介绍
2021-12-12
Java读取txt文件中的数据赋给String变量方法
今天小编就为大家分享一篇Java读取txt文件中的数据赋给String变量方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2018-07-07
Java实现MD5消息摘要算法
本篇文章主要介绍了Java实现MD5消息摘要算法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-04-04
Java实现窗体程序显示日历表
这篇文章主要为大家详细介绍了Java实现窗体程序显示日历表，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-06-06
Feign利用自定义注解实现路径转义详解
这篇文章主要讲解一下如何通过注解实现对路由中的路径进行自定义编码，文中的示例代码讲解详细，对我们学习或工作有一定的帮助，需要的可以参考一下
2022-06-06