Spring Boot读取配置文件的几种方式

时间:2022-07-22
本文章向大家介绍Spring Boot读取配置文件的几种方式,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

Spring Boot获取文件总的来说有三种方式,分别是@Value注解,@ConfigurationProperties注解和Environment接口。这三种注解可以配合着@PropertySource来使用,@PropertySource主要是用来指定具体的配置文件。

@PropertySource解析

  • value():指定配置文件
  • encoding():指定编码,因为properties文件的编码默认是ios8859-1,读取出来是乱码
  • factory():自定义解析文件类型,因为该注解默认只会加载properties文件,如果想要指定yml等其他格式的文件需要自定义实现。

一、@Value注解读取文件

新建两个配置文件config.properties和configs.properties,分别写入如下内容:

新增一个类用来读取配置文件

如果想要读取yml文件,则我们需要重写DefaultPropertySourceFactory,让其加载yml文件,然后在注解@PropertySource上自定factory。代码如下:

二、Environment读取文件

配置文件我们继续用上面的两个,定义一个类去读取配置文件

三、@ConfigurationProperties读取配置文件

@ConfigurationProperties可以将配置文件直接映射成一个实体类,然后我们可以直接操作实体类来获取配置文件相关数据。

新建一个yml文件,当然properties文件也没问题

zhbin:
  config:
    web-configs:
      name: Java旅途
      age: 20

新建实体类用来映射该配置

  • 「prefix = "zhbin.config"用来指定配置文件前缀」

如果需要获取list集合,则做以下修改即可。

zhbin:
  config:
    web-configs:
      - name: Java旅途
        age: 20
      - name: Java旅途2
        age: 202

经验与坑

  • properties文件默认使用的是iso8859-1,并且不可修改
  • yml文件的加载顺序高于properties,但是读取配置信息的时候会读取后加载的
  • @PropertySource注解默认只会加载properties文件
  • @PropertySource注解可以与任何一种方式联合使用
  • 简单值推荐使用@Value,复杂对象推荐使用@ConfigurationProperties

< END >