spring boot自定义配置源操作步骤

在Spring Boot应用中，我们通常使用application.properties或application.yml文件来定义配置，但有时需要引入非标准来源的配置，比如远程配置中心。本教程将详细解释如何自定义配置源，以便能够加载这些特殊来源的配置。 我们需要了解Spring Boot默认的配置加载机制。它会从以下位置自动加载配置： 1. application.properties 或 application.yml 在类路径下的config目录。 2. application.properties 或 application.yml 在类路径根目录。 3. 如果应用运行在jar包中，还会查找META-INF/resources/application.properties 或 META-INF/resources/application.yml。 4. 同时支持命令行参数和JVM系统属性。 然而，当需要加载远程或非标准格式的配置时，我们需要自定义配置源。以下是自定义配置源的三个关键步骤： **第一步：编写PropertySource** 创建一个类继承自EnumerablePropertySource，这个类需要包含配置信息。在这个例子中，我们使用HashMap来存储配置。例如： ```java public class MyPropertySource extends EnumerablePropertySource<Map<String, String>> { public MyPropertySource(String name, Map<String, String> source) { super(name, source); } @Override public String[] getPropertyNames() { return source.keySet().toArray(new String[source.size()]); } @Override public Object getProperty(String name) { return source.get(name); } } ``` **第二步：编写PropertySourceLocator** PropertySourceLocator接口用于找到并返回PropertySource实例。在这个例子中，我们在locate方法中创建一个Map对象作为配置源，实际使用时应替换为从远程服务器获取配置的逻辑： ```java public class MyPropertySourceLocator implements PropertySourceLocator { @Override public PropertySource<?> locate(Environment environment) { Map<String, String> properties = new HashMap<>(); properties.put("myName", "lizo"); MyPropertySource myPropertySource = new MyPropertySource("myPropertySource", properties); return myPropertySource; } } ``` **第三步：让PropertySourceLocator生效** 创建一个配置类，并声明一个Bean，该Bean是PropertySourceLocator的实现： ```java @Configuration public class MyConfigBootstrapConfiguration { @Bean public MyPropertySourceLocator myPropertySourceLocator() { return new MyPropertySourceLocator(); } } ``` 接下来，我们需要告诉Spring Boot这个配置类是一个启动配置类，因此它将在应用程序启动时优先加载。这通过在`META-INF/spring.factories`文件中添加以下内容来完成： ``` org.springframework.cloud.bootstrap.BootstrapConfiguration=com.lizo.MyConfigBootstrapConfiguration ``` 现在，Spring Boot将在启动时加载我们的自定义配置源。 **测试自定义配置源** 创建一个简单的Spring Boot应用来验证配置是否成功加载： ```java @SpringBootApplication public class Test2 { public static void main(String[] args) throws SQLException { ConfigurableApplicationContext run = SpringApplication.run(Test2.class, args); Ser bean = run.getBean(Ser.class); System.out.println(bean.getMyName()); } @Component public static class Ser { @Value("${myName}") private String myName; } } ``` 在上述测试中，`Ser` 类的 `myName` 字段将从我们自定义的配置源中获取值。运行应用程序，控制台将输出“lizo”，证明配置已成功加载。 通过自定义PropertySource和PropertySourceLocator，我们可以轻松地集成任何来源的配置到Spring Boot应用中。这使得在分布式系统中实现动态配置、远程配置成为可能，增强了系统的灵活性和可扩展性。