SpringBoot獲取配置文件內容的方式有哪些

這篇文章主要介紹“SpringBoot獲取配置文件內容的方式有哪些”的相關知識，小編通過實際案例向大家展示操作過程，操作方法簡單快捷，實用性強，希望這篇“SpringBoot獲取配置文件內容的方式有哪些”文章能幫助大家解決問題。

前言

現有配置文件如下，如何獲取到配置文件的值呢？

file:
  windows: D:\file
  linux: /usr/local/file

方法1：@ConfigurationProperties

首先，可以標注到實體類上。

@Data
@Component
@ConfigurationProperties(prefix = "file")
public class FileProperties {

    private String windows;
    private String linux;
}

標注在配置類上的方法上，同樣是從配置文件中取值賦值到返回值的屬性中。使用如下：

@Bean
@ConfigurationProperties(prefix = "userinfo")
public FileProperties fileProperties() {
    return new FileProperties();
}

使用方法：

@Service
public class Test {     
	
    @Autowired
    private FileProperties fileProperties;
    
    @Override
    public void test() {
         System.out.println(fileProperties.getLinux());
    }
}

總結

@ConfigurationProperties注解能夠很輕松的從配置文件中取值，優點如下：

• 支持批量的注入屬性，只需要指定一個前綴 prefix

• 支持復雜的數據類型，比如 List 、 Map

• 對屬性名匹配的要求較低，比如user-name，user_name，userName，USER_NAME 都可以取值

• 支持JAVA的JSR303數據校驗

方法2：@Value

@Value("${file.windows}")
private String windows;

@Value("${file.linux}")
private String linux;

如何從自定義配置文件中取值？

Spring Boot在啟動的時候會自動加載 application.xxx 和 bootsrap.xxx ，但是為了區分，有時候需要自 定義一個配置文件，那么如何從自定義的配置文件中取值呢？

只需要在啟動類上標注 @PropertySource 并指定你自定義的配置文件即可完成。

@SpringBootApplication
@PropertySource(value = {"classpath:custom.properties"})
public class DemoApplication{ }

value屬性是一個數組，可以指定多個配置文件同時引入。@PropertySource默認加載xxx.properties類型的配置文件，不能加載YML格式的配置文件。

如何加載自定義YML格式的配置文件？

@PropertySource注解有一個屬性 factory ，默認值是PropertySourceFactory.class，這個就是用來加 載properties格式的配置文件，我們可以自定義一個用來加載 YML 格式的配置文件，如下：

import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.DefaultPropertySourceFactory;
import org.springframework.core.io.support.EncodedResource;

import java.io.IOException;
import java.util.Properties;

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();
    }
}

此時只需要將 factory 屬性指定為 YmlConfigFactory 即可，如下：

@SpringBootApplication
@PropertySource(value = {"classpath:custom.yml"}, factory = YmlConfigFactory.class)
public class DemoApplication { }

@PropertySource 指定加載自定義的配置文件，默認只能加載 properties 格式，但是可以指定 factory 屬 性來加載 YML 格式的配置文件。

關于“SpringBoot獲取配置文件內容的方式有哪些”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識，可以關注億速云行業資訊頻道，小編每天都會為大家更新不同的知識點。