springboot如何读取配置文件中的属性

旧时明月      2022-05-07     328

关键词:

Springboot自定义属性注入

SpringBoot是基于约定的,所以很多配置都有默认值,但如果想使用自己的配置替换默认配置的话,就可以使用application.properties或者application.yml(application.yaml)进行配置。

SpringBoot默认会从resources目录下加载application.properties或application.yml(application.yaml)文件

下面介绍如何获取配置文件中的属性

我们以自定义数据源为例,以application.yml为默认配置文件,有如下配置:

jdbc:
  driverClassName: com.mysql.jdbc.Driver
  url: jdbc:mysql://127.0.0.1:3306/test
  username: root
  password: root

一、使用注解@Value映射

@Configuration
public class JdbcConfig {
    @Value("${jdbc.driverClassName}")
    private String driverClassName;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;

    @Bean
    public DataSource dataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
}

如上代码,可以通过@Value注解将配置文件中的值映射到一个Spring管理的Bean的字段上,会自动为字段赋值

二、使用注解@ConfigurationProperties映射

@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {
    private String driverClassName;
    private String url;
    private String username;
    private String password;

    public String getDriverClassName() {
        return driverClassName;
    }

    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

@ConfigurationProperties注解声明当前类为配置读取类

prefix="jdbc"表示读取前缀为jdbc的属性

会将配置文件中前缀为prefix的属性赋给类中同名的字段

注意:必须保证属性名称和字段一模一样,且类需要提供字段的setter方法

我们还可以在Spring中使用这个配置读取类,通过@EnableConfigurationProperties注解可以将指定的配置读取类的对象加载到Spring容器

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfig {
    @Autowired
    private JdbcProperties prop;

    @Bean
    public DataSource dataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(prop.getDriverClassName());
        dataSource.setUrl(prop.getUrl());
        dataSource.setUsername(prop.getUsername());
        dataSource.setPassword(prop.getPassword());
        return dataSource;
    }
}

如上,将JdbcProperties的对象加载到容器后,就可以通过@Autowired注解进行注入。

也可以通过构造方法注入:

private JdbcProperties prop;
public JdbcConfig(Jdbcproperties prop){
    this.prop = prop;
}

还有一种方式也可以直接使用配置读取类:

@Bean
public DataSource dataSource(JdbcProperties prop){
    DruidDataSource dataSource = new DruidDataSource();
    dataSource.setDriverClassName(prop.getDriverClassName());
    dataSource.setUrl(prop.getUrl());
    dataSource.setUsername(prop.getUsername());
    dataSource.setPassword(prop.getPassword());
    return dataSource;
}

这种方式不需要@Autowired注入字段,也不需要构造函数注入,直接在方法中定义配置读取类的形参,Springboot在创建DataSource对象时会自动注入JdbcProperties对象

三、极简的注入方式

@Configuration
public class JdbcConfig {
    @Bean
    @ConfigurationProperties(prefix = "jdbc")
    public DataSource dataSource(){
        return new DruidDataSource();
    }
}

我们直接把@ConfigurationProperties(prefix = "jdbc")声明在需要使用的@Bean的方法上,Springboot会自动将配置文件中以prefix开头的属性赋给要创建对象的类的同名字段上,使用前提:要求类该类必须提供了setter方法

使用profiles实现配置文件的切换

在微服务的开发过程中,我们经常会对不同的环境准备一个配置文件,即使没有多种环境,起码也会分开发环境和生成环境,下面就介绍一下实际开发过程中如何对配置文件进行切换

一、配置多个不同环境的配置文件

如下图:

application-dev和application-prod分别是开发环境和生成环境下使用的配置文件,文件名必须按照“application-xxx”的规则,在application.yml中如下配置进行切换:

application.yml:

spring:
  profiles:
    active: dev

二、一个配置文件中配置多种环境的配置

直接在application.yml中配置:

spring:
  profiles:
    active: dev #选择使用的环境
---
spring:
  profiles: dev #开发环境
jdbc:
  driverClassName: com.mysql.jdbc.Driver
  url: jdbc:mysql://127.0.0.1:3306/dev
  username: root
  password: root

---
spring:
  profiles: prod #生产环境
jdbc:
  driverClassName: com.mysql.jdbc.Driver
  url: jdbc:mysql://127.0.0.1:3306/prod
  username: root
  password: root

不同的环境用“---”进行分割,每种环境使用spring.profiles定义名称

springboot入门1-----如何使用@value注解读取配置文件以及使用@configrationproperties注解

读取.yml文件属性值的方式  1)如何将配置文件中的属性值与字段匹配起来    @Value("${配置文件中属性的名}")   在application.yml文件中   server:port:9000#自定义的一个cupSize属性给一个值B将cu... 查看详情

springboot框架中如何读取位于resource资源中的properties配置文件,并将配置文件中的键对应的值赋值到目标bean中?

...rties文件也可以将pic的键值对放入application.properties中,由springboot默认加载2.java代码包中新建PictureFile类,PropertySource指明文件所在位置私有属性上加 查看详情

如何从 thymeleaf 中的属性文件中读取值

...布时间】:2019-08-0723:56:39【问题描述】:有没有办法使用springboot从thymleaf中的属性文件中读取值?例如:-验证消息,从属性文件中加载标签。我正在使用springboot2.1.3版本&thymleaf3.0.11版本我需要使用属性文件在我的应用 查看详情

如何从java中的配置文件中读取嵌套属性

】如何从java中的配置文件中读取嵌套属性【英文标题】:Howtoreadnestedpropertiesfromconfigurationfileinjava【发布时间】:2018-06-0318:42:08【问题描述】:我想从配置文件中读取Name属性。我希望我的配置文件看起来像这样:config.propertiesPers... 查看详情

springboot项目读取不到配置文件中的“url“属性(代码片段)

最近新起了一个springboot项目,配置了MySQL作为项目的数据库。但是在项目启动时,报错:FailedtoconfigureaDataSource:‘url’attributeisnotspecifiedandnoembeddeddatasourcecouldfound。背景新起的springboot项目启动时报错如上,针对上... 查看详情

无法从 Spring Boot 中的外部属性文件中读取值

】无法从SpringBoot中的外部属性文件中读取值【英文标题】:UnabletoreadvaluesfromexternalpropertyfileinSpringBoot【发布时间】:2018-06-2400:59:35【问题描述】:我有一个正在运行的SpringBoot项目。我想从外部属性文件中读取一些特定于环境的... 查看详情

springboot入门_获取属性文件中的值

在上一篇文章中,记录了用springboot实现输出一个helloworld到前台的程序,本文记录学习springboot读取属性文件中配置信息。框架属性文件(application.properties)  创建一个springboot项目,并引入相关依赖,POM文件如下:1<?xmlversi... 查看详情

如何从项目目录中读取 javascript 中的属性文件?

】如何从项目目录中读取javascript中的属性文件?【英文标题】:Howtoreadapropertiesfileinjavascriptfromprojectdirectory?【发布时间】:2013-10-1902:37:38【问题描述】:我正在构建一个Chrome打包应用程序。如果配置文件在资源目录中并且在启... 查看详情

未读取junit spring boot配置文件属性

】未读取junitspringboot配置文件属性【英文标题】:junitspringbootprofilepropertiesnotbeingread【发布时间】:2018-04-2810:53:13【问题描述】:我正在使用springboot从我的junit设置中的属性文件中读取一个值。我无法读取该值。以下是我的内容... 查看详情

Spring Boot如何读取jar外的属性文件

】SpringBoot如何读取jar外的属性文件【英文标题】:Springboothowtoreadpropertiesfileoutsidejar【发布时间】:2017-06-0421:35:49【问题描述】:在我的目标文件夹中,有2个文件夹,lib和conf。所有的properties文件都放在conf文件夹中,jars放在libfo... 查看详情

补习系列(10)-springboot之配置读取

...曾经写过Spring程序通过Bean映射实现配置信息的读取。在SpringBoot框架中读取配置的方式变得非常多样 查看详情

如何根据 Spring Boot 中的活动配置文件设置注释属性值?

】如何根据SpringBoot中的活动配置文件设置注释属性值?【英文标题】:HowtosetannotationattributevaluebasedontheactiveprofileinSpringBoot?【发布时间】:2020-12-2310:24:49【问题描述】:我在SpringBoot应用程序中使用两个镜像数据库模式,并在启... 查看详情

springboot常量配置

参考技术A1.一个是.properties文件2.一个是.yml文件如果用的是.properties文件时,在实体类(或者说是javaBean)上加上注解@Configuration&@PropertySource("classpath:xxxxxx.properties")&@ConfigurationProperties(prefix="xxx.yyy")@propertySource:classpath来加载... 查看详情

spring boot中的属性文件读取错误

】springboot中的属性文件读取错误【英文标题】:Propertyfilereadingerrorinspringboot【发布时间】:2021-11-2208:48:31【问题描述】:下面是我在SpringBoot应用中的yml文件stack:apiContext:data-servicedomainOwner:tratadomainContext:Madata-service#cluster:#servicePor... 查看详情

springboot中yml文件的读取(代码片段)

...sprivateStringlocation;privateStringmaxSize;@ConfigurationProperties是SpringBoot中用于从配置文件读取配置属性的注解。当你使用@ConfigurationProperties(prefix=“global.upload”)注解的时候,你可以读取配置文件中以“global.upload”为前缀的... 查看详情

springboot属性类自动加载配置文件中的值

springboot属性类自动加载配置文件中的值,如Person类加载在yml中配置的name,age等属性值,可以通过如下步骤获取:类上添加@ConfigurationProperties注解,prefix为yml中配置的属性名称,要想属性类生效得加上@Component注解如果想要在yml中... 查看详情

[十六]springboot之读取环境变量和绑定属性对象

 1.读取环境变量凡是被spring管理的类,实现接口EnvironmentAware重写方法setEnvironment可以在工程启动时,获取到系统环境变量和application配置文件中的变量。主要是@Configuration,实现接口:EnvironmentAware就能获取到系统环境信息packa... 查看详情

springboot使用配置类映射yml配置文件信息

参考技术A使用configurationProperties注解并指明在配置文件中的前缀,然后用component注解注册进ioc容器。我这里定义的两个静态内部类,同时创建了各自的实例,比如这个Email静态内部类中有三个属性,那么配置文件就可以是mq.myrabbi... 查看详情