Springboot如何讀取配置文件中的屬性

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定義名稱