Spring Boot配置多环境并加载多个自定义配置文件

àì夳堔傛蜴生んèń 2023-06-15 11:25 10阅读 0赞

最近在用Spring Boot时也想配置多环境(之前写过一版用maven配置的，详情请[点击][Link 1])，并且每个环境有多个配置文件。但是搜了很多都是可以配置多个环境，但是配置文件只有一个，如下图：  
![在这里插入图片描述][20191122133057369.png]  
还有一种就是使用注解的方式。

#### 注解的方式 ####

@PropertySource(value = { 
            "classpath:dev/xxx.properties",
            "classpath:dev/yyy.yml",
    }, encoding = "utf-8")

虽然可以通过将此注解加在启动类上，达到尽早加载配置文件的目的，但这仅限于我们只是使用配置文件中的值（如：用@Value注解）。

因为当开始加载 `@PropertySource` 注解中的配置文件时，Spring Boot的上下文环境早已经配置好了，此时再加载这些配置文件，对于自动配置无法产生任何影响。

下面总结了两种加载的方法，用这两种方法可以根据不同的环境加载不同的配置文件，同时，由于其是在Spring Boot启动的过程中执行的，所以，可以配置Spring Boot的上下文环境（如：端口等在默认配置文件中可以配置的属性）。

先贴一下项目结构  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tfeW91bmcxOTk3_size_16_color_FFFFFF_t_70]

> pre中与dev中文件一样，这里只放了一个文件，可以放多个

### 方法一 ###

--------------------

这种方法是最方便的，只需定义好环境和环境中的配置文件即可。

以下前两步，在第二种方法中也需要。

#### （1）配置spring.properties ####

如上图所示，添加一个`spring.properties` 文件，文件中内容如下

org.springframework.boot.env.EnvironmentPostProcessor=com.example.config.MyEnvironmentPostProcessor

> 1.其中 `com.example.config.MyEnvironmentPostProcessor` 为上图中 `MyEnvironmentPostProcessor` 类的包路径。
> 
> 2.作用是让Spring Boot在启动时，调用这个类，加载我们定义的配置文件。

#### （2）定义运行时的环境 ####

在默认的配置文件 `application.properties` 中指定环境

spring.profiles.active=dev

#### （3）加载自定义配置文件 ####

新建 `MyEnvironmentPostProcessor` 类，内容如下

package com.example.config;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.env.EnvironmentPostProcessor;
    import org.springframework.boot.env.PropertySourceLoader;
    import org.springframework.core.env.ConfigurableEnvironment;
    import org.springframework.core.env.PropertySource;
    import org.springframework.core.io.Resource;
    import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
    import org.springframework.core.io.support.ResourcePatternResolver;
    import org.springframework.core.io.support.SpringFactoriesLoader;
    import org.springframework.util.ResourceUtils;
    
    import java.io.IOException;
    import java.util.List;
    
    public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor { 
    
        private final ResourcePatternResolver resourcePatternResolver = new PathMatchingResourcePatternResolver();
    
        private final List<PropertySourceLoader> propertySourceLoaders;
    
        public MyEnvironmentPostProcessor() { 
            super();
            this.propertySourceLoaders = SpringFactoriesLoader.loadFactories(PropertySourceLoader.class, getClass().getClassLoader());
        }
    
        @Override
        public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { 
            String[] activeProfiles = environment.getActiveProfiles(); //获取当前运行的环境
            for(String activeProfile : activeProfiles) { 
                for(PropertySourceLoader loader : this.propertySourceLoaders) { 
                	//propertySourceLoaders的资源加载器有两个，一个是加载properties和xml的，另一个是加载yml和yaml
                    for(String fileExtension : loader.getFileExtensions()) { 
                        String location = ResourceUtils.CLASSPATH_URL_PREFIX + activeProfile + "/*." + fileExtension;
                        try { 
                            Resource[] resources = this.resourcePatternResolver.getResources(location);
                            for(Resource resource : resources) { 
                                List<PropertySource<?>> propertySources = loader.load(resource.getFilename(), resource);
                                if(null != propertySources && !propertySources.isEmpty()) { 
                                    propertySources.stream().forEach(environment.getPropertySources()::addLast);
                                }
                            }
                        } catch (IOException e) { 
                            e.printStackTrace();
                        }
                    }
                }
            }
        }
    }

### 方法二 ###

该方法是根据 Spring Boot 官方给的例子写的  
在执行完方法一中的前两步后，同样创建`MyEnvironmentPostProcessor`类，内容如下：

package com.example.config;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.env.EnvironmentPostProcessor;
    import org.springframework.core.env.ConfigurableEnvironment;
    import org.springframework.core.env.PropertiesPropertySource;
    import org.springframework.core.env.PropertySource;
    import org.springframework.core.io.ClassPathResource;
    import org.springframework.core.io.Resource;
    
    import java.io.IOException;
    import java.util.Properties;
    
    public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor { 
    
        //Properties对象
        private final Properties properties = new Properties();
    
        @Override
        public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { 
            //自定义配置文件
            String[] profiles = { 
                    "dev/database.properties"
            };
    
            //循环添加
            for (String profile : profiles) { 
                //从classpath路径下面查找文件
                Resource resource = new ClassPathResource(profile);
                //加载成PropertySource对象，并添加到Environment环境中
                environment.getPropertySources().addLast(loadProfiles(resource));
            }
        }
    
        //加载单个配置文件
        private PropertySource<?> loadProfiles(Resource resource) { 
            if (!resource.exists()) { 
                throw new IllegalArgumentException("资源" + resource + "不存在");
            }
            try { 
                //从输入流中加载一个Properties对象
                properties.load(resource.getInputStream());
                return new PropertiesPropertySource(resource.getFilename(), properties);
            }catch (IOException ex) { 
                throw new IllegalStateException("加载配置文件失败" + resource, ex);
            }
        }
    
    }

[Link 1]: https://blog.csdn.net/k_young1997/article/details/102532573
[20191122133057369.png]: https://img-blog.csdnimg.cn/20191122133057369.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tfeW91bmcxOTk3_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2019112213380949.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tfeW91bmcxOTk3,size_16,color_FFFFFF,t_70