17370845950

本文介绍如何将 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(name = "t_dynamic_config") 注解用于将该类映射到数据库中的 t_dynamic_config 表。
• @Id 和 @GeneratedValue(strategy = GenerationType.IDENTITY) 注解定义了主键和主键生成策略。
• key 字段存储配置的键，value 字段存储配置的值。
• @Getter 和 @Setter 使用 Lombok 自动生成 getter 和 setter 方法。

2. 创建数据访问接口 DynamicConfigDao

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

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

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

• 该接口继承自 JpaRepository，提供了基本的 CRUD 操作。
• findByKey(String key) 方法用于根据配置的键查找配置信息。

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) {
        DynamicConfig config = getSource().findByKey(name);
        return config != null ? config.getValue() : null;
    }

}

• 该类继承自 EnumerablePropertySource，允许我们枚举所有的配置属性。
• getPropertyNames() 方法返回所有配置的键。
• getProperty(String name) 方法根据配置的键查找配置的值。如果找不到对应的配置，则返回 null。

4. 将 PropertySource 添加到 Spring Boot 环境中

最后，我们需要将自定义的 PropertySource 添加到 Spring Boot 的环境中。

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 接口，确保在所有单例 bean 初始化完成后执行。
• afterSingletonsInstantiated() 方法将 DynamicConfigPropertySource 添加到 Spring Boot 的环境属性中。
• environment.getPropertySources().addLast(...) 将 PropertySource 添加到属性源链的末尾，确保数据库中的配置优先于 application.properties 文件中的配置。

注意事项

• 确保数据库连接配置正确。
• DynamicConfig 表中需要预先插入一些配置数据，以便在启动时加载。
• 在 application.properties 或 application.yml 文件中，可以通过 ${配置键} 的方式引用数据库中的配置值。

总结

通过自定义 PropertySource，我们可以轻松地从数据库中加载 Spring Boot 应用的配置信息，实现动态配置加载。这种方式可以避免每次修改配置后都重启服务器，提高开发效率。此外，将配置信息存储在数据库中，也方便进行统一管理和维护。