当前位置:主页 > java教程 > SpringBoot获取配置文件内容

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

发布:2023-03-27 14:00:01 59


给寻找编程代码教程的朋友们精选了相关的编程文章,网友谭蕴藉根据主题投稿了本篇教程内容,涉及到springboot、获取配置文件、spring、boot配置文件、springboot加载配置文件、SpringBoot获取配置文件内容相关内容,已被444网友关注,内容中涉及的知识点可以在下方直接下载获取。

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获取配置文件内容内容请搜索码农之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持码农之家!


参考资料

相关文章

  • IDEA新建springboot项目时未生成pom.xml文件的解决操作

    发布:2023-03-26

    这篇文章主要给大家介绍了关于IDEA新建springboot项目时未生成pom.xml文件的解决操作方法,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下


  • spring boot集成rabbitmq的代码实例

    发布:2019-10-24

    这篇文章主要给大家介绍了关于spring boot集成rabbitmq的相关资料,springboot集成RabbitMQ非常简单,文中通过示例代码介绍的非常详细,需要的朋友们可以参考借鉴,下面随着小编来一起学习学习吧


  • 动态配置Spring Boot日志级别的步骤详解

    发布:2019-07-01

    这篇文章主要给大家介绍了关于动态配置Spring Boot日志级别的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Spring Boot具有一定的参考学习价值,需要的朋友们下面来一起学


  • 解决Springboot启动报错:类文件具有错误的版本61.0,应为 52.0

    发布:2023-04-26

    这篇文章主要给大家介绍了关于解决Springboot启动报错:类文件具有错误的版本 61.0,应为 52.0的相关资料,这是查阅了网上的很多资料才解决的,分享给大家,需要的朋友可以参考下


  • SpringBoot中启动Tomcat的步骤流程

    发布:2019-07-09

    这篇文章主要介绍了SpringBoot中如何启动Tomcat流程,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧


  • 浅析Spring获取Bean的九种方法详解

    发布:2023-04-23

    随着SpringBoot的普及,Spring的使用也越来越广,在某些场景下,我们无法通过注解或配置的形式直接获取到某个Bean。比如,在某一些工具类、设计模式实现中需要使用到Spring容器管理的Bean,此时就需要直接获取到对应的Bean,这篇文章主要介绍了Spring获取Bean的九种方法


  • SpringBoot实现优雅停机的正确方法

    发布:2023-04-21

    什么叫优雅停机?就是向应用进程发出停止指令之后,能保证正在执行的业务操作不受影响,直到操作运行完毕之后再停止服务。本文就来和大家聊聊SpringBoot实现优雅停机的正确姿势,希望对大家有所帮助


  • Springboot+redis+Interceptor+自定义annotation实现接口自动幂等

    发布:2021-04-26

    本篇文章给大家介绍了使用springboot和拦截器、redis来优雅的实现接口幂等,对于幂等在实际的开发过程中是十分重要的,因为一个接口可能会被无数的客户端调用,如何保证其不影响后台的业务


网友讨论