SpringBoot获取配置文件内容的几种方式总结

 更新时间:2023年02月22日 10:11:00   作者:CV大魔王  
大家都知道SpringBoot获取配置文件的方法有很多,下面这篇文章主要给大家介绍了关于SpringBoot获取配置文件内容的几种方式,文中通过实例代码介绍的非常详细,需要的朋友可以参考下

前言

自从用了SpringBoot,个人最喜欢的就是SpringBoot的配置文件了,和Spring比起SpringBoot更加灵活,修改的某些配置也是更加得心应手。 SpringBoot官方提供了两种常用的配置文件格式,分别是properties和YML格式。相比于properties来说,YML更加年轻,层级也是更加分明,不过本篇文章的重点是如何获取配置文件的内容。

现有配置文件如下,如何获取到配置文件的值呢?

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获取配置文件内容的几种方式总结的文章就介绍到这了,更多相关SpringBoot获取配置文件内容内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • mybatis-plus条件构造器的操作代码

    mybatis-plus条件构造器的操作代码

    mybatis-plus提供了AbstractWrapper抽象类,提供了很多sql语法支持的方法,比如模糊查询,比较,区间,分组查询,排序,判断空,子查询等等,方便我们用面向对象的方式去实现sql语句,本文重点给大家介绍mybatis-plus条件构造器的操作代码,感兴趣的朋友一起看看吧
    2022-03-03
  • 那些年用httpclient时踩过的一些坑

    那些年用httpclient时踩过的一些坑

    这篇文章主要给大家介绍了关于那些年用httpclient时踩过的一些坑,文中通过示例代码介绍的非常详细,对大家学习或者使用httpclient具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-05-05
  • springBoot的事件机制GenericApplicationListener用法解析

    springBoot的事件机制GenericApplicationListener用法解析

    这篇文章主要介绍了springBoot的事件机制GenericApplicationListener用法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值的相关资料
    2019-09-09
  • java连接SQL Server数据库的超详细教程

    java连接SQL Server数据库的超详细教程

    最近在java连接SQL数据库时会出现一些问题,所以这篇文章主要给大家介绍了关于java连接SQL Server数据库的超详细教程,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2022-06-06
  • Java GUI编程菜单组件实例详解

    Java GUI编程菜单组件实例详解

    在实际开发中,除了主界面,还有一类比较重要的内容就是菜单相关组件,可以通过菜单相关组件很方便的使用特定的功能,今天通过本文给大家介绍下Java GUI编程菜单组件实例详解,感兴趣的朋友一起看看吧
    2022-04-04
  • Java 中 Class Path 和 Package的使用详解

    Java 中 Class Path 和 Package的使用详解

    这篇文章主要介绍了Java 中 Class Path和Package的使用详解,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的朋友可以参考一下
    2022-08-08
  • Tomcat ClassLoader打破双亲委派源码解析

    Tomcat ClassLoader打破双亲委派源码解析

    这篇文章主要为大家介绍了Tomcat ClassLoader打破双亲委派源码解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • JAVA使用POI获取Excel的列数与行数

    JAVA使用POI获取Excel的列数与行数

    Apache POI 是用Java编写的免费开源的跨平台的 Java API,Apache POI提供API给Java程式对Microsoft Office格式档案读和写的功能。 下面这篇文章给大家介绍了JAVA使用POI获取Excel列数和行数的方法,有需要的朋友们可以参考借鉴,下面来一起看看吧。
    2016-12-12
  • 详解如何实现SpringBoot的底层注解

    详解如何实现SpringBoot的底层注解

    今天给大家带来的文章是如何实现SpringBoot的底层注解,文中有非常详细的介绍及代码示例,对正在学习java的小伙伴很有帮助,需要的朋友可以参考下
    2021-06-06
  • 如何解决使用restTemplate进行feign调用new HttpEntity<>报错问题

    如何解决使用restTemplate进行feign调用new HttpEntity<>报错问题

    这篇文章主要介绍了如何解决使用restTemplate进行feign调用new HttpEntity<>报错问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-06-06

最新评论