通过数据库动态配置 Spring Boot 应用属性

本文介绍如何通过数据库动态配置 Spring Boot 应用的 application.properties 属性，从而避免每次修改配置都需要重启服务器的问题。我们将创建一个自定义的 PropertySource，从数据库读取配置信息，并将其添加到 Spring Boot 的环境中。这使得我们可以直接在运行时从数据库获取配置，实现配置的动态更新，提高应用的灵活性和可维护性。

实现动态配置的步骤

以下是实现通过数据库动态配置 Spring Boot 应用属性的详细步骤：

1. 创建实体类 DynamicConfig

首先，我们需要创建一个实体类来映射数据库中的配置信息。该实体类包含配置的键和值。

import lombok.Getter;
import lombok.Setter;
import javax.persistence.*;

@Setter
@Getter
@Entity
@Table(name = "t_dynamic_config")
public class DynamicConfig {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;
    private String key;
    private String value;

}

说明:

百度文心百中

百度大模型语义搜索体验中心

下载

• @Entity 和 @Table 注解用于将该类映射到数据库表 t_dynamic_config。
• @Id 和 @GeneratedValue 注解用于指定主键和主键生成策略。
• key 字段存储属性的名称，value 字段存储属性的值。
• @Setter 和 @Getter 是 Lombok 提供的注解，用于自动生成 getter 和 setter 方法。

2. 创建数据访问接口 DynamicConfigDao

接下来，我们需要创建一个数据访问接口，用于从数据库中读取配置信息。

import org.springframework.data.jpa.repository.JpaRepository;

public interface DynamicConfigDao extends JpaRepository {
    DynamicConfig findByKey(String key);
}

说明:

• 该接口继承自 JpaRepository，提供了常用的数据库操作方法。
• findByKey 方法用于根据属性名称查找配置信息。

3. 创建自定义 PropertySource 类 DynamicConfigPropertySource

然后，我们需要创建一个自定义的 PropertySource 类，用于从数据库中读取配置信息并将其添加到 Spring Boot 的环境中。

import org.springframework.core.env.EnumerablePropertySource;

public class DynamicConfigPropertySource extends EnumerablePropertySource {

    public DynamicConfigPropertySource(String name, DynamicConfigDao source) {
        super(name, source);
    }

    @Override
    public String[] getPropertyNames() {
        return getSource().findAll().stream().map(DynamicConfig::getKey).toArray(String[]::new);
    }

    @Override
    public Object getProperty(String name) {
        return getSource().findByKey(name).getValue();
    }

}

说明:

• 该类继承自 EnumerablePropertySource，可以枚举所有的属性名称。
• getPropertyNames 方法用于获取所有的属性名称，从数据库中获取所有的 DynamicConfig 实体，并提取它们的 key 字段。
• getProperty 方法用于根据属性名称获取属性值，从数据库中根据 key 查找对应的 DynamicConfig 实体，并返回其 value 字段。

4. 在 Spring Boot 应用中注册 DynamicConfigPropertySource

最后，我们需要在 Spring Boot 应用中注册 DynamicConfigPropertySource。

import org.springframework.beans.factory.SmartInitializingSingleton;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Component;
import org.springframework.core.env.ConfigurableEnvironment;

@SpringBootApplication
public class TestApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }

    @Component
    static class ConfigDynamicConfigPropertySource implements SmartInitializingSingleton {
        @Autowired
        private ConfigurableEnvironment environment;
        @Autowired
        private DynamicConfigDao dynamicConfigDao;

        @Override
        public void afterSingletonsInstantiated() {
            environment.getPropertySources().addLast(new DynamicConfigPropertySource("db_source",dynamicConfigDao));
        }
    }
}

说明:

• ConfigDynamicConfigPropertySource 类实现了 SmartInitializingSingleton 接口，该接口的 afterSingletonsInstantiated 方法会在 Spring Boot 应用启动后，所有的单例 Bean 都初始化完成后被调用。
• 在该方法中，我们创建了一个 DynamicConfigPropertySource 实例，并将其添加到 Spring Boot 的环境中。
• environment.getPropertySources().addLast 方法将 DynamicConfigPropertySource 添加到属性源列表的末尾，这意味着如果 application.properties 文件中定义了相同的属性，那么 application.properties 文件中的属性值将会覆盖数据库中的属性值。如果需要让数据库中的属性值覆盖 application.properties 文件中的属性值，可以使用 environment.getPropertySources().addFirst 方法。

注意事项

• 确保数据库连接配置正确，并且 t_dynamic_config 表已经创建。
• 在 t_dynamic_config 表中添加需要动态配置的属性。
• 如果属性值包含特殊字符，需要进行转义。
• 可以根据实际需要调整 DynamicConfigPropertySource 的优先级。

总结

通过以上步骤，我们成功地实现了通过数据库动态配置 Spring Boot 应用的属性。这种方法可以避免每次修改配置都需要重启服务器的问题，提高了应用的灵活性和可维护性。可以根据实际需求进行扩展，例如添加缓存机制，提高性能。