SpringBoot项目如何读取yaml配置文件（&番外如何让SPring调用一个类）

已于 2025-01-26 17:27:18 修改
阅读量859 收藏 16
点赞数 23
CC 4.0 BY-SA版权
文章标签： spring boot java 后端
于 2025-01-25 22:30:49 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2301_81071302/article/details/145359853

在Spring Boot项目中，application.yml 或 application.properties 文件中的配置参数可以通过以下几种方式在代码中使用：

前提导入SpringBoot的依赖！！！

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.3.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <!-- Spring Boot起步依赖，用于创建RESTful控制器 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

1. 使用 @Value 注解

@Value 注解可以直接将配置文件中的值注入到字段中。

# application.yml
app:
  name: MyApp
  version: 1.0.0
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
​
@Component
public class MyAppConfig {
​
    @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);
    }
}

2. 使用 @ConfigurationProperties 注解

@ConfigurationProperties 注解可以将配置文件中的一组属性绑定到一个Java对象中。

# application.yml
app:
  name: MyApp
  version: 1.0.0
  description: This is a Spring Boot application
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
​
@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
​
    private String name;
    private String version;
    private String description;
​
    // Getters and Setters
​
    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;
    }
​
    public void printConfig() {
        System.out.println("App Name: " + name);
        System.out.println("App Version: " + version);
        System.out.println("App Description: " + description);
    }
}

3. 使用 Environment 对象

Environment 对象可以用来获取配置文件中的属性值。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
​
@Component
public class MyAppConfig {
​
    @Autowired
    private Environment env;
​
    public void printConfig() {
        String appName = env.getProperty("app.name");
        String appVersion = env.getProperty("app.version");
​
        System.out.println("App Name: " + appName);
        System.out.println("App Version: " + appVersion);
    }
}

4. 使用 @PropertySource 注解

如果有自定义的配置文件，可以使用 @PropertySource 注解来加载该文件，并使用 @Value 或 Environment 来获取属性值。

# custom.yml
custom:
  property: Custom Value
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
​
@Component
@PropertySource("classpath:custom.yml")
public class CustomConfig {
​
    @Value("${custom.property}")
    private String customProperty;
​
    public void printConfig() {
        System.out.println("Custom Property: " + customProperty);
    }
}

5. 使用 @ConfigurationProperties 和 @EnableConfigurationProperties 结合

将配置属性绑定到一个独立的类中，可以使用 @ConfigurationProperties 和@EnableConfigurationProperties 结合的方式。

# application.yml
app:
  name: MyApp
  version: 1.0.0
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
​
@Configuration
@ConfigurationProperties(prefix = "app")
public class AppConfig {
​
    private String name;
    private String version;
​
    // Getters and Setters
​
    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;
    }
}
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;
​
@Configuration
@EnableConfigurationProperties(AppConfig.class)
public class MyAppConfig {
​
    private final AppConfig appConfig;
​
    public MyAppConfig(AppConfig appConfig) {
        this.appConfig = appConfig;
    }
​
    public void printConfig() {
        System.out.println("App Name: " + appConfig.getName());
        System.out.println("App Version: " + appConfig.getVersion());
    }
}

总结

  • @Value 适用于单个属性的注入。

  • @ConfigurationProperties 适用于将一组属性绑定到一个对象中。

  • Environment 适用于动态获取属性值。

  • @PropertySource 适用于加载自定义配置文件。

  • @ConfigurationProperties 和 @EnableConfigurationProperties 结合适用于将配置属性绑定到独立的类中。

番外：

        如果你有一个进行SpringBoot的启动类，你现在需要调用另外一个类里面的方法，那么该怎么让Spring去调用这个类呢？

情景再现：在 Spring Boot 项目中，如果你有两个类：ApplicationRun（Spring Boot 启动类）和 MyAppConfig（配置类），并且你想在项目启动时运行 MyAppConfig 中的 printAppInfo 方法，怎么做？？

方法 1：在 MyAppConfig 中使用 @PostConstruct 注解

@PostConstruct 注解可以标记一个方法，在 Spring 容器初始化 Bean 后自动执行。

代码示例
import org.springframework.context.annotation.Configuration;
import javax.annotation.PostConstruct;
​
@Configuration
public class MyAppConfig {
​
    public void printAppInfo() {
        System.out.println("应用信息：MyAppConfig");
    }
​
    @PostConstruct
    public void init() {
        printAppInfo(); // 在 Bean 初始化后自动调用
    }
}
说明

  • @Configuration 注解表示这是一个配置类，Spring 会将其加载为 Bean。

  • @PostConstruct 注解标记的方法会在 Bean 初始化后自动执行。

方法 2：在 ApplicationRun 中手动调用 printAppInfo 方法

在 Spring Boot 启动类中，可以通过 ApplicationContext 获取 MyAppConfig 的实例，然后调用其方法。

代码示例
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
​
@SpringBootApplication
public class ApplicationRun {
​
    public static void main(String[] args) {
        ApplicationContext context = SpringApplication.run(ApplicationRun.class, args);
​
        // 获取 MyAppConfig 的实例
        MyAppConfig myAppConfig = context.getBean(MyAppConfig.class);
​
        // 调用 printAppInfo 方法
        myAppConfig.printAppInfo();
    }
}
说明

  • ApplicationContext 是 Spring 的上下文对象，可以通过它获取容器中的 Bean。

  • context.getBean(MyAppConfig.class) 获取 MyAppConfig 的实例。

方法 3：实现 CommandLineRunner 或 ApplicationRunner 接口

CommandLineRunner 或 ApplicationRunner 是 Spring Boot 提供的接口，可以在应用启动后执行一些逻辑。

代码示例
import org.springframework.boot.CommandLineRunner;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
​
@Configuration
public class MyAppConfig implements CommandLineRunner {
​
    public void printAppInfo() {
        System.out.println("应用信息：MyAppConfig");
    }
​
    @Override
    public void run(String... args) throws Exception {
        printAppInfo(); // 在应用启动后执行
    }
}
说明

  • CommandLineRunner 接口的 run 方法会在 Spring Boot 应用启动后执行。

  • 可以将 MyAppConfig 实现 CommandLineRunner 接口，并在 run 方法中调用 printAppInfo。

方法 4：使用 @EventListener 监听应用启动事件

通过监听 Spring Boot 的 ApplicationReadyEvent 事件，在应用启动完成后执行逻辑。

代码示例
import org.springframework.context.event.EventListener;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.annotation.Configuration;
​
@Configuration
public class MyAppConfig {
​
    public void printAppInfo() {
        System.out.println("应用信息：MyAppConfig");
    }
​
    @EventListener(ApplicationReadyEvent.class)
    public void onApplicationReady() {
        printAppInfo(); // 在应用启动完成后执行
    }
}
说明

  • @EventListener 注解用于监听 Spring 的事件。

  • ApplicationReadyEvent 是 Spring Boot 应用启动完成后触发的事件。

方法 5：在 MyAppConfig 中注入 ApplicationRunner 或 CommandLineRunner Bean

如果不想直接实现 CommandLineRunner 接口，可以在 MyAppConfig 中定义一个 CommandLineRunner 或 ApplicationRunner 的 Bean。

代码示例
import org.springframework.boot.CommandLineRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
​
@Configuration
public class MyAppConfig {
​
    public void printAppInfo() {
        System.out.println("应用信息：MyAppConfig");
    }
​
    @Bean
    public CommandLineRunner commandLineRunner() {
        return args -> {
            printAppInfo(); // 在应用启动后执行
        };
    }
}
说明

  • 通过 @Bean 注解定义一个 CommandLineRunner 的 Bean。

  • Spring Boot 会自动执行这个 Bean 的逻辑。

总结

方法适用场景
@PostConstruct适合在 Bean 初始化后立即执行的逻辑。
手动调用 printAppInfo适合需要在启动类中显式调用某些方法的场景。
CommandLineRunner适合在应用启动后执行一些初始化逻辑。
@EventListener适合监听应用启动事件，执行一些启动后的逻辑。
定义 CommandLineRunner Bean适合将启动逻辑封装在配置类中，而不是直接实现接口。

根据你的需求选择合适的方式即可！如果只是简单的打印信息，推荐使用 @PostConstruct 或 CommandLineRunner。

【Arthas 专题篇. 番外篇 一 tunnel-server以及产品化】Arthas tunnel web管控微服务项目
qq_34033770的博客
10-26 1006
tunnel-server与agent的应用
一步一步教你：用 Docker Compose 完成 Seata 的整合部署
禅与计算机程序设计的艺术
03-22 2275
相关的功能维护的配置，以本文的AT模式为例，为保证每个分支事务在回滚时都能准确还原，seata参照MySQL的mvcc设计思想提出undo.log的概念，如果需要实现AT模式，我们需要针对每一个分支事务的数据库刷入下面这张。它能够让我们通过一个简单的配置文件，便捷地定义和运行多个相互关联的 Docker 容器，极大地提升了开发和部署的效率，简化了环境管理的复杂度。因为近期收到很多读者的私信，所以也专门创建了一个交流群，感兴趣的读者可以通过上方的公众号获取笔者的联系方式完成好友添加，点击备注。
springboot 项目获取 yaml/yml (或 properties）配置文件信息
m0_58680865的博客
09-12 4518
在分布式项目开发中，通常会使用配置中心（例如：Apollo 配置中心）将配置文件和项目解耦。为了更具灵活性，有时候需要把一些数据放在配置文件中获取，能够减少很多麻烦，这个时候就需要读取配置文件信息。本文结合实际开发介绍几种使用过的读取配置文件的方法。
Springboot中使用配置类和配置组件
qq_46046423的博客
05-18 1152
一、使用@Configuration注解来编写配置类 上述就是使用@Configuration注解来告诉Springboot，这是一个配置类（配置类也是组件）。 @Configuration有两种模式    Full模式（@Configuration(proxyBeanMethods = true)）：保证每个@Bean方法被调用多少次返回的组件都是单实例的.     Lite模式（@Configuration(proxyBeanMethods = false)）： 每个@Bean方法被调用多少次返回的组
SpringBoot学习(三)：springboot的yaml语法及读取yaml文件的内容
越努力越有钱的博客
12-09 1万+
一：properties和yml语法 如果使用IDEA创建Springboot项目,默认会在resource目录下创建application.properties文件,在SpringBoot项目中,也可以使用yml类型的配置文件代替properties文件，其实说白了这两个都是SpringBoot留下的配置文件，都可以进行配置。 首先我们最关注的应该是格式问题，两个文件在进行配置的时候的格式是...
SpringBoot yaml配置文件
最新发布
m0_62909831的博客
12-26 2570
SpringBoot项目YAML语法、配置文件值的注入、多配置文件加载顺序
SpringBoot-yml配置文件的使用与优势
TaloyerG的博客
08-24 1861
本文介绍了yml配置文件的语法、特点和使用方法，并与properties配置文件进行了对比，分析了yml配置文件的优势和局限性。我们可以看出，yml配置文件是一种更简洁、更灵活、更方便的配置文件格式，它可以让我们更容易地管理和切换不同环境或模块的配置。当然，yml配置文件也有一些需要注意的地方，如缩进、空格、数据类型等，我们需要遵循yml的语法规则，否则可能会导致配置文件无效或出现错误。
Spring Boot中的yaml配置简介
2401_84049088的博客
04-09 1143
在清楚了各个大厂的面试重点之后，就能很好的提高你刷题以及面试准备的效率，接下来小编也为大家准备了最新的互联网大厂资料。《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
SpringBoot入门——yml配置文件使用详解
wk_cjs的博客
11-24 6910
学会yml配置文件的编写和读取
spring-boot 读取yml配置信息
Good_Good_Study
05-21 411
public static String getYmlNew(String key){ Resource resource = new ClassPathResource(“application-dev.yml”); Properties properties = null; try { YamlPropertiesFactoryBean yamlFactory = new YamlPropertiesFactoryBean(); yamlFactory.setResources(resource); p
SpringBoot的配置类
weixin_46134317的博客
10-16 3623
配置类用于向容器中注入组件，几乎每个配置类都绑定着一个或多个配置属性类，而配置属性类绑定着一个配置文件。 一、配置类注入Bean的方式 1.@Bean @Configuration public class DogConfiguration { @Bean public Dog dog() { Dog dog = new Dog(); dog.setName("小黑"); dog.setType("柯基"); return do
Springboot使用Maven Profile和Spring Profile进行多环境配置
emilywisy的博客
05-13 1028
目的 在实际的项目上，一般会分三种环境dev、test、prod来方便我们的开发和部署，要求我们在开发的时候可以方便地进行环境的切换，又要满足在发布版本的时候可以尽可能减少测试人员的配置。 Spring Profile 多环境 为了实现多环境配置，我们可以在本地开发的时候在Resource文件夹下新建不同环境的配置文件，如下图所示： image 这时候我们只需要在主配置文件application.yml文件使用spring.profiles.active = dev/test/prod来进行不同环境的切换
SpringBoot-yaml（在配置文件中设置多个对象）
weixin_44783506的博客
08-26 6390
SpringBoot 配置文件 SpringBoot使用一个全局的配置文件 ， 配置文件名称是固定的 application.properties 语法结构 ：key=value application.yml 语法结构 ：key：空格 value **配置文件的作用 ：**修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了； 比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下！ server.port=8081 ya
SpringBoot配置-读取 .yml配置文件
热门推荐
总该长大了的博客
03-13 7万+
之前会使用springboot，但基础知识掌握的不扎实，今天看了关于配置文件，下边稍作整理一下：大家都知道springboot的优点是配置文件少，相比springMVC少了很多的配置文件，下面就介绍一下springboot中的配置文件，传统的springboot的配置文件是以properties结尾的，如图所示：springboot出了一种新的方法，文件是这样的例如上图中的salary ：1000...
springboot单元测试读取yml文件
mySherlock的博客
04-24 7000
pom文件配置 &lt;dependencies&gt; &lt;dependency&gt; &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; &lt;artifactId&gt;spring-boot-starter&lt;/artifactId&gt; ...
spring boot 使用application.yml作为配置文件格式也特别注意
jaryle的专栏
08-07 7869
在进行spring boot 开发时，我们现在都比较喜欢使用application.yml来作为配置文件，而不喜欢使用application.properties来配置。 我个人认为还是使用application.yml比较直观，易读一些， 但是书写格式一定要注意： （1）yml文件采用空格的形式，都是偶数个空格，主关键字顶头，次之关键字换行2个空格，依次类推。。。 刚开发的时候不太注意，所以...
springboot中配置文件及yml文件的使用
独狼的博客
03-05 5242
我们都知道springboot可以自动帮助我们配置好多东西，但是如果我们想要改变那些自动配置的属性，可以吗？当然可以，我们可以通过配置文件来更改。springboot默认的全局配置文件有两个，一个是application.properties，另一个是application.yml。根据官方文档的解释，yml不是一个标记文档，那如何理解yml不是标记文档呢？我们先来看看啥是标记文档？比如xml就是...
SpringBoot学习---yaml配置
孤夜的博客
03-14 9709
一.什么是yaml yaml以数据做为中心 二.yaml基础语法 三.yaml注入配置文件
SpringBoot（8）学习笔记 yaml语法规则&加载测试专用配置&测试类启动web环境&发送虚拟请求&内置数据源jdbcTemplate&内置3种数据库
qq_53121751的博客
09-27 397
SpringBoot（8）学习笔记 yaml语法规则&加载测试专用配置&测试类启动web环境&发送虚拟请求&内置数据源jdbcTemplate&内置3种数据库
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值