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();}
使用方法:
@Servicepublic 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获取配置文件内容的方式有哪些”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识,可以关注编程网行业资讯频道,小编每天都会为大家更新不同的知识点。
免责声明:
① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。
② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341