feat: Jump to 4.0.11

core/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>easyconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <properties>

demo/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>easyconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <properties>
@@ -39,12 +39,6 @@
             <version>${project.parent.version}</version>
             <scope>compile</scope>
         </dependency>
-        <dependency>
-            <groupId>cc.carm.lib</groupId>
-            <artifactId>easyconfiguration-feature-versioned</artifactId>
-            <version>4.0.8</version>
-            <scope>compile</scope>
-        </dependency>
 
     </dependencies>
 

features/commentable/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>cc.carm.lib</groupId>
         <artifactId>easyconfiguration-parent</artifactId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <properties>

features/file/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>cc.carm.lib</groupId>
         <artifactId>easyconfiguration-parent</artifactId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <properties>

features/section/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>cc.carm.lib</groupId>
         <artifactId>easyconfiguration-parent</artifactId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <properties>

features/text/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>cc.carm.lib</groupId>
         <artifactId>easyconfiguration-parent</artifactId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <properties>
@@ -29,7 +29,7 @@
 
         <dependency>
             <groupId>${project.groupId}</groupId>
-            <artifactId>easyconfiguration-yaml</artifactId>
+            <artifactId>easyconfiguration-gson</artifactId>
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>

features/text/src/main/java/cc/carm/lib/configuration/value/text/function/ContentHandler.java

@@ -16,11 +16,12 @@ import java.util.stream.IntStream;
 public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEIVER, SELF>> {
 
     /**
-     * Used to match the message insertion
+     * Used to match the message insertion.
      * <p>
      * format:
      * <br>- to insert parsed line {prefix}#content-id#{offset-above,offset-down}
      * <br>- to insert original line {prefix}@content-id@{offset-above,offset-down}
+     * <br>  original lines will not be parsed
      * <br> example:
      * <ul>
      *     <li>{- }#content-id#{1,1}</li>
@@ -30,6 +31,21 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
     public static final @NotNull Pattern INSERT_PATTERN = Pattern.compile(
             "^(?:\\{(?<prefix>.*)})?(?<type>[#@])(?<id>.*)[#@](?:\\{(?<above>-?\\d+)(?:,(?<down>-?\\d+))?})?$"
     );
+
+    /**
+     * Used to match the message which can be inserted
+     * <p>
+     * format:
+     * <br>- ?[id]Message content
+     * <br> example:
+     * <ul>
+     *     <li>?[click]Click to use this item!</li>
+     * </ul>
+     */
+    public static final @NotNull Pattern ENABLE_PATTERN = Pattern.compile(
+            "^\\?\\[(?<id>.+)](?<content>.*)$"
+    );
+
     public static final @NotNull UnaryOperator<String> DEFAULT_PARAM_BUILDER = s -> "%(" + s + ")";
 
     protected BiFunction<RECEIVER, String, String> parser = (receiver, value) -> value;
@@ -45,7 +61,7 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
     /**
      * Used to store the insertion of the message
      */
-    protected @NotNull Map<String, Function<RECEIVER, List<String>>> insertion = new HashMap<>();
+    protected @NotNull Map<String, @Nullable Function<RECEIVER, List<String>>> insertion = new HashMap<>();
     protected boolean disableInsertion = false;
 
     public abstract SELF self();
@@ -139,6 +155,17 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
         return self();
     }
 
+    /**
+     * Insert the specific contents by the id.
+     *
+     * @param id the id of the insertion text
+     * @return the current {@link ContentHandler} instance
+     */
+    public SELF insert(@NotNull String id) {
+        this.insertion.put(id, null);
+        return self();
+    }
+
     /**
      * Insert the specific contents by the id.
      *
@@ -205,37 +232,50 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
         }
 
         for (String line : contents.lines()) {
-            Matcher matcher = INSERT_PATTERN.matcher(line);
+            Matcher insertMatcher = INSERT_PATTERN.matcher(line);
-            if (!matcher.matches()) {
+            if (insertMatcher.matches()) {
-                lineConsumer.accept(parse(receiver, line));
+                doInsert(insertMatcher, receiver, lineConsumer);
                 continue;
             }
 
-            String id = matcher.group("id");
+            Matcher enableMatcher = ENABLE_PATTERN.matcher(line);
-            List<String> values = Optional.ofNullable(this.insertion.get(id))
+            if (enableMatcher.matches()) {
-                    .map(f -> f.apply(receiver))
+                if (this.insertion.containsKey(enableMatcher.group("id"))) {
-                    .orElse(null);
+                    lineConsumer.accept(parse(receiver, enableMatcher.group("content")));
-            if (values == null || values.isEmpty()) continue;
+                }
-
+                continue;
-            String prefix = matcher.group("prefix");
-            String type = matcher.group("type");
-            boolean original = type.equals("@");
-            int offsetAbove = Optional.ofNullable(matcher.group("above"))
-                    .map(Integer::parseInt).orElse(0);
-            int offsetDown = Optional.ofNullable(matcher.group("down"))
-                    .map(Integer::parseInt).orElse(offsetAbove); // If offsetDown is not set, use offsetAbove
-
-            IntStream.range(0, Math.max(0, offsetAbove)).mapToObj(i -> "").forEach(lineConsumer);
-            String prefixContent = Optional.ofNullable(prefix).map(p -> parse(receiver, p)).orElse("");
-            if (original) {
-                values.stream().map(value -> prefixContent + value).forEach(lineConsumer);
-            } else {
-                values.stream().map(value -> prefixContent + parse(receiver, value)).forEach(lineConsumer);
             }
-            IntStream.range(0, Math.max(0, offsetDown)).mapToObj(i -> "").forEach(lineConsumer);
+
+            lineConsumer.accept(parse(receiver, line));
         }
     }
 
+    private void doInsert(Matcher matcher, @Nullable RECEIVER receiver,
+                          @NotNull Consumer<String> lineConsumer) {
+        String id = matcher.group("id");
+        List<String> values = Optional.ofNullable(this.insertion.get(id))
+                .map(f -> f.apply(receiver))
+                .orElse(null);
+        if (values == null || values.isEmpty()) return; // No values to insert
+
+        String prefix = matcher.group("prefix");
+        String type = matcher.group("type");
+        boolean original = type.equals("@");
+        int offsetAbove = Optional.ofNullable(matcher.group("above"))
+                .map(Integer::parseInt).orElse(0);
+        int offsetDown = Optional.ofNullable(matcher.group("down"))
+                .map(Integer::parseInt).orElse(offsetAbove); // If offsetDown is not set, use offsetAbove
+
+        IntStream.range(0, Math.max(0, offsetAbove)).mapToObj(i -> "").forEach(lineConsumer);
+        String prefixContent = Optional.ofNullable(prefix).map(p -> parse(receiver, p)).orElse("");
+        if (original) {
+            values.stream().map(value -> prefixContent + value).forEach(lineConsumer);
+        } else {
+            values.stream().map(value -> prefixContent + parse(receiver, value)).forEach(lineConsumer);
+        }
+        IntStream.range(0, Math.max(0, offsetDown)).mapToObj(i -> "").forEach(lineConsumer);
+    }
+
     public static String setPlaceholders(@NotNull String messages,
                                          @NotNull Map<String, Object> placeholders) {
         if (messages.isEmpty()) return messages;

features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/ConfigTest.java

@@ -2,10 +2,12 @@ package cc.carm.lib.configuration.value.text.tests;
 
 
 import cc.carm.lib.configuration.source.ConfigurationHolder;
-import cc.carm.lib.configuration.source.yaml.YAMLConfigFactory;
+import cc.carm.lib.configuration.source.json.JSONConfigFactory;
 import cc.carm.lib.configuration.value.text.tests.conf.AppMessages;
 import org.junit.Test;
 
+import java.io.File;
+
 public class ConfigTest {
 
 
@@ -19,7 +21,7 @@ public class ConfigTest {
     @Test
     public void test() {
 
-        ConfigurationHolder<?> holder = YAMLConfigFactory.from("target/messages.yml").build();
+        ConfigurationHolder<?> holder = JSONConfigFactory.from(new File("target/messages.json")).build();
 
         holder.initialize(AppMessages.class);
 

features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/ParseTest.java

@@ -20,7 +20,8 @@ public class ParseTest {
         lines.add("#guidance#");
         lines.add("{- }#websites#{0,1}");
         lines.add("Thanks for your reading!");
-
+        lines.add("?[click]");
+        lines.add("?[click]Click to see more!");
 
         Map<String, List<String>> optional = new HashMap<>();
         optional.put("guidance", Arrays.asList("To get more information for %(name), see:"));
@@ -35,6 +36,7 @@ public class ParseTest {
 
         msg.placeholder("name", "Carm")
                 .insert("guidance")
+                .insert("click")
                 .insert("websites", "Baidu", "Bilibili", "Google");
 
         System.out.println("----------------------------");

features/versioned/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>cc.carm.lib</groupId>
         <artifactId>easyconfiguration-parent</artifactId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <properties>

pom.xml

@@ -15,7 +15,7 @@
     <groupId>cc.carm.lib</groupId>
     <artifactId>easyconfiguration-parent</artifactId>
     <packaging>pom</packaging>
-    <version>4.0.10</version>
+    <version>4.0.11</version>
     <modules>
         <module>core</module>
         <module>features/section</module>
@@ -26,7 +26,7 @@
 
         <module>providers/yaml</module>
         <module>providers/gson</module>
-        <!--        <module>providers/hocon</module>-->
+        <module>providers/hocon</module>
         <module>providers/sql</module>
         <module>providers/mongodb</module>
 

providers/gson/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>easyconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

providers/hocon/pom.xml

@@ -1,12 +1,12 @@
 <?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">
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
         <groupId>cc.carm.lib</groupId>
         <artifactId>easyconfiguration-parent</artifactId>
-        <version>4.0.0</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <properties>

providers/hocon/src/deprecated/hocon/EasyConfiguration.java

@@ -1,36 +0,0 @@
-package cc.carm.lib.configuration;
-
-import cc.carm.lib.configuration.hocon.HOCONFileConfigProvider;
-
-import java.io.File;
-import java.io.IOException;
-
-public class EasyConfiguration {
-
-    private EasyConfiguration() {
-    }
-
-    public static HOCONFileConfigProvider from(File file, String source) {
-        HOCONFileConfigProvider provider = new HOCONFileConfigProvider(file);
-        try {
-            provider.initializeFile(source);
-            provider.initializeConfig();
-        } catch (IOException e) {
-            e.printStackTrace();
-        }
-        return provider;
-    }
-
-    public static HOCONFileConfigProvider from(File file) {
-        return from(file, file.getName());
-    }
-
-    public static HOCONFileConfigProvider from(String fileName) {
-        return from(fileName, fileName);
-    }
-
-    public static HOCONFileConfigProvider from(String fileName, String source) {
-        return from(new File(fileName), source);
-    }
-
-}

providers/hocon/src/deprecated/hocon/HOCONConfigWrapper.java

@@ -1,116 +0,0 @@
-package cc.carm.lib.configuration.hocon;
-
-import cc.carm.lib.configuration.hocon.util.HOCONUtils;
-import com.typesafe.config.*;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-
-import java.util.*;
-
-public class HOCONConfigWrapper implements ConfigurationWrapper<Map<String, Object>> {
-    private static final char SEPARATOR = '.';
-    protected final Map<String, Object> data;
-
-    public HOCONConfigWrapper(ConfigObject config) {
-        this.data = new LinkedHashMap<>();
-
-        config.forEach((key, value) -> {
-            Config cfg = config.toConfig();
-            ConfigValue cv = cfg.getValue(key);
-            if (cv.valueType() == ConfigValueType.OBJECT) {
-                HOCONConfigWrapper.this.data.put(key, new HOCONConfigWrapper((ConfigObject) cv));
-            } else {
-                HOCONConfigWrapper.this.data.put(key, value.unwrapped());
-            }
-        });
-    }
-
-    @Override
-    public @NotNull Map<String, Object> getSource() {
-        return this.data;
-    }
-
-    @Override
-    public @NotNull Set<String> getKeys(boolean deep) {
-        return this.getValues(deep).keySet();
-    }
-
-    @Override
-    public @NotNull Map<String, Object> getValues(boolean deep) {
-        return HOCONUtils.getKeysFromObject(this, deep, "").stream().collect(
-                LinkedHashMap::new,
-                (map, key) -> map.put(key, get(key)),
-                LinkedHashMap::putAll
-        );
-    }
-
-    @Override
-    public void set(@NotNull String path, @Nullable Object value) {
-        if (value instanceof Map) {
-            //noinspection unchecked
-            value = new HOCONConfigWrapper(ConfigFactory.parseMap((Map<String, ?>) value).root());
-        }
-
-        HOCONConfigWrapper section = HOCONUtils.getObjectOn(this, path, SEPARATOR);
-        String simplePath = HOCONUtils.getSimplePath(path, SEPARATOR);
-
-        if (value == null) {
-            section.data.remove(simplePath);
-        } else {
-            section.setDirect(simplePath, value);
-        }
-    }
-
-    /**
-     * 只能设置当前路径下的内容
-     * 避免环回
-     *
-     * @param path 路径
-     */
-    public void setDirect(@NotNull String path, @Nullable Object value) {
-        this.data.put(path, value);
-    }
-
-    @Override
-    public boolean contains(@NotNull String path) {
-        return this.get(path) != null;
-    }
-
-    @Override
-    public @Nullable Object get(@NotNull String path) {
-        HOCONConfigWrapper section = HOCONUtils.getObjectOn(this, path, SEPARATOR);
-        return section.getDirect(HOCONUtils.getSimplePath(path, SEPARATOR));
-    }
-
-    /**
-     * 只能获取当前路径下的内容
-     * 避免环回
-     *
-     * @param path 路径
-     */
-    public Object getDirect(@NotNull String path) {
-        return this.data.get(path);
-    }
-
-    @Override
-    public boolean isList(@NotNull String path) {
-        return this.get(path) instanceof List<?>;
-    }
-
-    @Override
-    public @Nullable List<?> getList(@NotNull String path) {
-        Object val = this.get(path);
-        return (val instanceof List<?>) ? (List<?>) val : null;
-    }
-
-    @Override
-    public boolean isConfigurationSection(@NotNull String path) {
-        return this.get(path) instanceof HOCONConfigWrapper;
-    }
-
-    @Override
-    public @Nullable ConfigurationWrapper<Map<String, Object>> getConfigurationSection(@NotNull String path) {
-        Object val = get(path);
-        return (val instanceof HOCONConfigWrapper) ? (HOCONConfigWrapper) val : null;
-    }
-}

providers/hocon/src/deprecated/hocon/HOCONFileConfigProvider.java

@@ -1,105 +0,0 @@
-package cc.carm.lib.configuration.hocon;
-
-import cc.carm.lib.configuration.source.comment.ConfigurationComments;
-import cc.carm.lib.configuration.core.source.impl.FileConfigProvider;
-import cc.carm.lib.configuration.hocon.exception.HOCONGetValueException;
-import cc.carm.lib.configuration.hocon.util.HOCONUtils;
-import com.typesafe.config.*;
-import org.jetbrains.annotations.Contract;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-
-import java.io.File;
-import java.io.IOException;
-import java.nio.charset.StandardCharsets;
-import java.nio.file.Files;
-import java.util.List;
-import java.util.Set;
-
-public class HOCONFileConfigProvider extends FileConfigProvider<HOCONConfigWrapper> {
-    protected final @NotNull ConfigurationComments comments = new ConfigurationComments();
-    protected HOCONConfigWrapper configuration;
-    protected ConfigInitializer<HOCONFileConfigProvider> initializer;
-
-    public HOCONFileConfigProvider(@NotNull File file) {
-        super(file);
-        this.initializer = new ConfigInitializer<>(this);
-    }
-
-    public void initializeConfig() {
-        try {
-            this.configuration = new HOCONConfigWrapper(ConfigFactory.parseFile(this.file, ConfigParseOptions.defaults()
-                    .setSyntax(ConfigSyntax.CONF)
-                    .setAllowMissing(false)).root());
-        } catch (ConfigException e) {
-            e.printStackTrace();
-        }
-    }
-
-    @Override
-    public @NotNull HOCONConfigWrapper getConfiguration() {
-        return this.configuration;
-    }
-
-    @Override
-    public void save() throws IOException {
-        Files.write(this.file.toPath(), HOCONUtils.renderWithComment(configuration, comments::getHeaderComment).getBytes(StandardCharsets.UTF_8));
-    }
-
-    @Override
-    protected void onReload() throws ConfigException {
-        ConfigObject conf = ConfigFactory.parseFile(this.file, ConfigParseOptions.defaults()
-                .setSyntax(ConfigSyntax.CONF)
-                .setAllowMissing(false)).root();
-        this.configuration = new HOCONConfigWrapper(conf);
-    }
-
-    @Override
-    public @NotNull ConfigurationComments getComments() {
-        return this.comments;
-    }
-
-    @Override
-    public @NotNull ConfigInitializer<HOCONFileConfigProvider> getInitializer() {
-        return this.initializer;
-    }
-
-    public String serializeValue(@NotNull String key, @NotNull Object value) {
-        // 带有 key=value 的新空对象
-        return ConfigFactory.empty()
-                .withValue(key, ConfigValueFactory.fromAnyRef(value))
-                .root().render();
-    }
-
-    public @NotNull Set<String> getKeys() {
-        return getKeys(null, true);
-    }
-
-    @Contract("null,_->!null")
-    public @Nullable Set<String> getKeys(@Nullable String sectionKey, boolean deep) {
-        if (sectionKey == null) { // 当前路径
-            return HOCONUtils.getKeysFromObject(this.configuration, deep, "");
-        }
-
-        HOCONConfigWrapper section;
-        try {
-            // 获取目标字段所在路径
-            section = (HOCONConfigWrapper) this.configuration.get(sectionKey);
-        } catch (ClassCastException e) {
-            // 值和类型不匹配
-            throw new HOCONGetValueException(e);
-        }
-        if (section == null) {
-            return null;
-        }
-        return HOCONUtils.getKeysFromObject(section, deep, "");
-    }
-
-    public @Nullable Object getValue(@NotNull String key) {
-        return this.configuration.get(key);
-    }
-
-    public @Nullable List<String> getHeaderComments(@Nullable String key) {
-        return this.comments.getHeaderComment(key);
-    }
-}

providers/hocon/src/deprecated/hocon/exception/HOCONGetValueException.java

@@ -1,19 +0,0 @@
-package cc.carm.lib.configuration.hocon.exception;
-
-public class HOCONGetValueException extends RuntimeException {
-    public HOCONGetValueException() {
-        super();
-    }
-
-    public HOCONGetValueException(String message) {
-        super(message);
-    }
-
-    public HOCONGetValueException(String message, Throwable cause) {
-        super(message, cause);
-    }
-
-    public HOCONGetValueException(Throwable cause) {
-        super(cause);
-    }
-}

providers/hocon/src/deprecated/hocon/util/HOCONUtils.java

@@ -1,110 +0,0 @@
-package cc.carm.lib.configuration.hocon.util;
-
-import cc.carm.lib.configuration.hocon.HOCONConfigWrapper;
-import cc.carm.lib.configuration.hocon.exception.HOCONGetValueException;
-import com.typesafe.config.*;
-import org.jetbrains.annotations.NotNull;
-
-import java.util.LinkedHashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.function.Function;
-
-public class HOCONUtils {
-
-    private HOCONUtils() {
-    }
-
-    public static String getSimplePath(String path, char separator) {
-        int index = path.lastIndexOf(separator);
-        return (index == -1) ? path : path.substring(index + 1);
-    }
-
-    public static HOCONConfigWrapper getObjectOn(@NotNull HOCONConfigWrapper parent, @NotNull String path, char separator) {
-        String currentPath = path;
-        HOCONConfigWrapper currentObject = parent;
-        int index;
-        while ((index = currentPath.indexOf(separator)) != -1) {
-            HOCONConfigWrapper previousObject = currentObject;
-            String pathName = currentPath.substring(0, index);
-            try {
-                currentObject = (HOCONConfigWrapper) previousObject.getDirect(pathName);
-            } catch (ClassCastException e) {
-                throw new HOCONGetValueException(e);
-            }
-            if (currentObject == null) {
-                currentObject = new HOCONConfigWrapper(ConfigFactory.empty().root());
-                previousObject.setDirect(pathName, currentObject);
-            }
-            currentPath = currentPath.substring(index + 1);
-        }
-
-        return currentObject;
-    }
-
-    /**
-     * 在 Object 中获取所有键
-     * 思路：在第一次执行时 prefix 应该是 ""
-     * 后续找到了更深层的键，将会变为 "deep."
-     * 下一次键名就是 "deep.key"
-     *
-     * @param parent Object
-     * @param deep   是否更深层获取
-     * @param prefix 当前 Object 键名前缀
-     * @return Object 中的所有键
-     */
-    public static Set<String> getKeysFromObject(HOCONConfigWrapper parent, boolean deep, String prefix) {
-        return parent.getSource().entrySet().stream().collect(
-                LinkedHashSet::new,
-                (set, entry) -> {
-                    Object value = entry.getValue();
-                    if (value instanceof HOCONConfigWrapper && deep) {
-                        set.addAll(HOCONUtils.getKeysFromObject((HOCONConfigWrapper) value, true, prefix + entry.getKey() + "."));
-                    } else {
-                        set.add(prefix + entry.getKey());
-                    }
-                },
-                LinkedHashSet::addAll
-        );
-    }
-
-    /**
-     * 将 Object 保存为字符串
-     * 并使用注释器打上注释
-     *
-     * @param object    Object
-     * @param commenter 注释器
-     * @return 保存的字符串
-     */
-    public static @NotNull String renderWithComment(@NotNull HOCONConfigWrapper object, @NotNull Function<String, List<String>> commenter) {
-        return HOCONUtils.makeConfigWithComment(object, "", commenter).root().render(
-                ConfigRenderOptions.defaults()
-                        .setJson(false)
-                        .setOriginComments(false)
-        );
-    }
-
-    public static @NotNull Config makeConfigWithComment(@NotNull HOCONConfigWrapper object, @NotNull String prefix, @NotNull Function<String, List<String>> commenter) {
-        Config config = ConfigFactory.empty();
-        for (Map.Entry<String, Object> entry : object.getSource().entrySet()) {
-            String key = entry.getKey();
-            String fullKey = prefix + key;
-            Object value = entry.getValue();
-            ConfigValue result;
-            if (value instanceof Iterable) {
-                result = ConfigValueFactory.fromIterable((Iterable<?>) value);
-            } else if (value instanceof HOCONConfigWrapper) {
-                result = makeConfigWithComment((HOCONConfigWrapper) value, fullKey + ".", commenter).root();
-            } else {
-                result = ConfigValueFactory.fromAnyRef(value);
-            }
-            result = result.withOrigin(
-                    ConfigOriginFactory.newSimple()
-                            .withComments(commenter.apply(fullKey))
-            );
-            config = config.withValue(key, result);
-        }
-        return config;
-    }
-}

providers/hocon/src/main/java/cc/carm/lib/configuration/source/hocon/HOCONConfigFactory.java

@@ -0,0 +1,48 @@
+package cc.carm.lib.configuration.source.hocon;
+
+import cc.carm.lib.configuration.commentable.Commentable;
+import cc.carm.lib.configuration.source.ConfigurationHolder;
+import cc.carm.lib.configuration.source.file.FileConfigFactory;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.File;
+
+public class HOCONConfigFactory extends FileConfigFactory<HOCONSource, ConfigurationHolder<HOCONSource>, HOCONConfigFactory> {
+    public static HOCONConfigFactory from(@NotNull String path) {
+        return new HOCONConfigFactory(new File(path));
+    }
+
+    public static HOCONConfigFactory from(@NotNull File file) {
+        return new HOCONConfigFactory(file);
+    }
+
+    public static HOCONConfigFactory from(@NotNull File parent, @NotNull String configName) {
+        return new HOCONConfigFactory(new File(parent, configName));
+    }
+
+    public HOCONConfigFactory(@NotNull File file) {
+        super(file);
+    }
+
+    @Override
+    protected HOCONConfigFactory self() {
+        return this;
+    }
+
+    @Override
+    public @NotNull ConfigurationHolder<HOCONSource> build() {
+        File configFile = this.file;
+        String sourcePath = this.resourcePath;
+
+        Commentable.registerMeta(this.initializer); // Register commentable meta types
+
+        return new ConfigurationHolder<HOCONSource>(this.adapters, this.options, this.metadata, this.initializer) {
+            final @NotNull HOCONSource source = new HOCONSource(this, configFile, sourcePath);
+
+            @Override
+            public @NotNull HOCONSource config() {
+                return this.source;
+            }
+        };
+    }
+}

providers/hocon/src/main/java/cc/carm/lib/configuration/source/hocon/HOCONSection.java

@@ -1,69 +0,0 @@
-package cc.carm.lib.configuration.source.hocon;
-
-import cc.carm.lib.configuration.source.section.ConfigureSection;
-import com.typesafe.config.Config;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-import org.jetbrains.annotations.UnmodifiableView;
-
-import java.util.List;
-import java.util.Map;
-
-public class HOCONSection implements ConfigureSection {
-
-    protected final @NotNull HOCONSource source;
-    protected final @Nullable HOCONSection parent;
-    protected final @NotNull Config data;
-
-    public HOCONSection(@NotNull HOCONSource source, @Nullable HOCONSection parent,
-                        @NotNull Config data) {
-        this.source = source;
-        this.parent = parent;
-        this.data = data;
-    }
-
-    public @NotNull Config data() {
-        return this.data;
-    }
-
-    @Override
-    public @NotNull HOCONSource source() {
-        return this.source;
-    }
-
-    @Override
-    public @Nullable HOCONSection parent() {
-        return this.parent;
-    }
-
-    @Override
-    public @NotNull @UnmodifiableView Map<String, Object> getValues(boolean deep) {
-        return data().root().unwrapped();
-    }
-
-    @Override
-    public void set(@NotNull String path, @Nullable Object value) {
-
-    }
-
-    @Override
-    public boolean contains(@NotNull String path) {
-        return data().hasPath(path);
-    }
-
-    @Override
-    public @Nullable List<?> getList(@NotNull String path) {
-        return data().getAnyRefList(path);
-    }
-
-    @Override
-    public @Nullable HOCONSection getSection(@NotNull String path) {
-        return data().getConfig(path) == null ? null : new HOCONSection(source, this, data().getConfig(path));
-    }
-
-    @Override
-    public @Nullable Object get(@NotNull String path) {
-        return data().getAnyRef(path);
-    }
-
-}

providers/hocon/src/main/java/cc/carm/lib/configuration/source/hocon/HOCONSource.java

@@ -1,44 +1,104 @@
 package cc.carm.lib.configuration.source.hocon;
 
+import cc.carm.lib.configuration.commentable.Commentable;
 import cc.carm.lib.configuration.source.ConfigurationHolder;
-import cc.carm.lib.configuration.source.section.ConfigureSource;
+import cc.carm.lib.configuration.source.file.FileConfigSource;
-import com.typesafe.config.Config;
+import cc.carm.lib.configuration.source.section.SourcedSection;
+import com.typesafe.config.*;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
-import java.util.Objects;
+import java.io.File;
+import java.util.*;
 
-public class HOCONSource extends ConfigureSource<HOCONSection, Config, HOCONSource> {
+public class HOCONSource
+        extends FileConfigSource<SourcedSection, Map<String, Object>, HOCONSource> {
+    protected @Nullable SourcedSection rootSection;
 
+    protected HOCONSource(
+            @NotNull ConfigurationHolder<? extends HOCONSource> holder,
+            @NotNull File file, @Nullable String resourcePath
+    ) {
+        super(holder, 0, file, resourcePath);
 
-    private HOCONSection rootSection;
+        this.initialize();
+    }
 
-    protected HOCONSource(@NotNull ConfigurationHolder<? extends HOCONSource> holder, long lastUpdateMillis) {
+    public void initialize() {
-        super(holder, lastUpdateMillis);
+        try {
+            this.initializeFile();
+            this.onReload();
+        } catch (Exception e) {
+            //noinspection CallToPrintStackTrace
+            e.printStackTrace();
+        }
     }
 
     @Override
-    protected HOCONSource self() {
+    protected @NotNull HOCONSource self() {
         return this;
     }
 
     @Override
-    public @NotNull Config original() {
+    public @NotNull Map<String, Object> original() {
-        return section().data();
+        return this.section().data();
     }
 
     @Override
-    public @NotNull HOCONSection section() {
+    public @NotNull SourcedSection section() {
-        return Objects.requireNonNull(rootSection, "RootSection is not initialized");
+        return Objects.requireNonNull(this.rootSection, "Root section is not initialized.");
+    }
+
+    public @NotNull String saveToString() {
+        // identity: 创建新的空 typesafe config
+        // accumulator: 将 Section 中的信息为 typesafe config 添加并返回
+        // combiner: 合并两个配置文件
+        Config config = this.getValues(true).entrySet().stream().reduce(
+                ConfigFactory.empty(),
+                (cfg, entry) -> {
+                    String key = entry.getKey(); // 源数据 key
+                    Object value = entry.getValue(); // 源数据 value
+
+                    ConfigValue result; // 最终转换为 typesafe 的 ConfigValue 类型
+                    if (value == null || value instanceof Boolean || value instanceof String || value instanceof Number) {
+                        result = ConfigValueFactory.fromAnyRef(value); // 原始数据类型
+                    } else if (value instanceof Iterator) {
+                        result = ConfigValueFactory.fromIterable((Iterable<?>) value);
+                    } else if (value instanceof Map) {
+                        //noinspection unchecked
+                        result = ConfigValueFactory.fromMap((Map<String, ?>) value);
+                    } else {
+                        result = ConfigValueFactory.fromAnyRef(String.valueOf(value));
+                    }
+                    List<String> headerComments = HOCONSource.this.getHeaderComments(key); // 获取其注释
+                    result = result.withOrigin(result.origin().withComments(headerComments)); // 赋予其注释
+                    return cfg.withValue(key, result); // 将其添加到根 config 中
+                },
+                Config::withFallback
+        );
+        return config.root().render(
+                ConfigRenderOptions.defaults()
+                        .setJson(false)
+                        .setOriginComments(false)
+        );
     }
 
     @Override
     public void save() throws Exception {
-
+        this.fileWriter(w -> w.write(HOCONSource.this.saveToString()));
     }
 
     @Override
     protected void onReload() throws Exception {
-
+        this.rootSection = this.fileReadString(this::loadFromString);
     }
 
+    protected @NotNull SourcedSection loadFromString(@NotNull String data) {
+        ConfigObject config = ConfigFactory.parseString(data).root();
+        return SourcedSection.root(this, config.unwrapped());
+    }
+
+    public @Nullable List<String> getHeaderComments(@Nullable String key) {
+        return Commentable.getHeaderComments(holder(), key);
+    }
 }

providers/hocon/src/test/java/online/flowerinsnow/test/easyconfiguration/HOCONTest.java

@@ -1,18 +0,0 @@
-package online.flowerinsnow.test.easyconfiguration;
-
-public class HOCONTest {
-//    @Test
-//    public void onTest() {
-//        HOCONFileConfigProvider provider = EasyConfiguration.from(new File("target/hocon.conf"));
-//
-//        ConfigurationTest.testDemo(provider);
-//        ConfigurationTest.testInner(provider);
-//
-//        try {
-//            provider.save();
-//            provider.reload();
-//        } catch (Exception e) {
-//            e.printStackTrace();
-//        }
-//    }
-}

providers/hocon/src/test/java/sample/SampleConfig.java

@@ -0,0 +1,38 @@
+package sample;
+
+import cc.carm.lib.configuration.Configuration;
+import cc.carm.lib.configuration.annotation.ConfigPath;
+import cc.carm.lib.configuration.annotation.HeaderComments;
+import cc.carm.lib.configuration.value.standard.ConfiguredList;
+import cc.carm.lib.configuration.value.standard.ConfiguredValue;
+
+import java.util.UUID;
+
+@ConfigPath(root = true)
+@HeaderComments("Configurations for sample")
+public interface SampleConfig extends Configuration {
+    ConfiguredValue<Boolean> ENABLED = ConfiguredValue.of(true);
+
+    @HeaderComments("Server configurations") // Header comment
+    ConfiguredValue<Integer> PORT = ConfiguredValue.of(Integer.class);
+
+    @HeaderComments({"[ UUID >-----------------------------------", "A lot of UUIDs"})
+    ConfiguredList<UUID> UUIDS = ConfiguredList.builderOf(UUID.class).fromString()
+            .parse(UUID::fromString).serialize(UUID::toString)
+            .defaults(
+                    UUID.fromString("00000000-0000-0000-0000-000000000000"),
+                    UUID.fromString("00000000-0000-0000-0000-000000000001")
+            ).build();
+
+    @ConfigPath("info") // Custom path
+    interface INFO extends Configuration {
+
+        @HeaderComments("Configure your name!") // Header comment
+        ConfiguredValue<String> NAME = ConfiguredValue.of("Joker");
+
+        @ConfigPath("how-old-are-you") // Custom path
+        ConfiguredValue<Integer> AGE = ConfiguredValue.of(24);
+
+    }
+
+}

providers/hocon/src/test/java/sample/SampleTest.java

@@ -0,0 +1,27 @@
+package sample;
+
+import cc.carm.lib.configuration.source.ConfigurationHolder;
+import cc.carm.lib.configuration.source.hocon.HOCONConfigFactory;
+import org.junit.Test;
+
+public class  SampleTest {
+
+    @Test
+    public void test() {
+        // 1. Make a configuration provider from a file.
+        ConfigurationHolder<?> holder = HOCONConfigFactory.from("target/config.conf")
+                .resourcePath("configs/sample.conf")
+                .build();
+
+        // 2. Initialize the configuration classes or instances.
+        holder.initialize(SampleConfig.class);
+        // 3. Enjoy using the configuration!
+        System.out.println("Enabled? -> " + SampleConfig.ENABLED.resolve());
+        SampleConfig.ENABLED.set(false);
+        System.out.println("And now? -> " + SampleConfig.ENABLED.resolve());
+        // p.s. Changes not save so enable value will still be true in the next run.
+
+        System.out.println("Your name is " + SampleConfig.INFO.NAME.resolve() + " (age=" + SampleConfig.INFO.AGE.resolve() + ")!");
+    }
+
+}

providers/hocon/src/test/resources/configs/sample.conf

@@ -0,0 +1,2 @@
+version = 1.0
+test-save = false

providers/mongodb/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>easyconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

providers/sql/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <artifactId>easyconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <properties>

providers/sql/src/main/java/cc/carm/lib/configuration/source/sql/SQLConfigFactory.java

@@ -7,12 +7,17 @@ import cc.carm.lib.configuration.source.ConfigurationFactory;
 import cc.carm.lib.configuration.source.ConfigurationHolder;
 import cc.carm.lib.configuration.versioned.VersionedMetaTypes;
 import cc.carm.lib.easysql.api.SQLManager;
+import cc.carm.lib.easysql.api.SQLTable;
+import cc.carm.lib.easysql.api.builder.TableCreateBuilder;
+import cc.carm.lib.easysql.api.enums.IndexType;
+import cc.carm.lib.easysql.api.function.SQLHandler;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Range;
 
 import java.util.HashMap;
+import java.util.function.BiConsumer;
 import java.util.function.Consumer;
 import java.util.function.Supplier;
 
@@ -26,11 +31,43 @@ public class SQLConfigFactory extends ConfigurationFactory<SQLSource, Configurat
         return from(() -> manager);
     }
 
+    protected static final @NotNull Gson DEFAULT_GSON = new GsonBuilder()
+            .serializeNulls().disableHtmlEscaping().create();
+
+    protected static final @NotNull BiConsumer<String, TableCreateBuilder> DEFAULT_TABLE_SCHEMA = (tableName, builder) -> {
+        builder.addColumn("namespace", "VARCHAR(32) NOT NULL");
+        builder.addColumn("path", "VARCHAR(96) NOT NULL");
+
+        builder.addColumn("value", "TEXT");
+
+        builder.addColumn("inline_comment", "TEXT");
+        builder.addColumn("header_comments", "MEDIUMTEXT");
+        builder.addColumn("footer_comments", "MEDIUMTEXT");
+
+        builder.addColumn("type", "TINYINT NOT NULL DEFAULT 0");
+        builder.addColumn("version", "MEDIUMINT UNSIGNED NOT NULL DEFAULT 0");
+
+        builder.addColumn(
+                "create_time",
+                "TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP"
+        );
+        builder.addColumn(
+                "update_time",
+                "TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP"
+        );
+
+        builder.setIndex(
+                IndexType.PRIMARY_KEY, "pk_" + tableName.toLowerCase(),
+                "namespace", "path"
+        );
+        builder.setTableSettings("ENGINE=InnoDB DEFAULT CHARSET=utf8mb4");
+    };
+
     protected @NotNull Supplier<SQLManager> managerSupplier;
-    protected Supplier<Gson> gsonSupplier = () -> SQLSource.DEFAULT_GSON;
+    protected Supplier<Gson> gsonSupplier = () -> DEFAULT_GSON;
 
     protected HashMap<Integer, SQLValueResolver<?>> resolvers = new HashMap<>(SQLValueResolver.STANDARD_RESOLVERS);
-    protected String tableName = "configs";
+    protected SQLTable tableName = SQLTable.of("config", (table) -> DEFAULT_TABLE_SCHEMA.accept("config", table));
     protected String namespace = "default";
 
     public SQLConfigFactory(@NotNull Supplier<SQLManager> managerSupplier) {
@@ -95,11 +132,19 @@ public class SQLConfigFactory extends ConfigurationFactory<SQLSource, Configurat
         return resolver(id, SQLValueResolver.of(type, parser, serializer));
     }
 
-    public SQLConfigFactory tableName(@NotNull String tableName) {
+    public SQLConfigFactory table(@NotNull SQLTable table) {
-        this.tableName = tableName;
+        this.tableName = table;
         return self();
     }
 
+    public SQLConfigFactory table(@NotNull String tableName, @NotNull SQLHandler<TableCreateBuilder> builder) {
+        return table(SQLTable.of(tableName, builder));
+    }
+
+    public SQLConfigFactory tableName(@NotNull String tableName) {
+        return table(tableName, table -> DEFAULT_TABLE_SCHEMA.accept(tableName, table));
+    }
+
     public SQLConfigFactory namespace(@NotNull String namespace) {
         this.namespace = namespace;
         return self();

providers/sql/src/main/java/cc/carm/lib/configuration/source/sql/SQLSource.java

@@ -9,9 +9,7 @@ import cc.carm.lib.configuration.versioned.VersionedMetaTypes;
 import cc.carm.lib.easysql.api.SQLManager;
 import cc.carm.lib.easysql.api.SQLQuery;
 import cc.carm.lib.easysql.api.SQLTable;
-import cc.carm.lib.easysql.api.enums.IndexType;
 import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -21,9 +19,6 @@ import java.util.*;
 
 public class SQLSource extends ConfigureSource<SourcedSection, Map<String, Object>, SQLSource> {
 
-    protected static final @NotNull Gson DEFAULT_GSON = new GsonBuilder()
-            .serializeNulls().disableHtmlEscaping().create();
-
     protected final @NotNull Gson gson;
     protected final @NotNull SQLManager sqlManager;
     protected final @NotNull String namespace;
@@ -35,41 +30,13 @@ public class SQLSource extends ConfigureSource<SourcedSection, Map<String, Objec
     public SQLSource(@NotNull ConfigurationHolder<? extends SQLSource> holder, long lastUpdateMillis,
                      @NotNull Gson gson, @NotNull SQLManager sqlManager,
                      @NotNull Map<Integer, SQLValueResolver<?>> resolvers,
-                     @NotNull String tableName, @NotNull String namespace) {
+                     @NotNull SQLTable table, @NotNull String namespace) {
         super(holder, lastUpdateMillis);
         this.gson = gson;
         this.sqlManager = sqlManager;
         this.resolvers = resolvers;
         this.namespace = namespace;
-        this.table = SQLTable.of(tableName, builder -> {
+        this.table = table;
-
-            builder.addColumn("namespace", "VARCHAR(32) NOT NULL");
-            builder.addColumn("path", "VARCHAR(96) NOT NULL");
-
-            builder.addColumn("value", "TEXT");
-
-            builder.addColumn("inline_comment", "TEXT");
-            builder.addColumn("header_comments", "MEDIUMTEXT");
-            builder.addColumn("footer_comments", "MEDIUMTEXT");
-
-            builder.addColumn("type", "TINYINT NOT NULL DEFAULT 0");
-            builder.addColumn("version", "MEDIUMINT UNSIGNED NOT NULL DEFAULT 0");
-
-            builder.addColumn(
-                    "create_time",
-                    "TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP"
-            );
-            builder.addColumn(
-                    "update_time",
-                    "TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP"
-            );
-
-            builder.setIndex(
-                    IndexType.PRIMARY_KEY, "pk_" + tableName.toLowerCase(),
-                    "namespace", "path"
-            );
-            builder.setTableSettings("ENGINE=InnoDB DEFAULT CHARSET=utf8mb4");
-        });
 
         try {
             this.table.create(this.sqlManager);

providers/yaml/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <artifactId>easyconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>4.0.10</version>
+        <version>4.0.11</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <properties>