(转)SpringBoot 打包为war包启动时导入外部配置文件

最新推荐文章于 2025-01-01 16:58:43 发布

原创最新推荐文章于 2025-01-01 16:58:43 发布 · 658 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#springboot #war

Spring Boot 专栏收录该内容

6 篇文章

订阅专栏

本文介绍了一种在Spring Boot项目中使用WAR包部署时，通过Tomcat加载指定位置application.properties配置文件的方法。通过创建LocalSettingsEnvironmentPostProcessor类并配合spring.factories文件，实现了外部配置文件的优先加载。

转自：http://blog.youkuaiyun.com/nijiayy/article/details/78457800

最近在做一个SpirngBoot的项目，要求服务器部署的时候使用tomcat启动war包的时候需要导入一个指定位置的application.properties文件。在网上查找了相关的问题之后，发现大部分都是基于jar包的，同样的方法war包下并不适用。
后来发现了一个方法，可以为完美解决这个问题。
这里写图片描述
在你的项目文件夹下，创建一个configuration文件夹用于存储各种SpringBoot的配置文件，然后新建一个Java类LocalSettingsEnvironmentPostProcessor。

package com.altynai.xxxxxx.configuration;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.support.PropertiesLoaderUtils;

import java.io.File;
import java.io.IOException;
import java.util.Properties;

public class LocalSettingsEnvironmentPostProcessor implements EnvironmentPostProcessor{
    private static final String LOCATION = "C:\\xxxx\\application.properties";

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment configurableEnvironment, SpringApplication springApplication) {
        File file = new File(LOCATION);
//        File file = new File(System.getProperty("user.home"), LOCATION);
//        System.out.println("user.home" + System.getProperty("user.home"));
        if (file.exists()) {
            MutablePropertySources propertySources = configurableEnvironment.getPropertySources();
//            System.out.println("Loading local settings from " + file.getAbsolutePath());
            Properties properties = loadProperties(file);
//            System.out.println(properties.toString());
            propertySources.addFirst(new PropertiesPropertySource("Config", properties));
        }
    }

    private Properties loadProperties(File f) {
        FileSystemResource resource = new FileSystemResource(f);
        try {
            return PropertiesLoaderUtils.loadProperties(resource);
        }
        catch (IOException ex) {
            throw new IllegalStateException("Failed to load local settings from " + f.getAbsolutePath(), ex);
        }
    }
}

这个java类的作用就是根据指定的配置文件路径，读取文件，添加到程序运行的环境中。注意，根据我的测试，这里导入的外部配置文件只能是.properties的文件，如果是.yml的话会有问题。
然后在你的resources文件夹下创建一个文件夹名为META-INF，在里面创建一个spring.factories的文件，文件内容如下：

org.springframework.boot.env.EnvironmentPostProcessor=com.altynai.xxxxx.configuration.LocalSettingsEnvironmentPostProcessor

这个文件的作用就是设置SpringBoot服务启动的时候调用我们刚才写的那个Java类。

至此，你的war包在使用tomcat启动的时候就应该可以读取制定位置的外部文件了。我的文件结构如下，仅供参考
这里写图片描述
这里还需要说明的是假设你原本的配置文件的设置属性与导入了外部配置文件的设置属性重复了最终系统运行起来使用的是哪一个？
答案是，看两个配置文件加入程序环境的先后顺序，后面的会覆盖前面的。
上面的Java类中有这个一段代码，这里的意思就是，外部的文件是最先导入的。

 propertySources.addFirst(new PropertiesPropertySource("Config", properties));

如果设置为下面的这个

 propertySources.addLast(new PropertiesPropertySource("Config", properties));

则表示最后导入外部配置文件。

参考链接:
[1] https://www.youtube.com/watch?v=uof5h-j0IeE&feature=youtu.be&t=1h17m46s
[2] https://www.youtube.com/watch?v=uof5h-j0IeE&feature=youtu.be&t=1h17m46s