SpringBoot读取配置数据的几种方式

Posted 2023-05-02

参考技术A

方式一： 我们通过 @Value("$spring.datasource.url") 这样的方式读取PropertyPlaceholderConfigurer.properties配置数据集合,本种方式是可以适应各种应用场景,推荐使用本方式读取配置文件

方式二： 这种写法系统会依据prefix前缀自动注入配置数据到数据实体变量,这种方式不错,但是存在缺陷,我们编写的PropertyPlaceholderConfigurer扩展字段会无效,所以如果只是单纯的读取配置而不需要额外操作时可使用这方式最简单

方式三： 我们可以直接注入Environment对象示例并读取properties对象属性,与方式一的本质差不多,我们不需要编写对应字段的模型对象,但是对于程序可阅读性不好友,复用率不高

方式四： 通过系统启动时候初始化Listener,使用PropertiesLoaderUtils工具类读取指定配置文件并获得Properties配置对象,我们可以随时随地使用该对象的属性,这种方式比较少用,针对比较自定义的配置数据可使用该方式

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

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

@PropertySource解析

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(PropertySources.class)
public @interface PropertySource {

    String name() default "";

    String[] value();

    boolean ignoreResourceNotFound() default false;

    String encoding() default "";

    Class<? extends PropertySourceFactory> factory() default PropertySourceFactory.class;
}

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

一、@Value注解读取文件

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

zhbin.config.web-configs.name=Java旅途
zhbin.config.web-configs.age=22

zhbin.config.web-configs.name=Java旅途
zhbin.config.web-configs.age=18

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

@Configuration
@PropertySource(value = {"classpath:config.properties"},encoding="gbk")
public class GetProperties {

    @Value("${zhbin.config.web-configs.name}")
    private String name;
    @Value("${zhbin.config.web-configs.age}")
    private String age;

    public String getConfig() {
        return name+"-----"+age;
    }
}

如果想要读取yml文件，则我们需要重写DefaultPropertySourceFactory，让其加载yml文件，然后在注解

@PropertySource上自定factory。代码如下：

public class YmlConfigFactory extends DefaultPropertySourceFactory {
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
        String sourceName = name != null ? name : resource.getResource().getFilename();
        if (!resource.getResource().exists()) {
            return new PropertiesPropertySource(sourceName, new Properties());
        } else if (sourceName.endsWith(".yml") || sourceName.endsWith(".yaml")) {
            Properties propertiesFromYaml = loadYml(resource);
            return new PropertiesPropertySource(sourceName, propertiesFromYaml);
        } else {
            return super.createPropertySource(name, resource);
        }
    }

    private Properties loadYml(EncodedResource resource) throws IOException {
        YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
        factory.setResources(resource.getResource());
        factory.afterPropertiesSet();
        return factory.getObject();
    }
}

@PropertySource(value = {"classpath:config.properties"},encoding="gbk",factory = YmlConfigFactory.class)

二、Environment读取文件

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

@Configuration
@PropertySource(value = {"classpath:config.properties"},encoding="gbk")
public class GetProperties {

    @Autowired
    Environment environment;

    public String getEnvConfig(){
        String name = environment.getProperty("zhbin.config.web-configs.name");
        String age = environment.getProperty("zhbin.config.web-configs.age");
        return name+"-----"+age;
    }
}

三、@ConfigurationProperties读取配置文件

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

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

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

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

@Component
@ConfigurationProperties(prefix = "zhbin.config")
@Data
public class StudentYml {

    // webConfigs务必与配置文件相对应，写为驼峰命名方式
    private WebConfigs webConfigs = new WebConfigs();

    @Data
    public static class WebConfigs {
        private String name;
        private String age;
    }
}

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

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

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

@Component
@ConfigurationProperties(prefix = "zhbin.config")
@Data
public class StudentYml {

    private List<WebConfigs> webConfigs = new ArrayList<>();

    @Data
    public static class WebConfigs {

        private String name;
        private String age;
    }
}

经验与坑

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