init config loader

.gitignore

@@ -0,0 +1,91 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Maven template
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+# https://github.com/takari/maven-wrapper#usage-without-binary-jar
+.mvn/wrapper/maven-wrapper.jar
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/*
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+*.iml
+*.log
+logs/
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Java template
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+

README.md

@@ -0,0 +1,3 @@
+# 常用整理工具
+
+## [仿SpringBoot属性文件加载](./configuration-loader/README.md)

configuration-loader/README.md

@@ -0,0 +1,91 @@
+# 仿SpringBoot属性文件加载
+
+> 一般Java应用程序中,用于加载属性文件
+
+## 依赖
+
+### 1.必须的依赖
+```xml
+<dependency>
+    <groupId>com.fasterxml.jackson.core</groupId>
+    <artifactId>jackson-databind</artifactId>
+    <version>${jackson.version}</version>
+</dependency>
+```
+### 2. 可先依赖(至少有一个,或者两个都加)
+```xml
+<!-- yml/yaml -->
+<dependency>
+    <groupId>com.fasterxml.jackson.dataformat</groupId>
+    <artifactId>jackson-dataformat-yaml</artifactId>
+    <version>${jackson.version}</version>
+</dependency>
+
+<!-- properties -->
+<dependency>
+    <groupId>com.fasterxml.jackson.dataformat</groupId>
+    <artifactId>jackson-dataformat-properties</artifactId>
+    <version>${jackson.version}</version>
+</dependency>
+```
+如果两个依赖都加的话,文件后缀顺序为:
+
+1. yml - jackson-dataformat-yaml
+2. yaml - jackson-dataformat-yaml
+3. properties - jackson-dataformat-properties
+
+## 用法
+ConnectorProperties.java
+```java
+@Data
+public class ConnectorProperties {
+
+    private Connector connector;
+    private Transfer transfer;
+    private Redis redis;
+
+    @Data
+    public static class Connector {
+        private Integer port;
+    }
+
+    @Data
+    public static class Transfer {
+        private List<String> urls;
+    }
+
+    @Data
+    public static class Redis {
+        private String host;
+        private Integer port;
+        private String password;
+        private int database;
+    }
+
+}
+```
+application.yml
+```yaml
+profile:
+  active: dev
+```
+
+application-dev.yml
+```yaml
+connector:
+  port: 9081
+transfer:
+  # all transfer services url
+  urls: [127.0.0.1:9082]
+redis:
+  host: ${connector.port}
+  port: 6379
+  password:
+  dababase: 0
+```
+
+默认的配置文件为`application.yml/application.yaml/application.properties`
+
+```java
+ConnectorProperties connectorProperties = ConfigLoader.parseConfig(ConnectorProperties.class);
+```

configuration-loader/pom.xml

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>lang-utils</artifactId>
+        <groupId>me.yuxiaoyao.lang</groupId>
+        <version>1.0.0</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>configuration-loader</artifactId>
+
+
+    <dependencies>
+
+        <!-- json -->
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <scope>provided</scope>
+        </dependency>
+
+        <!-- jackson data format -->
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-yaml</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-properties</artifactId>
+            <scope>provided</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>8</source>
+                    <target>8</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+
+</project>

configuration-loader/src/main/java/me/yuxiaoyao/config/loader/ConfigLoader.java

@@ -0,0 +1,370 @@
+package me.yuxiaoyao.config.loader;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.core.JsonFactory;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import java.io.*;
+import java.util.*;
+
+/**
+ * @author Kerry on 19/10/09
+ */
+
+public class ConfigLoader {
+
+    private static final String PROFILE = "profile";
+    private static final String ACTIVE = "active";
+
+    public static final String ACTIVE_PROFILE = PROFILE + "." + ACTIVE;
+
+    /**
+     * 如果想修改,可以通过反射修改
+     */
+    private static String DEFAULT_FILE_CONFIG_FOLDER = "config";
+    private static String DEFAULT_APPLICATION = "application";
+
+    private static String START_PLACEHOLDER = "${";
+    private static String END_PLACEHOLDER = "}";
+
+
+    private enum ConfigProtocol {
+        /**
+         * 文件
+         */
+        FILE(1),
+        /**
+         * 类路径
+         */
+        CLASSPATH(0);
+
+        /**
+         * 配置文件优先级
+         */
+        private int order;
+
+        ConfigProtocol(int order) {
+            this.order = order;
+        }
+
+        public static List<ConfigProtocol> sortList() {
+            List<ConfigProtocol> configProtocols = new ArrayList<>(Arrays.asList(values()));
+            configProtocols.sort((o1, o2) -> o2.order - o1.order);
+            return configProtocols;
+        }
+    }
+
+    public interface ConfigListener {
+        /**
+         * 回调Profile
+         *
+         * @param profile
+         */
+        void activeProfile(String profile);
+    }
+
+    /**
+     * 返回数据流
+     *
+     * @param configProtocol
+     * @param path
+     * @return 结果可能为 null
+     */
+    private static InputStream getConfigFileAsStream(ConfigProtocol configProtocol, String path) {
+
+        switch (configProtocol) {
+            case FILE:
+                try {
+                    return new FileInputStream(new File(DEFAULT_FILE_CONFIG_FOLDER + File.separator + path));
+                } catch (FileNotFoundException ignored) {
+                }
+                return null;
+            case CLASSPATH:
+                return Thread.currentThread().getContextClassLoader().getResourceAsStream(path);
+            default:
+                throw new Error("not support this path = " + path);
+        }
+    }
+
+
+    public static <T> T parseConfig(Class<T> clazz) {
+        return parseConfig(null, clazz, null);
+    }
+
+    public static <T> T parseConfig(String[] args, Class<T> clazz, ConfigListener configListener) {
+        LinkedHashMap map = loaderConfig(args, configListener);
+        return getObjectMapper().convertValue(map, clazz);
+    }
+
+
+    public static <T> T parseConfig(TypeReference<T> toValueTypeRef) {
+        return parseConfig(null, toValueTypeRef, null);
+    }
+
+    public static <T> T parseConfig(String[] args, TypeReference<T> toValueTypeRef, ConfigListener configListener) {
+        LinkedHashMap map = loaderConfig(args, configListener);
+        return getObjectMapper().convertValue(map, toValueTypeRef);
+    }
+
+    private static ObjectMapper getObjectMapper() {
+        ObjectMapper objectMapper = new ObjectMapper();
+        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+        return objectMapper;
+    }
+
+    /**
+     * 加载默认配置文件
+     *
+     * @return
+     */
+    public static LinkedHashMap loaderConfig() {
+        return loaderConfig(null, null);
+    }
+
+    /**
+     * 加载指定 profile 的配置文件
+     *
+     * @param args
+     * @return
+     */
+    public static LinkedHashMap loaderConfig(String[] args, ConfigListener configListener) {
+
+        List<ConfigProtocol> configProtocols = ConfigProtocol.sortList();
+        LinkedHashMap defaultProperties = null;
+        ConfigProtocol matchProtocol = null;
+        for (ConfigProtocol protocol : configProtocols) {
+            LinkedHashMap temp = selectConfig(protocol, DEFAULT_APPLICATION);
+            if (temp != null) {
+                defaultProperties = temp;
+                matchProtocol = protocol;
+                break;
+            }
+        }
+        if (defaultProperties == null) {
+            return null;
+        }
+
+        String profile = getProfileByArgs(args);
+
+        if (profile == null || profile.length() == 0) {
+            profile = getActiveProfile(defaultProperties);
+            if (configListener != null) {
+                configListener.activeProfile(profile);
+            }
+        }
+        LinkedHashMap map = selectConfig(matchProtocol, DEFAULT_APPLICATION + "-" + profile);
+        if (map != null) {
+            removeActiveProfile(map);
+            //noinspection unchecked
+            defaultProperties.putAll(map);
+        }
+        return propertiesHandler(defaultProperties);
+    }
+
+
+    private static LinkedHashMap selectConfig(ConfigProtocol configProtocol, String filePrefix) {
+        InputStream configFileAsStream = getConfigFileAsStream(configProtocol, filePrefix + ".yml");
+        if (configFileAsStream == null) {
+            configFileAsStream = getConfigFileAsStream(configProtocol, filePrefix + ".yaml");
+        }
+        Object yamlFactory = null;
+        try {
+            Class<?> factory = Class.forName("com.fasterxml.jackson.dataformat.yaml.YAMLFactory");
+            yamlFactory = factory.newInstance();
+        } catch (InstantiationException | IllegalAccessException | ClassNotFoundException e) {
+            // e.printStackTrace();
+        }
+        ObjectMapper objectMapper = null;
+        if (configFileAsStream != null && yamlFactory != null) {
+            objectMapper = new ObjectMapper((JsonFactory) yamlFactory);
+        } else {
+            configFileAsStream = getConfigFileAsStream(configProtocol, filePrefix + ".properties");
+            try {
+                Class<?> javaProps = Class.forName("com.fasterxml.jackson.dataformat.javaprop.JavaPropsMapper");
+                objectMapper = (ObjectMapper) javaProps.newInstance();
+            } catch (ClassNotFoundException | IllegalAccessException | InstantiationException e) {
+                // e.printStackTrace();
+            }
+        }
+        if (objectMapper == null) {
+            throw new Error("jackson dependencies at least container [jackson-dataformat-yaml] or [jackson-dataformat-properties].");
+        }
+        if (configFileAsStream == null) {
+            return null;
+        }
+        try {
+            return objectMapper.readValue(configFileAsStream, LinkedHashMap.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+        return null;
+    }
+
+
+    private static String getActiveProfile(Map fileMap) {
+        Object profile = fileMap.get(PROFILE);
+        if (profile instanceof Map) {
+            final Object o = ((Map) profile).get(ACTIVE);
+            if (o != null) {
+                return (String) o;
+            }
+        }
+        return null;
+    }
+
+    private static void removeActiveProfile(Map map) {
+        Object profile = map.get(PROFILE);
+        if (profile instanceof Map) {
+            ((Map) profile).remove(ACTIVE);
+        }
+    }
+
+    /**
+     * 属性处理,目前暂时不处理,替换符号等操作
+     *
+     * @param map
+     * @return
+     */
+    private static LinkedHashMap propertiesHandler(LinkedHashMap map) {
+        Map<Object, String> preHandler = new LinkedHashMap<>();
+        // find placeholder value
+        findPreResolveProperties(map, preHandler, null);
+        // replace value
+        Map<Object, Object> objectObjectMap = ConfigLoader.resolveProperties(map, preHandler);
+        // replace to map
+        replaceProperties(map, objectObjectMap);
+        return map;
+    }
+
+
+    private static Object getProperties(Map map, String key) {
+        final int i = key.indexOf(".");
+        if (i == -1) {
+            return map.get(key);
+        }
+        String currentKey = key.substring(0, i);
+        Object o = map.get(currentKey);
+
+        if (o instanceof Map) {
+            return getProperties((Map) o, (key.substring(i + 1)));
+        }
+        return o;
+    }
+
+    @SuppressWarnings("unchecked")
+    private static void setProperties(Map map, String key, Object value) {
+        if (map == null) {
+            return;
+        }
+        final int i = key.indexOf(".");
+        if (i == -1) {
+            map.put(key, value);
+            return;
+        }
+        String currentKey = key.substring(0, i);
+        Object o = map.get(currentKey);
+        if (o instanceof Map) {
+            setProperties((Map) o, (key.substring(i + 1)), value);
+        } else {
+            map.put(key, value);
+        }
+    }
+
+
+    public static void replaceProperties(Map map, Map<Object, ?> handlerMap) {
+
+        for (Object o : handlerMap.keySet()) {
+            Object value = handlerMap.get(o);
+            setProperties(map, o.toString(), value);
+
+        }
+
+    }
+
+
+    /**
+     * 把带的占位符的值替换为真实值
+     *
+     * @param map
+     * @param preHandlerMap
+     * @return
+     */
+    public static Map<Object, Object> resolveProperties(Map map, Map<Object, ?> preHandlerMap) {
+        Map<Object, Object> processedMap = new LinkedHashMap<>(preHandlerMap.size());
+
+        for (Object o : preHandlerMap.keySet()) {
+            Object value = preHandlerMap.get(o);
+
+            if (value instanceof String) {
+                // source value
+                String str = ((String) value).trim();
+                str = str.substring(START_PLACEHOLDER.length(), str.length() - END_PLACEHOLDER.length());
+                String[] defaultValue = str.split(":");
+                Object properties;
+                if (defaultValue.length > 1) {
+                    properties = getProperties(map, defaultValue[0]);
+                } else {
+                    properties = getProperties(map, defaultValue[0]);
+                }
+                // set default value
+                if (properties == null) {
+                    if (defaultValue.length > 1) {
+                        properties = defaultValue[1];
+                    } else {
+                        properties = value;
+                    }
+                }
+                /// System.out.println("key = [" + value + "] - value = [" + properties + "]");
+                processedMap.put(o, properties);
+            }
+        }
+        return processedMap;
+    }
+
+    /**
+     * 查找所有具有占位符号的值,目前不支持数组
+     * 起始符 {@link ConfigLoader#START_PLACEHOLDER}
+     * 结束符 {@link ConfigLoader#END_PLACEHOLDER}
+     *
+     * @param map
+     * @param result 查找结果接收
+     * @return
+     */
+    public static void findPreResolveProperties(Map map, Map<Object, String> result, String prefix) {
+
+        for (Object key : map.keySet()) {
+            Object value = map.get(key);
+            if (value instanceof Map) {
+                findPreResolveProperties((Map) value, result, prefix == null ? key.toString() : prefix + "." + key.toString());
+            } else if (value instanceof String) {
+                String str = ((String) value).trim();
+                if (str.startsWith(START_PLACEHOLDER) && str.endsWith(END_PLACEHOLDER)) {
+                    if (prefix == null) {
+                        result.put(key.toString(), str);
+                    } else {
+                        result.put(prefix + "." + key.toString(), str);
+                    }
+                }
+            }
+        }
+        //prefix = "";
+    }
+
+
+    private static String getProfileByArgs(String[] args) {
+        if (args != null && args.length > 0) {
+            for (String arg : args) {
+                arg = arg.trim();
+                if (arg.startsWith("--profile=")) {
+                    return arg.substring(10);
+                }
+            }
+        }
+        return null;
+    }
+
+
+}

configuration-loader/src/test/java/me/yuxiaoyao/config/loader/ConfigLoaderTest.java

@@ -0,0 +1,60 @@
+package me.yuxiaoyao.config.loader;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+
+
+
+class ConfigLoaderTest {
+
+    @Test
+    public void resolveProperties() {
+        Map<String, Object> map = new LinkedHashMap<>();
+        map.put("port", 8080);
+        map.put("host", "yuxiaoyao.me");
+
+        Map<String, Object> redis = new LinkedHashMap<>();
+        redis.put("host", "127.0.0.1");
+        redis.put("redis-port", 6379);
+        redis.put("password", "----***____");
+        map.put("redis", redis);
+
+        Map<String, Object> app = new LinkedHashMap<>();
+        app.put("server", "--");
+        app.put("sp", "${redis.host}");
+        map.put("app", app);
+
+        Map<String, Object> testInfo = new LinkedHashMap<>();
+        testInfo.put("no", "test-server");
+        testInfo.put("protocol-no", "${app.sp}");
+        testInfo.put("protocol-server", "${app.server}");
+        testInfo.put("test-default", "${app.default:2222}");
+        testInfo.put("test-port", "${port}");
+        testInfo.put("notExit", "${portaaa}");
+
+        map.put("testInfo", testInfo);
+        map.put("first", "${redis.passworda:@@@@}");
+
+        System.out.println(map);
+
+
+        Map<Object, String> preHandler = new HashMap<>();
+        // find
+        ConfigLoader.findPreResolveProperties(map, preHandler, null);
+        System.out.println("find: " + preHandler);
+        // replace value
+        final Map<Object, Object> objectObjectMap = ConfigLoader.resolveProperties(map, preHandler);
+        System.out.println(objectObjectMap);
+
+        // replace to map
+
+        ConfigLoader.replaceProperties(map, objectObjectMap);
+        System.out.println("last:" + map);
+
+    }
+
+}

pom.xml

@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>me.yuxiaoyao.lang</groupId>
+    <artifactId>lang-utils</artifactId>
+    <packaging>pom</packaging>
+    <version>1.0.0</version>
+    <modules>
+        <module>configuration-loader</module>
+    </modules>
+
+
+    <properties>
+        <sourceEncoding>UTF-8</sourceEncoding>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        <compile.encoding>UTF-8</compile.encoding>
+        <compile.target>8</compile.target>
+        <compile.source>8</compile.source>
+
+        <slf4j.version>1.7.28</slf4j.version>
+        <logback.version>1.2.3</logback.version>
+        <lombok.version>1.18.10</lombok.version>
+        <jackson.version>2.10.0</jackson.version>
+    </properties>
+
+
+    <dependencyManagement>
+        <dependencies>
+            <!-- log -->
+            <dependency>
+                <groupId>org.slf4j</groupId>
+                <artifactId>slf4j-api</artifactId>
+                <version>${slf4j.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>ch.qos.logback</groupId>
+                <artifactId>logback-classic</artifactId>
+                <version>${logback.version}</version>
+            </dependency>
+
+            <!-- json -->
+            <dependency>
+                <groupId>com.fasterxml.jackson.core</groupId>
+                <artifactId>jackson-databind</artifactId>
+                <version>${jackson.version}</version>
+            </dependency>
+
+            <!-- jackson data format -->
+            <dependency>
+                <groupId>com.fasterxml.jackson.dataformat</groupId>
+                <artifactId>jackson-dataformat-yaml</artifactId>
+                <version>${jackson.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>com.fasterxml.jackson.dataformat</groupId>
+                <artifactId>jackson-dataformat-properties</artifactId>
+                <version>${jackson.version}</version>
+            </dependency>
+
+            <!-- provided -->
+            <dependency>
+                <groupId>org.projectlombok</groupId>
+                <artifactId>lombok</artifactId>
+                <version>${lombok.version}</version>
+                <scope>provided</scope>
+            </dependency>
+
+            <!-- test -->
+            <dependency>
+                <groupId>org.junit.jupiter</groupId>
+                <artifactId>junit-jupiter-api</artifactId>
+                <version>5.5.2</version>
+                <scope>test</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>8</source>
+                    <target>8</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+
+</project>