深入SpringBoot:自定义PropertySourceLoader

前言

上一篇文章介绍了SpringBoot的EnableAutoConfiguration,并通过自定义注解来实现相同的功能。
这里再介绍一下SpringBoot的配置文件的加载机制,SpringBoot会默认加载ClassPath下的application.properties的文件,下面会介绍实现的原理,并通过自定义PropertySourceLoader来自定义配置加载。

PropertySourceLoader

SpringBoot加载配置文件的入口是ConfigFileApplicationListener,这个类实现了ApplicationListenerEnvironmentPostProcessor两个接口。
SpringApplication在初始化的时候会加载spring.factories配置的ApplicationListener接口的实现类。

    private void initialize(Object[] sources) {
        if (sources != null && sources.length > 0) {
            this.sources.addAll(Arrays.asList(sources));
        }
        this.webEnvironment = deduceWebEnvironment();
        setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
        setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
        this.mainApplicationClass = deduceMainApplicationClass();
    }

ConfigFileApplicationListener包含了PropertySourcesLoader,这个类会从spring.factories加载PropertySourceLoader的实现类。

    public PropertySourcesLoader(MutablePropertySources propertySources) {
        Assert.notNull(propertySources, "PropertySources must not be null");
        this.propertySources = propertySources;
        this.loaders = SpringFactoriesLoader.loadFactories(PropertySourceLoader.class,getClass().getClassLoader());
    }

PropertySourceLoader就是加载配置接口类。

    public interface PropertySourceLoader {
        String[] getFileExtensions();
        PropertySource<?> load(String name, Resource resource, String profile)
                throws IOException;
    }

getFileExtensions()是返回支持的文件扩展名,比如PropertiesPropertySourceLoader支持的扩展是xmlproperties
ConfigFileApplicationListener定义了默认的文件名DEFAULT_NAMES="application",所以SpringBoot会根据文件名加扩展名来加载文件。
load方法会读取配置文件,并返回PropertySource,SpringBoot会从PropertySource读取配置项,合并到总的配置对象中。

自定义PropertySourceLoader

所以自定义PropertySourceLoader就需要实现接口类,并配置到spring.factories中。
SpringBoot没有加载json的配置文件,这里就自定义JsonPropertySourceLoader来实现json格式配置文件的加载。完整的代码放在Github

  1. 定义JsonPropertySourceLoader,这里返回json的扩展名,通过SpringBoot内置的JsonParse,解析文件。
    解析成map格式,然后根据json的层级结构,递归进去,拼接成完整的key。
    public class JsonPropertySourceLoader implements PropertySourceLoader {
        public String[] getFileExtensions() {
            return new String[]{"json"};
        }
        public PropertySource<?> load(String name, Resource resource, String profile) throws IOException {
            Map<String, Object> result = mapPropertySource(resource);
            return new MapPropertySource(name, result);
        }
        private Map<String, Object> mapPropertySource(Resource resource) throws IOException {
            if (resource == null) {
                return null;
            }
            Map<String, Object> result = new HashMap<String, Object>();
            JsonParser parser = JsonParserFactory.getJsonParser();
            Map<String, Object> map = parser.parseMap(readFile(resource));
            nestMap("", result, map);
            return result;
        }
        private String readFile(Resource resource) throws IOException {
            InputStream inputStream = resource.getInputStream();
            List<Byte> byteList = new LinkedList<Byte>();
            byte[] readByte = new byte[1024];
            int length;
            while ((length = inputStream.read(readByte)) > 0) {
                for (int i = 0; i < length; i++) {
                    byteList.add(readByte[i]);
                }
            }
            byte[] allBytes = new byte[byteList.size()];
            int index = 0;
            for (Byte soloByte : byteList) {
                allBytes[index] = soloByte;
                index += 1;
            }
            return new String(allBytes);
        }
        private void nestMap(String prefix, Map<String, Object> result, Map<String, Object> map) {
            if (prefix.length() > 0) {
                prefix += ".";
            }
            for (Map.Entry entrySet : map.entrySet()) {
                if (entrySet.getValue() instanceof Map) {
                    nestMap(prefix + entrySet.getKey(), result, (Map<String, Object>) entrySet.getValue());
                } else {
                    result.put(prefix + entrySet.getKey().toString(), entrySet.getValue());
                }
            }
        }
    }
  1. 配置文件,这里配置了customize.property.message和日志级别logging.level.root。
{
  "customize": {
    "property": {
      "message": "hello world"
    }
  },
  "logging": {
    "level": {
      "root": "ERROR"
    }
  }
}
  1. 配置PropertySourceLoader,在工程下新建/META-INF/spring.factories文件,并配置JsonPropertySourceLoader
org.springframework.boot.env.PropertySourceLoader=org.wcong.test.springboot.JsonPropertySourceLoader
  1. main入口,取出customize.property.message并打印出来。
    @Configuration
    @EnableAutoConfiguration
    public class CustomizePropertySourceLoader {
        @Value("${customize.property.message}")
        private String message;
        public static void main(String[] args) {
            SpringApplication springApplication = new SpringApplication(CustomizePropertySourceLoader.class);
            springApplication.setWebEnvironment(false);
            ConfigurableApplicationContext configurableApplicationContext = springApplication.run(args);
            CustomizePropertySourceLoader customizePropertySourceLoader = configurableApplicationContext.getBean(CustomizePropertySourceLoader.class);
            System.out.println(customizePropertySourceLoader.message);
        }
    }

结语

SpringBoot通过spring.factories实现了很好的扩展功能。自定义模块相关一般是通过实现对应的接口,并配置到文件中。后面会介绍更多关于SpringBoot的内容。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,056评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,842评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,938评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,296评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,292评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,413评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,824评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,493评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,686评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,502评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,553评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,281评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,820评论 3 305
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,873评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,109评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,699评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,257评论 2 341

推荐阅读更多精彩内容