spring-boot-absolute-config

前言

　　该工程是为解决应用部署应用时指定配置文件存放位置的问题.

　　SpringBoot项目默认加载以下位置的配置文件:

1
2
3
4
classpath:
file:./
classpath:config/
file:./config/:

　　想要指定外部的配置文件, 一种方法就是通过启动脚本来控制:

1
2
在启动脚本中添加:
-Dspring.config.location=文件绝对路径

但有时候有些项目需要兼容之前的老项目,就会遇到使用外部绝对路径的来指定配置文件了,每次都在启动脚本中添加,显然不是很合适.因此诞生了该工程.

实现方式

通过实现 EnvironmentPostProcessor 接口, 自定义实现方法:

1
public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application)

来实现加载自定义配置文件.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
package com.github.springboot.absolute.config;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.context.config.ConfigFileApplicationListener;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.boot.env.PropertiesPropertySourceLoader;
import org.springframework.boot.env.PropertySourceLoader;
import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.Ordered;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.PathResource;
import org.springframework.core.io.Resource;
import org.springframework.util.StringUtils;
 
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.List;
 
/**
 * <p> 自定义环境加载策略
 * <p>需要在classpath下application.yml或application.properties中指定文件位置</p>
 * <p>key=config.file.absolute.path</p>
 *
 * @author lijinghao
 * @version : MyEnvironmentPostProcessor.java, v 0.1 2018年09月13日 下午4:55:55 lijinghao Exp $
 */
public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered {
 
    /**,
     * 指定加载外部文件类型: [.properties], [.yml], [.yaml]
     */
    private static final String SUFFIX_TYPE_YML                             = ".yml";
    private static final String SUFFIX_TYPE_YAML                            = ".yaml";
    private static final String SUFFIX_TYPE_PROPERTIES                      = ".properties";
 
    /**
     * 指定外部配置文件路径的KEY
     */
    private static final String CONFIG_FILE_ABSOLUTE_PATH                   = "config.file.absolute.path";
 
    private static final int DEFAULT_ORDER                                  = ConfigFileApplicationListener.DEFAULT_ORDER + 1;
 
    /**
     * Post-process the given {@code env}.
     *
     * @param environment the env to post-process
     * @param application the application to which the env belongs
     */
    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
 
        try {
 
            // Get file absolute path
            String path = environment.getProperty(CONFIG_FILE_ABSOLUTE_PATH);
            if (StringUtils.isEmpty(path)) {
                System.out.println("WARNING: External file path to be loaded is not configured.[config.file.absolute.path]");
                return;
            }
 
            System.out.println("INFO: Loading external file: \"" + path + "\"");
 
            // Loading external file
            Resource resource = new PathResource(path);
 
            PropertySourceLoader loader;
 
            if (resource.exists() && resource.isFile()) {
                String filename = resource.getFilename();
                String fileSuffix = filename.substring(filename.indexOf("."));
 
                if (SUFFIX_TYPE_PROPERTIES.equalsIgnoreCase(fileSuffix)) {
                    loader = new PropertiesPropertySourceLoader();
 
                } else if (SUFFIX_TYPE_YML.equalsIgnoreCase(fileSuffix)
                        || SUFFIX_TYPE_YAML.equalsIgnoreCase(fileSuffix)) {
                    loader = new YamlPropertySourceLoader();
 
                } else {
                    throw new RuntimeException("Unsupported file types: " + fileSuffix);
                }
            }else {
                throw new FileNotFoundException("Cannot find the file : \"" + path +"\"");
            }
 
            List<PropertySource<?>> sources = loader.load("externalFiles", resource);
            for (PropertySource<?> source : sources) {
                environment.getPropertySources().addLast(source);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
 
    }
 
 
    /**
     * Get the order value of this object.
     * <p>Higher values are interpreted as lower priority. As a consequence,
     * the object with the lowest value has the highest priority (somewhat
     * analogous to Servlet {@code load-on-startup} values).
     * <p>Same order values will result in arbitrary sort positions for the
     * affected objects.
     *
     * @return the order value
     * @see #HIGHEST_PRECEDENCE
     * @see #LOWEST_PRECEDENCE
     */
    @Override
    public int getOrder() {
        return DEFAULT_ORDER;
    }
 
}

　　在classpath:META-INF 下创建：spring.factories

　　添加如下内容：

1
org.springframework.boot.env.EnvironmentPostProcessor=com.github.springboot.absolute.config.MyEnvironmentPostProcessor

使用说明

  1. 引入pom文件

    1
    2
    3
    4
    5
    <dependency>
         <groupId>com.github.springboot</groupId>
        <artifactId>absolute-config</artifactId>
        <version>1.0.0-RELEASE</version>
     </dependency>

  2. 在classpath下的配置文件中增加参数

    1
    2
    如,在application.yml中添加
    config.file.absolute.path: /opt/app/config/**/**/application.yml

  3. 重启项目

    重启项目时,会自动加载指定位置的配置文件;

注意事项

  1. 支持配置文件的格式

    1
    2
    1) classpath下SpringBoot默认加载application.properties、application.yml或application.yaml;
    2) 外置配置文件可以是以.properties、.yml或.yaml结尾（注意配置内容的格式）；

  2. 外部加载的配置文件,不能使用原始配置文件的key

    1
    2
    如: server.port: 8090
     此参数只在classpath下的配置文件中生效,在外部加载的配置文件中不生效.

    此类key主要是在 ConfigFileApplicationListener 中进行加载.

  3. 引入了配置文件,但没配置config.file.absolute.path

    此时不会报错,只会在启动时打印提醒的语句.

  4. 配置了错误的config.file.absolute.path

    此时在项目启动时会打印出错误的异常栈,但不影响程序的正常启动.

    但是,如果你的项目中依赖了外置配置文件中的内容,可能会报错.

　　具体源代码详见：https://github.com/lthaoshao/spring-boot-absolute-config

原文地址：https://www.cnblogs.com/lthaoshao/p/9676045.html

SpringBoot2.X 项目使用外置绝对路径的配置文件的更多相关文章

  1. Android获取内置sdcard跟外置sdcard路径

    Android获取内置sdcard跟外置sdcard路径.(测试过两个手机,亲测可用) 1.先得到外置sdcard路径,这个接口是系统提供的标准接口. 2.得到上一级文件夹目录 3.得到该目录的所有文 ...

  2. J2EE web项目中解决所有路径问题

    Java中使用的路径,分为两种:绝对路径和相对路径.归根结底,Java本质上只能使用绝对路径来寻找资源.所有的相对路径寻找资源的方法,都不过是一些便利方法.不过是API在底层帮助我们构建了绝对路径,从 ...

  3. 【转】Java Web 项目获取运行时路径 classpath

    Java Web 项目获取运行时路径 classpath 假设资源文件放在maven工程的 src/main/resources 资源文件夹下,源码文件放在 src/main/java/下, 那么ja ...

  4. java web项目中 获取resource路径下的文件路径

    public GetResource{ String path = GetResource.class.getClassLoader().getResource("xx/xx.txt&quo ...

  5. (转)关于java和web项目中的相对路径问题

    原文:http://blog.csdn.net/yethyeth/article/details/1623283 关于java和web项目中的相对路径问题 分类: java 2007-05-23 22 ...

  6. Android-获取外置SDcard路径

    Android手机支持SDcard.目前很多手机厂商把SDcard集成到手机中,当然有的手机同时也支持可插拔的SDcard.这就有了内置SDcard和位置SDcard之分.当手机同时支持内置和外置SD ...

  7. JavaWeb 项目中的绝对路径和相对路径以及问题的解决方式

    近期在做JavaWeb项目,总是出现各种的路径错误,并且发现不同情况下 /  所代表的含义不同,导致在调试路径上浪费了大量时间. 在JavaWeb项目中尽量使用绝对路径  由于使用绝对路径是绝对不会出 ...

  8. springboot2 webflux 响应式编程学习路径

    springboot2 已经发布,其中最亮眼的非webflux响应式编程莫属了!响应式的weblfux可以支持高吞吐量,意味着使用相同的资源可以处理更加多的请求,毫无疑问将会成为未来技术的趋势,是必学 ...

  9. Java中动态获取项目根目录的绝对路径

    https://www.cnblogs.com/zhouqing/archive/2012/11/10/2757774.html 序言 在开发过程中经常会用到读写文件,其中就必然涉及路径问题.使用固定 ...

随机推荐

  1. 【Leetcode 二分】 滑动窗口中位数（480）

    题目 中位数是有序序列最中间的那个数.如果序列的大小是偶数,则没有最中间的数:此时中位数是最中间的两个数的平均数. 例如: [2,3,4],中位数是 3 [2,3],中位数是 (2 + 3) / 2 ...

  2. C++程序设计教材目录思维导图(增C++Primer)

    正在做C++思维导图,大工程,比较艰苦. 先做了三个C++教材目录的思维导图.C++教材不等于C++,这个容易些.看思维导图,整理所学知识,这个可以会. 给出三张图,对应三种教材: 谭浩强. C++程 ...

  3. 成功的背后！（送给所有IT人）

    希望自己迷茫的时候,看到能够惊醒 来自CSDN第3名的博主(http://blog.csdn.net/phphot/article/details/2187505) 成功的背后,有着许多不为人知的故事 ...

  4. JS原生实现五角星评价详情demo

    <style> *{margin: 0;padding: 0;} .pingfen{ width: 195px; margin:10px auto; height:20px; positi ...

  5. 【JZOJ4935】【NOIP2017GDKOI模拟1.12】b

    Boring 构造一棵包含1号结点的连通子集个数刚好为给定的n的树. 这棵树的结点不能多于60. 1<=n<=109 Gai 容易得到,计算给定一棵树的Ans1,其中Ansi表示包含i号结 ...

  6. oracle在不知道用户密码的时候，怎么样跳转到另外一个用户执行操作后并不影响该用户?

    我们通过如下的方法,可以安全使用该用户,然后再跳转回来,在某些时候比较有用 需要Alter user权限或DBA权限: SQL> select password from dba_users w ...

  7. 前端web设置div宽高一样

    <div class="constant-width-to-height-ratio"></div> .constant-width-to-height-r ...

  8. oracle 表空间/用户 增加删除

    create temporary tablespace user_temp tempfile 'C:\dmp\user_temp.dbf' size 50m autoextend on next 50 ...

  9. APP UI设计趋势：为好设计而动

    http://www.cocoachina.com/design/20150703/12029.html 作者:bone9 善心悦目的动效已然成为一个app的必备,作为设计师自然要跟随趋势学习.APP ...

  10. iOS编译错误#ld: warning: ignoring file# 之 Undefined symbols for architecture x86_64 - ld: symbol(s) not found for architecture x86_64

    ld: warning: ignoring file xxxPath/libbaidumapapi.a, missing required architecture x86_64 in file xx ...