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 读取配置文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家! 

相关文章

  • 前后端分离跨域springBoot跨域有效解决问题

    前后端分离跨域springBoot跨域有效解决问题

    这篇文章主要介绍了前后端分离跨域springBoot跨域有效解决问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • java定时任务Timer和TimerTask使用详解

    java定时任务Timer和TimerTask使用详解

    这篇文章主要为大家详细介绍了java定时任务Timer和TimerTask使用方法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-02-02
  • 利用Java+OpenCV实现拍照功能

    利用Java+OpenCV实现拍照功能

    网上大多是利用C语言或者Python实现拍照功能,本文将为大家介绍另一种方法,即在Java中调用OpenCV实现拍照功能,感兴趣的可以了解一下
    2022-01-01
  • 利用Jackson实现JSON数据的合并

    利用Jackson实现JSON数据的合并

    Jackson的功能丰富,安全可靠并且具有比较好的兼容性,这让程序开发人员可以很方便地实现JSON 数据的相互转换,下面小编就来和大家介绍一下如何利用Jackson实现JSON数据的合并吧
    2025-03-03
  • Intellij IDEA根据maven依赖名查找它是哪个pom.xml引入的(图文详解)

    Intellij IDEA根据maven依赖名查找它是哪个pom.xml引入的(图文详解)

    这篇文章主要介绍了Intellij IDEA根据maven依赖名查找它是哪个pom.xml引入的,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-08-08
  • Springboot vue导出功能实现代码

    Springboot vue导出功能实现代码

    这篇文章主要介绍了Springboot vue导出功能实现代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • java实现自定义时钟并实现走时功能

    java实现自定义时钟并实现走时功能

    这篇文章主要为大家详细介绍了java实现自定义时钟并实现走时功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-06-06
  • Maven的安装配置详解

    Maven的安装配置详解

    这篇文章主要介绍了Maven的安装配置详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • Java中Properties类的操作实例详解

    Java中Properties类的操作实例详解

    这篇文章主要介绍了Java中Properties类的操作实例详解的相关资料,需要的朋友可以参考下
    2017-04-04
  • 基于JTable的列宽与内容自适应的实现方法

    基于JTable的列宽与内容自适应的实现方法

    本篇文章是对JTable的列宽与内容自适应的实现方法进行了详细的分析介绍,需要的朋友参考下
    2013-05-05

最新评论