快捷導(dǎo)航

SpringBoot獲取配置文件內(nèi)容的幾種方式總結(jié)

更新時(shí)間：2023年02月22日 10:11:00 作者：CV大魔王

大家都知道SpringBoot獲取配置文件的方法有很多,下面這篇文章主要給大家介紹了關(guān)于SpringBoot獲取配置文件內(nèi)容的幾種方式,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

自從用了SpringBoot，個(gè)人最喜歡的就是SpringBoot的配置文件了，和Spring比起SpringBoot更加靈活，修改的某些配置也是更加得心應(yīng)手。 SpringBoot官方提供了兩種常用的配置文件格式，分別是properties和YML格式。相比于properties來說，YML更加年輕，層級(jí)也是更加分明，不過本篇文章的重點(diǎn)是如何獲取配置文件的內(nèi)容。

現(xiàn)有配置文件如下，如何獲取到配置文件的值呢？

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

方法1：@ConfigurationProperties

首先，可以標(biāo)注到實(shí)體類上。

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

    private String windows;
    private String linux;
}

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

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

總結(jié)

@ConfigurationProperties注解能夠很輕松的從配置文件中取值，優(yōu)點(diǎn)如下：

支持批量的注入屬性，只需要指定一個(gè)前綴 prefix
支持復(fù)雜的數(shù)據(jù)類型，比如 List 、 Map
對(duì)屬性名匹配的要求較低，比如user-name，user_name，userName，USER_NAME 都可以取值
支持JAVA的JSR303數(shù)據(jù)校驗(yàn)

方法2：@Value

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

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

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

Spring Boot在啟動(dòng)的時(shí)候會(huì)自動(dòng)加載 application.xxx 和 bootsrap.xxx ，但是為了區(qū)分，有時(shí)候需要自定義一個(gè)配置文件，那么如何從自定義的配置文件中取值呢？

只需要在啟動(dòng)類上標(biāo)注 @PropertySource 并指定你自定義的配置文件即可完成。

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

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

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

@PropertySource注解有一個(gè)屬性 factory ，默認(rèn)值是PropertySourceFactory.class，這個(gè)就是用來加載properties格式的配置文件，我們可以自定義一個(gè)用來加載 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();
    }
}

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

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

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

總結(jié)

到此這篇關(guān)于SpringBoot獲取配置文件內(nèi)容的幾種方式總結(jié)的文章就介紹到這了,更多相關(guān)SpringBoot獲取配置文件內(nèi)容內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: