[1.1.0] 实现 ConfigurationSerializable 相关数据的加载、获取与写入。

impl/yaml/pom.xml

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

impl/yaml/src/main/java/cc/carm/lib/configuration/yaml/YAMLValue.java

@@ -0,0 +1,32 @@
+package cc.carm.lib.configuration.yaml;
+
+import cc.carm.lib.configuration.core.source.ConfigurationProvider;
+import cc.carm.lib.configuration.core.value.impl.CachedConfigValue;
+import cc.carm.lib.configuration.yaml.YamlConfigProvider;
+import cc.carm.lib.configuration.yaml.YamlSectionWrapper;
+import cc.carm.lib.configuration.yaml.builder.YamlConfigBuilder;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public abstract class YAMLValue<T> extends CachedConfigValue<T> {
+
+    public static @NotNull YamlConfigBuilder builder() {
+        return new YamlConfigBuilder();
+    }
+
+    public YAMLValue(@Nullable YamlConfigProvider provider,
+                     @Nullable String configPath, @NotNull String[] comments, @Nullable T defaultValue) {
+        super(provider, configPath, comments, defaultValue);
+    }
+
+    public YamlConfigProvider getYAMLProvider() {
+        ConfigurationProvider<?> provider = getProvider();
+        if (provider instanceof YamlConfigProvider) return (YamlConfigProvider) getProvider();
+        else throw new IllegalStateException("Provider is not a SpigotConfigProvider");
+    }
+
+    public YamlSectionWrapper getYAMLConfig() {
+        return getYAMLProvider().getConfiguration();
+    }
+
+}

impl/yaml/src/main/java/cc/carm/lib/configuration/yaml/YamlConfigProvider.java

@@ -1,6 +1,6 @@
 package cc.carm.lib.configuration.yaml;
 
-import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
+import cc.carm.lib.configuration.core.ConfigInitializer;
 import cc.carm.lib.configuration.core.source.impl.FileConfigProvider;
 import org.bspfsystems.yamlconfiguration.commented.CommentedYamlConfiguration;
 import org.jetbrains.annotations.NotNull;
@@ -8,10 +8,11 @@ import org.jetbrains.annotations.Nullable;
 
 import java.io.File;
 
-public class YamlConfigProvider extends FileConfigProvider {
+public class YamlConfigProvider extends FileConfigProvider<YamlSectionWrapper> {
 
-    YamlComments comments = new YamlComments();
-    CommentedYamlConfiguration configuration;
+    protected final @NotNull YamlComments comments = new YamlComments();
+    protected CommentedYamlConfiguration configuration;
+    protected ConfigInitializer<YamlConfigProvider> initializer;
 
     public YamlConfigProvider(@NotNull File file) {
         super(file);
@@ -19,10 +20,11 @@ public class YamlConfigProvider extends FileConfigProvider {
 
     public void initializeConfig() {
         this.configuration = CommentedYamlConfiguration.loadConfiguration(comments, file);
+        this.initializer = new ConfigInitializer<>(this);
     }
 
     @Override
-    public @NotNull ConfigurationWrapper getConfiguration() {
+    public @NotNull YamlSectionWrapper getConfiguration() {
         return YamlSectionWrapper.of(configuration);
     }
 
@@ -46,4 +48,9 @@ public class YamlConfigProvider extends FileConfigProvider {
         return this.comments.get(path);
     }
 
+    @Override
+    public @NotNull ConfigInitializer<YamlConfigProvider> getInitializer() {
+        return this.initializer;
+    }
+
 }

impl/yaml/src/main/java/cc/carm/lib/configuration/yaml/YamlSectionWrapper.java

@@ -2,6 +2,7 @@ package cc.carm.lib.configuration.yaml;
 
 import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
 import org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -68,4 +69,16 @@ public class YamlSectionWrapper implements ConfigurationWrapper {
     public @Nullable ConfigurationWrapper getConfigurationSection(@NotNull String path) {
         return of(this.section.getConfigurationSection(path));
     }
+
+    @Nullable
+    public <T extends ConfigurationSerializable> T getSerializable(@NotNull String path, @NotNull Class<T> clazz) {
+        return getSerializable(path, clazz, null);
+    }
+
+    @Nullable
+    @Contract("_, _, !null -> !null")
+    public <T extends ConfigurationSerializable> T getSerializable(@NotNull String path, @NotNull Class<T> clazz, @Nullable T defaultValue) {
+        return this.section.getSerializable(path, clazz, defaultValue);
+    }
+    
 }

impl/yaml/src/main/java/cc/carm/lib/configuration/yaml/builder/AbstractYAMLBuilder.java

@@ -0,0 +1,13 @@
+package cc.carm.lib.configuration.yaml.builder;
+
+import cc.carm.lib.configuration.core.builder.AbstractConfigBuilder;
+import cc.carm.lib.configuration.yaml.YamlConfigProvider;
+
+public abstract class AbstractYAMLBuilder<T, B extends AbstractYAMLBuilder<T, B>>
+        extends AbstractConfigBuilder<T, B, YamlConfigProvider> {
+
+    public AbstractYAMLBuilder() {
+        super(YamlConfigProvider.class);
+    }
+
+}

impl/yaml/src/main/java/cc/carm/lib/configuration/yaml/builder/YamlConfigBuilder.java

@@ -0,0 +1,14 @@
+package cc.carm.lib.configuration.yaml.builder;
+
+import cc.carm.lib.configuration.core.builder.ConfigBuilder;
+import cc.carm.lib.configuration.yaml.builder.serializable.SerializableBuilder;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.jetbrains.annotations.NotNull;
+
+public class YamlConfigBuilder extends ConfigBuilder {
+
+    public <V extends ConfigurationSerializable> @NotNull SerializableBuilder<V> ofSerializable(@NotNull Class<V> valueClass) {
+        return new SerializableBuilder<>(valueClass);
+    }
+
+}

impl/yaml/src/main/java/cc/carm/lib/configuration/yaml/builder/serializable/SerializableBuilder.java

@@ -0,0 +1,29 @@
+package cc.carm.lib.configuration.yaml.builder.serializable;
+
+import cc.carm.lib.configuration.yaml.builder.AbstractYAMLBuilder;
+import cc.carm.lib.configuration.yaml.value.ConfiguredSerializable;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.jetbrains.annotations.NotNull;
+
+public class SerializableBuilder<T extends ConfigurationSerializable>
+        extends AbstractYAMLBuilder<T, SerializableBuilder<T>> {
+
+    protected final @NotNull Class<T> valueClass;
+
+    public SerializableBuilder(@NotNull Class<T> valueClass) {
+        this.valueClass = valueClass;
+    }
+
+    @Override
+    protected @NotNull SerializableBuilder<T> getThis() {
+        return this;
+    }
+
+    @Override
+    public @NotNull ConfiguredSerializable<T> build() {
+        return new ConfiguredSerializable<>(this.provider, this.path, this.comments, this.valueClass, this.defaultValue);
+    }
+
+
+}
+

impl/yaml/src/main/java/cc/carm/lib/configuration/yaml/value/ConfiguredSerializable.java

@@ -0,0 +1,52 @@
+package cc.carm.lib.configuration.yaml.value;
+
+import cc.carm.lib.configuration.yaml.YAMLValue;
+import cc.carm.lib.configuration.yaml.YamlConfigProvider;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Optional;
+
+public class ConfiguredSerializable<T extends ConfigurationSerializable> extends YAMLValue<T> {
+
+    public static <V extends ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull Class<V> valueClass) {
+        return of(valueClass, null);
+    }
+
+    public static <V extends ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull Class<V> valueClass,
+                                                                                     @Nullable V defaultValue) {
+        return builder().ofSerializable(valueClass).defaults(defaultValue).build();
+    }
+
+    protected final @NotNull Class<T> valueClass;
+
+    public ConfiguredSerializable(@Nullable YamlConfigProvider provider,
+                                  @Nullable String configPath, @NotNull String[] comments,
+                                  @NotNull Class<T> valueClass, @Nullable T defaultValue) {
+        super(provider, configPath, comments, defaultValue);
+        this.valueClass = valueClass;
+    }
+
+    @Override
+    public @Nullable T get() {
+        if (isExpired()) { // 已过时的数据，需要重新解析一次。
+            try {
+                // 若未出现错误，则直接更新缓存并返回。
+                return updateCache(getYAMLConfig().getSerializable(getConfigPath(), valueClass, getDefaultValue()));
+            } catch (Exception e) {
+                // 出现了解析错误，提示并返回默认值。
+                e.printStackTrace();
+                return useDefault();
+            }
+        } else return Optional.ofNullable(getCachedValue()).orElse(defaultValue);
+    }
+
+    @Override
+    public void set(@Nullable T value) {
+        updateCache(value);
+        setValue(value);
+    }
+
+
+}

impl/yaml/src/test/java/config/ConfigTester.java

@@ -2,9 +2,11 @@ package config;
 
 import cc.carm.lib.configuration.EasyConfiguration;
 import cc.carm.lib.configuration.yaml.YamlConfigProvider;
-import config.misc.TestUser;
-import config.source.DemoConfiguration;
+import config.model.TestModel;
 import config.source.ComplexConfiguration;
+import config.source.DemoConfiguration;
+import config.source.ImplConfiguration;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization;
 import org.junit.Test;
 
 import java.util.LinkedHashMap;
@@ -15,32 +17,16 @@ import java.util.stream.IntStream;
 
 public class ConfigTester {
 
+
     @Test
     public void onTest() {
+        ConfigurationSerialization.registerClass(TestModel.class);
 
         YamlConfigProvider provider = EasyConfiguration.from("target/config.yml", "config.yml");
-        provider.initialize(DemoConfiguration.class);
-        provider.initialize(ComplexConfiguration.class);
 
-        System.out.println("before: " + ComplexConfiguration.Sub.UUID_CONFIG_VALUE.get());
-        ComplexConfiguration.Sub.UUID_CONFIG_VALUE.set(UUID.randomUUID());
-        System.out.println("after: " + ComplexConfiguration.Sub.UUID_CONFIG_VALUE.get());
-
-
-        ComplexConfiguration.Sub.That.Operators.getNotNull().forEach(System.out::println);
-        List<UUID> operators = IntStream.range(0, 5).mapToObj(i -> UUID.randomUUID()).collect(Collectors.toList());
-        ComplexConfiguration.Sub.That.Operators.set(operators);
-
-        System.out.println(ComplexConfiguration.USER.get());
-        TestUser b = new TestUser(UUID.randomUUID().toString().substring(0, 3), UUID.randomUUID());
-        ComplexConfiguration.USER.set(b);
-
-        ComplexConfiguration.USERS.getNotNull().forEach((k, v) -> System.out.println(k + ": " + v));
-        LinkedHashMap<Integer, UUID> data = new LinkedHashMap<>();
-        for (int i = 0; i < 5; i++) {
-            data.put((int) (1000 * Math.random()), UUID.randomUUID());
-        }
-        ComplexConfiguration.USERS.set(data);
+        testDemo(provider);
+        testComplex(provider);
+        testSerialization(provider);
 
         try {
             provider.save();
@@ -50,5 +36,45 @@ public class ConfigTester {
 
     }
 
+    public static void testSerialization(YamlConfigProvider provider) {
+        System.out.println("----------------------------------------------------");
+        provider.initialize(ImplConfiguration.class);
+        System.out.println(ImplConfiguration.TEST.get());
+        ImplConfiguration.TEST.set(TestModel.random());
+        System.out.println("----------------------------------------------------");
+    }
+
+    public static void testDemo(YamlConfigProvider provider) {
+        provider.initialize(DemoConfiguration.class);
+    }
+
+    public static void testComplex(YamlConfigProvider provider) {
+        System.out.println("----------------------------------------------------");
+        provider.initialize(ComplexConfiguration.class);
+
+        System.out.println("> Test Value:");
+        System.out.println("before: " + ComplexConfiguration.Sub.UUID_CONFIG_VALUE.get());
+        ComplexConfiguration.Sub.UUID_CONFIG_VALUE.set(UUID.randomUUID());
+        System.out.println("after: " + ComplexConfiguration.Sub.UUID_CONFIG_VALUE.get());
+
+        System.out.println("> Test List:");
+        ComplexConfiguration.Sub.That.Operators.getNotNull().forEach(System.out::println);
+        List<UUID> operators = IntStream.range(0, 5).mapToObj(i -> UUID.randomUUID()).collect(Collectors.toList());
+        ComplexConfiguration.Sub.That.Operators.set(operators);
+
+        System.out.println("> Test Section:");
+        System.out.println(ComplexConfiguration.USER.get());
+        ComplexConfiguration.USER.set(TestModel.random());
+
+        System.out.println("> Test Maps:");
+        ComplexConfiguration.USERS.getNotNull().forEach((k, v) -> System.out.println(k + ": " + v));
+        LinkedHashMap<Integer, UUID> data = new LinkedHashMap<>();
+        for (int i = 0; i < 5; i++) {
+            data.put((int) (1000 * Math.random()), UUID.randomUUID());
+        }
+        ComplexConfiguration.USERS.set(data);
+        System.out.println("----------------------------------------------------");
+    }
+
 
 }

impl/yaml/src/test/java/config/model/TestModel.java

@@ -1,18 +1,22 @@
-package config.misc;
+package config.model;
 
 import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.bspfsystems.yamlconfiguration.serialization.SerializableAs;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.TestOnly;
 
 import java.util.HashMap;
 import java.util.Map;
 import java.util.UUID;
 
-public class TestUser {
+@SerializableAs("TestModel")
+public class TestModel implements ConfigurationSerializable {
 
     public String name;
     public UUID uuid;
 
-    public TestUser(String name, UUID uuid) {
+    public TestModel(String name, UUID uuid) {
         this.name = name;
         this.uuid = uuid;
     }
@@ -33,6 +37,7 @@ public class TestUser {
         return uuid;
     }
 
+    @Override
     public @NotNull Map<String, Object> serialize() {
         Map<String, Object> map = new HashMap<>();
         map.put("name", name);
@@ -42,14 +47,30 @@ public class TestUser {
         return map;
     }
 
-    public static TestUser deserialize(ConfigurationWrapper section) throws Exception {
+    public static TestModel deserialize(ConfigurationWrapper section) {
         String name = section.getString("name");
         if (name == null) throw new NullPointerException("name is null");
         String uuidString = section.getString("info.uuid");
         if (uuidString == null) throw new NullPointerException("uuid is null");
-        return new TestUser(name, UUID.fromString(uuidString));
+        return new TestModel(name, UUID.fromString(uuidString));
     }
 
+    @TestOnly
+    @SuppressWarnings("unchecked")
+    public static TestModel deserialize(Map<String, ?> args) {
+        String name = (String) args.get("name");
+        if (name == null) throw new NullPointerException("name is null");
+        Map<String, ?> map = (Map<String, ?>) args.get("info");
+        String uuidString = (String) map.get("uuid");
+        if (uuidString == null) throw new NullPointerException("uuid is null");
+        return new TestModel(name, UUID.fromString(uuidString));
+    }
+
+    public static TestModel random() {
+        return new TestModel(UUID.randomUUID().toString().substring(0, 5), UUID.randomUUID());
+    }
+
+
     @Override
     public String toString() {
         return "TestUser{" +

impl/yaml/src/test/java/config/source/ComplexConfiguration.java

@@ -8,7 +8,7 @@ import cc.carm.lib.configuration.core.value.type.ConfiguredList;
 import cc.carm.lib.configuration.core.value.type.ConfiguredMap;
 import cc.carm.lib.configuration.core.value.type.ConfiguredSection;
 import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
-import config.misc.TestUser;
+import config.model.TestModel;
 
 import java.util.List;
 import java.util.Map;
@@ -18,11 +18,11 @@ import java.util.UUID;
 public class ComplexConfiguration extends ConfigurationRoot {
 
     @ConfigComment({"User测试"})
-    public static final ConfigValue<TestUser> USER = ConfiguredSection
-            .builder(TestUser.class)
-            .defaults(new TestUser("Carm", UUID.randomUUID()))
-            .parseValue((section, defaultValue) -> TestUser.deserialize(section))
-            .serializeValue(TestUser::serialize).build();
+    public static final ConfigValue<TestModel> USER = ConfiguredSection
+            .builder(TestModel.class)
+            .defaults(new TestModel("Carm", UUID.randomUUID()))
+            .parseValue((section, defaultValue) -> TestModel.deserialize(section))
+            .serializeValue(TestModel::serialize).build();
 
     @ConfigComment({"[ID-UUID] 对照表", "", "用于测试Map类型的解析与序列化保存"})
     public static final ConfigValue<Map<Integer, UUID>> USERS = ConfiguredMap

impl/yaml/src/test/java/config/source/ImplConfiguration.java

@@ -0,0 +1,14 @@
+package config.source;
+
+import cc.carm.lib.configuration.core.ConfigurationRoot;
+import cc.carm.lib.configuration.core.annotation.ConfigPath;
+import cc.carm.lib.configuration.core.value.ConfigValue;
+import cc.carm.lib.configuration.yaml.value.ConfiguredSerializable;
+import config.model.TestModel;
+
+@ConfigPath("ImplConfiguration")
+public class ImplConfiguration extends ConfigurationRoot {
+
+    public static final ConfigValue<TestModel> TEST = ConfiguredSerializable.of(TestModel.class);
+
+}