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

标签：active   conf   使用配置   代码   同名   getpass   声明   开头   必须   

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如何读取配置文件中的属性

标签：active   conf   使用配置   代码   同名   getpass   声明   开头   必须   

原文地址：https://www.cnblogs.com/ithushuai/p/12656464.html