使用springboot配置和占位符获取配置文件中的值

使用Spring Boot进行应用开发时，经常需要读取配置文件中的信息。Spring Boot提供了使用配置文件和占位符的方式来获取配置文件中的值的方法。

Spring Boot支持多种配置文件格式，如properties、yaml和json等格式。一般来说，配置文件要放在src/main/resources目录下。

使用配置文件获取配置文件中的值

配置文件格式

首先，我们需要创建一个配置文件，例如application.properties，它使用键值对的方式定义配置信息。在这里，我们定义一个名为foo的参数，然后将其值设置为bar：

foo=bar

在应用中引用配置参数

然后，在Spring Boot应用中，我们使用@Value注解来引用配置文件中定义的参数。下面是一个将配置文件中的参数注入到变量中的示例：

@Component
public class MyComponent {

    @Value("${foo}")
    private String foo;

    //...
}

通过@Value注解，在MyComponent类的foo字段中，我们将获取名为foo的参数的值。

示例一：配置线程池大小

下面是一个更实际的例子，它演示了如何在应用程序中使用配置文件来配置线程池大小。

@Configuration
@EnableAsync
public class AppConfig implements AsyncConfigurer {

    @Value("${myapp.async.threadpool.core.size}")
    private int corePoolSize;

    @Override
    public Executor getAsyncExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(corePoolSize);
        executor.setMaxPoolSize(corePoolSize * 2);
        executor.setQueueCapacity(100);
        executor.setThreadNamePrefix("MyExecutor-");
        executor.initialize();
        return executor;
    }

    //...
}

我们将线程池核心大小配置为“myapp.async.threadpool.core.size”中定义的值。这个例子使用@Value注解注入了corePoolSize，然后将它设置到我们创建的线程池中。

示例二：配置数据库连接

下面是一个更复杂的例子，它演示了如何在应用程序中使用配置文件来配置数据库连接：

@Configuration
@EnableTransactionManagement
public class DatabaseConfig {

    @Value("${spring.datasource.url}")
    private String url;

    @Value("${spring.datasource.username}")
    private String username;

    @Value("${spring.datasource.password}")
    private String password;

    @Value("${spring.datasource.driver-class-name}")
    private String driverClassName;

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

        return dataSource;
    }

    //...
}

在这个例子中，我们将配置文件中的一组参数解析到了对应的变量中。然后，我们创建了一个BasicDataSource对象，并将配置信息设置到这个对象中。最后，我们将这个对象声明为一个Spring Bean，以便能够在代码中使用它。

使用占位符获取配置文件中的值

除了在代码中硬编码属性值外，我们还可以使用Spring Boot支持的占位符机制来动态设置这些属性。占位符能够使得配置项的值与应用的环境变量、系统属性、或是其他配置项产生联系。例如：

myapp.url=https://${domain}:8080/app

可以看到，${domain}是一个占位符，它将被实际的值替换掉。可以在配置项中嵌套使用多层占位符。

在Spring Boot应用中，可以使用@Value注解和${...}占位符来获取配置文件中的值。另外，Spring Boot也支持使用SpEL表达式在占位符中对值进行处理。

中括号语法

在SpEL中（Spring Expression Language）,可以使用中括号语法来访问环境变量或者系统属性，如：

@Value("#{systemProperties['user.timezone']}")
private String timezone;

这样就可以将Java系统属性中的user.timezone的值注入到timezone变量中。

示例三：使用占位符实现动态配置

下面是一个演示如何在应用中使用占位符实现动态配置的例子：

@Configuration
public class MyConfig {

    @Bean
    public MyBean myBean() {
        return new MyBean();
    }

    @Bean
    public MyConfigProperties myConfigProperties() {
        return new MyConfigProperties();
    }

    @ConfigurationProperties(prefix = "my.config")
    public class MyConfigProperties {

        private String myField;

        public String getMyField() {
            return myField;
        }

        public void setMyField(String myField) {
            this.myField = myField;
        }
    }

    public class MyBean {

        private String myField;

        public MyBean() {
        }

        public String getMyField() {
            return myField;
        }

        public void setMyField(String myField) {
            this.myField = myField;
        }

        @PostConstruct
        private void init() {
            myField = "${my.config.myField}";
            // resolves placeholders in value
            myField= new StrSubstitutor(new PropertyPlaceholderConfigurer().mergePropertiesIntoMap(System.getProperties())).replace(myField);
        }
    }
}

MyConfigProperties类使用了@CnfigurationProperties注解，它可以将配置文件中“my.config.myField”对应的值绑定到myField字段上。MyBean类在初始化时，使用了${...}占位符引用了这个值，并通过StrSubstitutor类解析了占位符，从而动态地设置myField值。

类似地，这个方法也可以用来动态地实例化、配置数据源、MQ、Redis等组件。

总结

在Spring Boot应用中，我们可以使用配置文件和占位符机制来获取配置信息。配置文件能够将应用程序与运行环境分离。占位符能够使应用程序的配置更加动态，更加灵活。