SpringBoot如何读取非默认配置文件（@PropertySource）

Posted 2021-06-08 ShuSheng007

[版权申明] 非商业目的注明出处可自由转载
博文地址：https://blog.csdn.net/ShuSheng0007/article/details/117048587
出自：shusheng007

文章目录

• 概述
• 自定义配置文件
• 读取内容

概述

众所周知，我们可以将程序的配置写在默认的application.properties文件中，但是有时我们为了便于管理，存在将某些配置写在单独的文件中的需求，SpringBoot如何实现呢？今天就叨叨一下

自定义配置文件

首先我们的有个自定义的配置文件，例如info.properties，其内容如下，那我们如何读取其内容呢？

test.name= hello

读取内容

1. 将其放在src/main/resources目录下。

可以存放在resources目录下的任何目录，已有或者自建目录均可。例如此处我自己建了一个properties文件夹。

2. 配置文件映射类

我们准备使用类文件映射配置的方式，按照配置文件的结构写出相应的类，并使用@ConfigurationProperties注解

@ConfigurationProperties(prefix = "test")
public class InfoConfig {
    private String name;
    public void setName(String name) {
        this.name = name;
    }
    public String getTest() {
        return name;
    }
}

关于这块请参考：SpringBoot如何读取配置文件(@Value/@ConfigurationProperties/Environment)

3. 使Spring可以找到自定义配置文件

Spring可以轻松找到默认的配置文件，但是自定义的它不知道，我们的告诉它到哪里去找。那怎么告诉它呢？答案就是使用@PropertySource注解

@PropertySource(value = "classpath:properties/info.properties")
@ConfigurationProperties(prefix = "test")
public class InfoConfig {
...
}

注意其value的值

4. 让Spring感知到这个配置类

因为我们要使用此配置类来获取值，所以我们Spring帮我们注入实例，那么久的让Spring扫描到这个类，使用@Configuration注解即可。

自测这种使用@PropertySource的情形，@EnableConfigurationProperties与@ConfigurationPropertiesScan是不起作用的，必须使用@Configuration

最后的代码样子如下：

@Configuration
@PropertySource(value = "classpath:properties/info.properties",ignoreResourceNotFound = true)
@ConfigurationProperties(prefix = "test")
public class InfoConfig {
    private String name;

    public void setName(String name) {
        this.name = name;
    }

    public String getTest() {
        return name;
    }
}

文章最后有源码，可以的话star一个。

GitHub源码： springboot-learn