SpringBoot常用读取配置文件的3种方法小结

更新时间：2023年10月18日 16:48:39 作者：Bruce1801

本文主要介绍了SpringBoot常用读取配置文件的3种方法小结,主要包括@Value读取配置文件,@ConfigurationProperties 读取配置文件和读取配置文件中的List,具有一定的参考价值,感兴趣的可以了解一下

1、使用 @Value 读取配置文件

注：这种方法适用于对象的参数比较少的情况
使用方法：

在类上添加@configuration注解，将这个配置对象注入到容器中。哪里需要用到，通过 @Autowired 注入进去就可以获取属性值了。在对象的属性上添加@Value注解，以 ${} 的形式传入配置文件中对应的属性

添加@Data注解是为了方便测试有没有读取到

application.yml

spring:
  test:
    name: yuanhaozhe
    age: 18
    phone: 1763173xxxx

ValueConfig.java

@Configuration
@Data
public class ValueConfig {
    @Value("${spring.test.name}")
    private String name;

    @Value("${spring.test.age}")
    private int age;

    @Value("${spring.test.phone}")
    private String phone;

}

BasicController.java

@Controller
public class BasicController {

	@Autowired
    private ValueConfig valueConfig;

    @RequestMapping("/test_valueConfig")
    @ResponseBody
    public String valueConfig(){
        return "name:".concat(valueConfig.getName()).concat(";age:").concat(String.valueOf(valueConfig.getAge()))
                .concat(";phone:").concat(valueConfig.getPhone());
    }


}

结果：

2、使用 @ConfigurationProperties 读取配置文件

在pom文件中添加相应注解：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

注：适用于对象的参数比较多情况下，如果对象的参数比较多情况下。

在类上添加@ConfigurationProperties注解，声明当前类为配置读取类
在注解的括号中，设置要读取属性的前缀：prefix
添加@Configuration注解，将这个配置对象注入到容器中。（或者@Controller、@RestController、@Service、@Componet等注解）

配置文件同上；
TestConfig.java

@Data
@Configuration
@ConfigurationProperties(prefix = "spring.test")
public class TestConfig {

    private String name;

    private int age;

    private String phone;
}

BasicController.java

@Controller
public class BasicController {

    @Autowired
    private TestConfig testConfig;
    
    @RequestMapping("/test_config")
    @ResponseBody
    public String testConfig(){
        return "name:".concat(testConfig.getName()).concat(";age:").concat(String.valueOf(testConfig.getAge()))
                .concat(";phone:").concat(testConfig.getPhone());
    }
}

结果：

3、读取配置文件中的List

如何配置List：

spring:
  test:
    users:
    - name: yuanhaoz
      age: 17
      phone: 123456
    - name: bruce
      age: 18
      phone: 456789

配置类：

类中的users对应配置文件中的users，可以理解为在配置文件对应前缀下按名字获取属性

@Data
@Configuration
@ConfigurationProperties(prefix = "spring.test")
public class TestConfig {
   private List<UserTest>users;
}

List中的对象：

对象中的属性对应配置文件中配置对象的属性

@Data
public class UserTest {
    private String name;

    private int age;

    private String phone;
}

测试：

@Controller
public class BasicController {

    @Autowired
    private TestConfig testConfig;

    @RequestMapping("/test_config")
    @ResponseBody
    public void testConfig(){
        List<UserTest> users = testConfig.getUsers();
        for (UserTest user:users) {
            System.out.println(user.toString());
        }
    }
}

结果：

到此这篇关于SpringBoot常用读取配置文件的3种方法小结的文章就介绍到这了,更多相关SpringBoot 读取配置文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java多线程局域网聊天室的实现
在学习了一个学期的java以后，搞了一个多线程的聊天室，熟悉了一下服务器和客户机的操作。感兴趣的小伙伴们可以参考一下
2021-06-06
Gradle修改本地仓库的位置方法实现
这篇文章主要介绍了Gradle修改本地仓库的位置方法实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-07-07
SpringBoot中的自定义starter
这篇文章主要介绍了SpringBoot中的自定义starter,Starter是Spring Boot中的一个非常重要的概念,Starter相当于模块,它能将模块所需的依赖整合起来并对模块内的Bean根据环境(条件)进行自动配置,需要的朋友可以参考下
2024-01-01
利用JavaMail发送HTML模板邮件
这篇文章主要为大家详细介绍了利用JavaMail发送HTML模板邮件，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-08-08
java实现在性能测试中进行业务验证实例
这篇文章主要为大家介绍了java实现在性能测试中进行业务验证实例，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-07-07
JAVA异常体系结构详解
Java把异常当作对象来处理，并定义一个基类java.lang.Throwable作为所有异常的超类，下面通过本文给大家分享JAVA异常体系结构，感兴趣的朋友一起看看吧
2017-11-11
Java实现求数组最长子序列算法示例
这篇文章主要介绍了Java实现求数组最长子序列算法,涉及java针对数组的递归遍历、判断相关操作技巧,需要的朋友可以参考下
2018-07-07
Java语言简介(动力节点Java学院整理)
Java是一门面向对象编程语言，不仅吸收了C++语言的各种优点，还摒弃了C++里难以理解的多继承、指针等概念，因此Java语言具有功能强大和简单易用两个特征，下面通过本文给大家分享java语言的简介，感兴趣的朋友一起看看吧
2017-03-03
$Java非法字符: ‘\ufeff‘问题及说明$
Java非法字符: ‘\ufeff‘问题及说明
这篇文章主要介绍了Java非法字符: ‘\ufeff‘问题及说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-02-02
Java aop面向切面编程(aspectJweaver)案例详解
这篇文章主要介绍了Java aop面向切面编程(aspectJweaver)案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-08-08